astro-accelerator-utils 0.0.44 → 0.1.0

package/README.md

@@ -1,2 +1,6 @@
-# astro-accelerator-utils
+# Astro Accelerator Utils
+
+[![Test](https://github.com/Steve-Fenton/astro-accelerator-utils/actions/workflows/build-astro.yml/badge.svg)](https://github.com/Steve-Fenton/astro-accelerator-utils/actions/workflows/build-astro.yml)
+
 Utility classes for Astro Accelerator
+

package/index.d.mts

@@ -1,13 +1,11 @@
+import { DateFormatter } from "./lib/v1/dates.mjs";
+import { UrlFormatter } from "./lib/v1/urls.mjs";
 import * as PostQueries from "./lib/postQueries.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 import * as PostOrdering from "./lib/postOrdering.mjs";
 import * as PostPaging from "./lib/postPaging.mjs";
-import * as Cache from "./lib/cache.mjs";
-import * as Config from "./lib/config.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, Config, Dates, FooterMenu, Markdown, Navigation, Taxonomy, Urls };
+export { DateFormatter, UrlFormatter, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Markdown, Navigation, Taxonomy };

package/index.mjs

@@ -1,27 +1,25 @@
+import { DateFormatter } from './lib/v1/dates.mjs';
+import { UrlFormatter } from './lib/v1/urls.mjs';
+import { Posts } from './lib/v1/posts.mjs';
+
 import * as PostQueries from './lib/postQueries.mjs';
 import * as PostFiltering from './lib/postFiltering.mjs';
 import * as PostOrdering from './lib/postOrdering.mjs';
 import * as PostPaging from './lib/postPaging.mjs';
-import * as Cache from './lib/cache.mjs';
-import * as Config from './lib/config.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 {
+    DateFormatter,
+    UrlFormatter,
     PostQueries,
     PostFiltering,
     PostOrdering,
     PostPaging,
-    Cache,
-    Config,
-    Dates,
     FooterMenu,
     Markdown,
     Navigation,
-    Taxonomy,
-    Urls
+    Taxonomy
 };

package/lib/footerMenu.d.mts

@@ -12,9 +12,9 @@
  * @param {any} translations
  * @param {Site} site
  * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu
- * @returns
+ * @returns {NavPage[]}
  */
-export function getMenu(currentUrl: URL, _: TranslationProvider, translations: any, site: any, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): Promise<import("../types/NavPage").NavPage[]>;
+export function getMenu(currentUrl: URL, _: TranslationProvider, translations: any, site: any, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): 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 
+ * @returns {NavPage[]}
  */
 export async function getMenu (currentUrl,  _, translations, site, menu) {
     const links = Taxonomy.taxonomyLinks(translations, _, site);

package/lib/postQueries.d.mts

@@ -1,11 +1,18 @@
 /**
- * Fetches pages
+ * Replaces the import.meta.glob function
+ * @param {() => MarkdownInstance[]} fetcher
+ */
+export function injectFetchAll(fetcher: () => MarkdownInstance[]): void;
+/**
+ * Replaced by Posts.all()
+ * 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
  * @param {Site} site
  * @param {PagePredicate} [filter]
  * @returns {Promise<MarkdownInstance[]>}
@@ -18,7 +25,7 @@ export function getTopLevelPages(site: Site, filter?: PagePredicate): Promise<Ma
  */
 export function getAuthors(frontmatter: Frontmatter): Promise<AuthorList>;
 /**
- *
+ * Get a single author by id/slug
  * @param {string} slug
  * @returns {Promise<AuthorInfo>}
  */

package/lib/postQueries.mjs

@@ -12,12 +12,23 @@ import * as Urls from './urls.mjs';
  * @typedef { import("../types/Site").Site } Site
  */
 
-function fetchAll () {
+/* istanbul ignore next */
+/** @type {() => MarkdownInstance[]} */
+let fetchAll = () => {
     return import.meta.glob("/src/pages/**/*.md", { eager: true });
 }
 
 /**
- * Fetches pages
+ * Replaces the import.meta.glob function
+ * @param {() => MarkdownInstance[]} fetcher 
+ */
+export function injectFetchAll (fetcher) {
+    fetchAll = fetcher;
+}
+
+/**
+ * Replaced by Posts.all()
+ * Use Posts.all().filter(...) to filter results
  * @param {PagePredicate} [filter]
  * @returns {Promise<MarkdownInstance[]>}
  */
@@ -39,7 +50,8 @@ export async function getPages (filter) {
 }
 
 /**
- * 
+ * Replaced by Posts.root()
+ * Use Posts.root().filter(...) to filter results
  * @param {Site} site
  * @param {PagePredicate} [filter] 
  * @returns {Promise<MarkdownInstance[]>}
@@ -113,7 +125,7 @@ export async function getAuthors (frontmatter) {
 }
 
 /**
- * 
+ * Get a single author by id/slug
  * @param {string} slug 
  * @returns {Promise<AuthorInfo>}
  */

package/lib/taxonomy.d.mts

@@ -1,4 +1,5 @@
 /**
+ * @typedef { import("../types/Site").Site } Site
  * @typedef { import("../types/Taxonomy").Taxonomy } Taxonomy
  * @typedef { import("../types/Taxonomy").TaxonomyEntry } TaxonomyEntry
  * @typedef { import("../types/Taxonomy").TaxonomyLinks } TaxonomyLinks
@@ -24,6 +25,7 @@ export function taxonomyLinks(translations: any, lang: (entry: any) => string, s
  * @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;

package/lib/taxonomy.mjs

@@ -4,6 +4,7 @@ import * as PostQueries from './postQueries.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

package/lib/v1/dates.d.mts

@@ -0,0 +1,20 @@
+/**
+ * @typedef { import("../types/Site") } Site
+ */
+export class DateFormatter {
+    /**
+     * Constructor
+     * @param {Intl.DateTimeFormatOptions} dateOptions
+     */
+    constructor(dateOptions: Intl.DateTimeFormatOptions);
+    dateOptions: Intl.DateTimeFormatOptions;
+    /**
+     * Returns the formatted pubDate
+     * @param {any} frontmatter
+     * @param {string} lang
+     * @param {Site} site
+     * @returns {string}
+     */
+    formatDate(date: any, lang: string): string;
+}
+export type Site = any;

package/lib/v1/dates.mjs

@@ -0,0 +1,28 @@
+/**
+ * @typedef { import("../types/Site") } Site
+ */
+
+export class DateFormatter {
+  /**
+   * Constructor
+   * @param {Intl.DateTimeFormatOptions} dateOptions 
+   */
+  constructor(dateOptions) {
+    this.dateOptions = dateOptions;
+  }
+
+  /**
+   * Returns the formatted pubDate
+   * @param {any} frontmatter 
+   * @param {string} lang 
+   * @param {Site} site 
+   * @returns {string}
+   */
+  formatDate(date, lang) {
+    if (date) {
+      return new Date(date).toLocaleDateString(lang, this.dateOptions);
+    }
+
+    return '';
+  }
+}

package/lib/v1/posts.d.mts

@@ -0,0 +1,11 @@
+export class Posts {
+    /**
+     * Constructor
+     * @param {() => MarkdownInstance[]} fetchAll
+     */
+    constructor(fetchAll: () => MarkdownInstance[]);
+    fetchAll: () => any;
+    allPosts: any[];
+    all(): any[];
+    root(subfolder: any): any[];
+}

package/lib/v1/posts.mjs

@@ -0,0 +1,30 @@
+export class Posts {
+    /**
+     * Constructor
+     * @param {() => MarkdownInstance[]} fetchAll 
+     */
+    constructor(fetchAll) {
+        this.fetchAll = fetchAll ?? function() { return import.meta.glob("/src/pages/**/*.md", { eager: true }); }
+        this.allPosts = [];
+    }
+
+    all () {
+        if (this.allPosts.length === 0) {
+            const pageImportResult = this.fetchAll();
+            this.allPosts = Object.values(pageImportResult);
+        }
+
+        return this.allPosts;
+    }
+
+    root (subfolder) {
+        const isRoot = subfolder.length == 0;
+        const expectedDepth = isRoot ? 1 : 2;
+
+        return this.all().filter(p => {
+            const depth = (p.url ?? '/').split('/').length - 1;
+            return depth == expectedDepth
+                || (depth == (expectedDepth - 1) && p.file.includes(subfolder.toLowerCase() + '.md'));
+        })
+    }
+}

package/lib/v1/urls.d.mts

@@ -0,0 +1,20 @@
+export class UrlFormatter {
+    /**
+     * Constructor
+     * @param {string} siteUrl
+     */
+    constructor(siteUrl: string);
+    siteUrl: string;
+    /**
+     * Ensures trailing slash is used
+     * @param {URL} url
+     * @returns {URL}
+     */
+    addSlashToUrl(url: URL): URL;
+    /**
+     * Ensures trailing slash is used
+     * @param {string | null} address
+     * @returns {string}
+     */
+    addSlashToAddress(address: string | null): string;
+}

package/lib/v1/urls.mjs

@@ -0,0 +1,39 @@
+export class UrlFormatter {
+    /**
+     * Constructor
+     * @param {string} siteUrl 
+     */
+    constructor(siteUrl) {
+        this.siteUrl = siteUrl;
+    }
+
+    /**
+     * Ensures trailing slash is used
+     * @param {URL} url 
+     * @returns {URL}
+     */
+    addSlashToUrl(url) {
+        url.pathname += url.pathname.endsWith('/') ? '' : '/';
+        return url;
+    }
+
+    /**
+     * Ensures trailing slash is used
+     * @param {string | null} address 
+     * @returns {string}
+     */
+    addSlashToAddress(address) {
+        if (!address) {
+            // Handle null or empty addresses
+            address = '/';
+        }
+
+        if (address.indexOf('//') > -1) {
+            // Don't mess with absolute addresses
+            return address;
+        }
+
+        const url = this.addSlashToUrl(new URL(address, this.siteUrl));
+        return url.pathname + url.search;
+    }
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.0.44",
+  "version": "0.1.00",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
+  "type": "module",
   "files": [
     "index.mjs",
     "index.d.mts",
@@ -11,7 +12,8 @@
   ],
   "types": "index.d.mts",
   "scripts": {
-    "types": "node ./clean.mjs && npx tsc index.mjs --allowJs --declaration --emitDeclarationOnly"
+    "types": "node ./clean.mjs && npx tsc index.mjs --allowJs --declaration --emitDeclarationOnly",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --collectCoverage  --runInBand"
   },
   "repository": {
     "type": "git",
@@ -30,10 +32,11 @@
   "homepage": "https://astro.stevefenton.co.uk/",
   "devDependencies": {
     "@types/node": "^18.11.9",
-    "typescript": "^4.9.3",
-    "unified": "^10.1.2",
+    "jest": "^29.3.1",
+    "rehype-stringify": "^9.0.3",
     "remark-parse": "^10.0.1",
     "remark-rehype": "^10.1.0",
-    "rehype-stringify": "^9.0.3"
+    "typescript": "^4.9.3",
+    "unified": "^10.1.2"
   }
 }

package/lib/cache.d.mts

@@ -1,25 +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
- * @returns {Promise<any>}
- */
-export function getItem(key: string): 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>;
-export const maxAge: 200;

package/lib/cache.mjs

@@ -1,60 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import process from 'process';
-
-export const maxAge = 200; //seconds
-
-/**
- * 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 
- * @returns {Promise<any>}
- */
-export async function getItem (key) {
-    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 < maxAge) {
-            console.log('Cache hit', key);
-            const content = fs.readFileSync(itemPath).toString();
-            return JSON.parse(content);
-        }
-    } catch{}
-
-    console.warn('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));
-}

package/lib/config.d.mts

@@ -1,9 +0,0 @@
-/**
- * @typedef { import("../types/Site").Site } Site
- */
-/**
- * Gets default configuration
- * @returns {Site}
- */
-export function getDefault(): Site;
-export type Site = import("../types/Site").Site;

package/lib/config.mjs

@@ -1,49 +0,0 @@
-/**
- * @typedef { import("../types/Site").Site } Site
- */
-
-/**
- * Gets default configuration
- * @returns {Site}
- */
-export function getDefault() {
-    return {
-        owner: '',
-        url: '',
-        feedUrl: '',
-        title: '',
-        description: '',
-        themeColor: '#222255',
-        subfolder: '',
-        defaultLanguage: 'en',
-        default: {
-            lang: 'en',
-            locale: 'en-US',
-            dir: 'ltr'
-        },
-        search: {
-            fallbackUrl: 'https://www.google.com/search',
-            fallbackSite: 'q',
-            fallbackQuery: 'q',
-        },
-        pageSize: 12,
-        pageLinks: 3,
-        rssLimit: 20,
-        dateOptions: {
-            weekday: 'long',
-            year: 'numeric',
-            month: 'long',
-            day: 'numeric',
-        },
-        featureFlags: {
-            codeBlocks: ['copy'],
-            figures: ['enlarge'],
-            youTubeLinks: ['embed'],
-        },
-        images: {
-            contentSize: '(max-width: 860px) 100vw, 620px',
-            listerSize: '(max-width: 860px) 90vw, 350px',
-            authorSize: '50px',
-        }
-    };
-}

package/lib/dates.d.mts

@@ -1,20 +0,0 @@
-/**
- * @typedef { import("../types/Site") } Site
- */
-/**
- * Returns the formatted pubDate
- * @param {any} frontmatter
- * @param {string} lang
- * @param {Site} site
- * @returns {string}
- */
-export function formatDate(frontmatter: any, lang: string, site: Site): string;
-/**
-* Returns the formatted modDate
-* @param {any} frontmatter
-* @param {string} lang
-* @param {Site} site
-* @returns {string}
-*/
-export function formatModifiedDate(frontmatter: any, lang: string, site: Site): string;
-export type Site = typeof import("../types/Site");

package/lib/dates.mjs

@@ -1,37 +0,0 @@
-/**
- * @typedef { import("../types/Site") } Site
- */
-
-/**
- * Returns the formatted pubDate
- * @param {any} frontmatter 
- * @param {string} lang 
- * @param {Site} site 
- * @returns {string}
- */
-export function formatDate (frontmatter, lang, site) {
-    const date = frontmatter.pubDate ?? '';
-  
-    if (date) {
-      return new Date(date).toLocaleDateString(lang, site.dateOptions);
-    }
-    
-    return '';
-  }
-  
- /**
- * Returns the formatted modDate
- * @param {any} frontmatter 
- * @param {string} lang 
- * @param {Site} site 
- * @returns {string}
- */
-  export function formatModifiedDate (frontmatter, lang, site) {
-    const date = frontmatter.modDate ?? '';
-  
-    if (date) {
-      return new Date(date).toLocaleDateString(lang, site.dateOptions);
-    }
-    
-    return '';
-  }