astro-accelerator-utils 0.1.3 → 0.1.5

package/index.d.mts

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

package/index.mjs

@@ -1,6 +1,7 @@
 import { DateFormatter } from './lib/v1/dates.mjs';
-import { UrlFormatter } from './lib/v1/urls.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';
@@ -8,21 +9,20 @@ 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 Markdown from './lib/markdown.mjs';
 import * as Navigation from './lib/navigation.mjs';
 import * as Taxonomy from './lib/taxonomy.mjs';
 
 export {
     DateFormatter,
-    UrlFormatter,
+    Markdown,
     Posts,
+    UrlFormatter,
     Cache,
     PostQueries,
     PostFiltering,
     PostOrdering,
     PostPaging,
     FooterMenu,
-    Markdown,
     Navigation,
     Taxonomy
 };

package/lib/navigation.mjs

@@ -1,3 +1,4 @@
+import { Posts } from './v1/posts.mjs';
 import * as PostQueries from './postQueries.mjs';
 import * as PostFiltering from './postFiltering.mjs';
 import * as Cache from './cache.mjs';
@@ -66,13 +67,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);
 
     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))

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/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/markdown.d.mts

@@ -0,0 +1,20 @@
+export class Markdown {
+    /**
+     * Converts markdown to HTML without wrapping in a <p>
+     * @param {string} markdown
+     * @returns {Promise<string>}
+     */
+    getInlineHtmlFrom(markdown: string): Promise<string>;
+    /**
+     * Converts markdown to HTML
+     * @param {string} markdown
+     * @returns {Promise<string>}
+     */
+    getHtmlFrom(markdown: string): Promise<string>;
+    /**
+     * Converts markdown to plain text
+     * @param {string} markdown
+     * @returns {Promise<string>}
+     */
+    getTextFrom(markdown: string): Promise<string>;
+}

package/lib/v1/markdown.mjs

@@ -0,0 +1,47 @@
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkRehype from 'remark-rehype'
+import rehypeStringify from 'rehype-stringify';
+
+export class Markdown {
+    /**
+     * Converts markdown to HTML without wrapping in a <p>
+     * @param {string} markdown 
+     * @returns {Promise<string>}
+     */
+    async getInlineHtmlFrom(markdown) {
+        let html = await this.getHtmlFrom(markdown);
+
+        // There may be a better way to unwrap this... maybe a visitor
+        if (html.substring(0, 3) == '<p>' && html.substring(html.length - 4) == '</p>') {
+            html = html.substring(3, html.length - 4);
+        }
+
+        return html;
+    }
+
+    /**
+     * Converts markdown to HTML
+     * @param {string} markdown 
+     * @returns {Promise<string>}
+     */
+    async getHtmlFrom(markdown) {
+        const vfile = await unified()
+        .use(remarkParse)
+        .use(remarkRehype)
+        .use(rehypeStringify)
+        .process(markdown)
+
+        return String(vfile);
+    }
+
+    /**
+     * Converts markdown to plain text
+     * @param {string} markdown 
+     * @returns {Promise<string>}
+     */
+    async getTextFrom(markdown) {
+        const html = await this.getInlineHtmlFrom(markdown);
+        return html.replace(/<.*?>/g, '');
+    }
+}

package/lib/v1/posts.d.mts

@@ -1,11 +1,23 @@
+/**
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ */
 export class Posts {
     /**
      * Constructor
-     * @param {() => MarkdownInstance[]} fetchAll
+     * @param {() => MarkdownInstance[]} [fetchAll]
      */
-    constructor(fetchAll: () => MarkdownInstance[]);
+    constructor(fetchAll?: () => MarkdownInstance[]);
     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;

package/lib/v1/posts.mjs

@@ -1,13 +1,22 @@
+/**
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ */
+
 export class Posts {
     /**
      * Constructor
-     * @param {() => MarkdownInstance[]} fetchAll 
+     * @param {() => MarkdownInstance[]} [fetchAll]
      */
     constructor(fetchAll) {
+        /* istanbul ignore next */
         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();
@@ -17,6 +26,10 @@ export class Posts {
         return this.allPosts;
     }
 
+    /**
+     * 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.3",
+  "version": "0.1.5",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",

package/lib/markdown.d.mts

@@ -1,18 +0,0 @@
-/**
- * Converts markdown to HTML without wrapping in a <p>
- * @param {string} markdown
- * @returns {Promise<string>}
- */
-export function getInlineHtmlFrom(markdown: string): Promise<string>;
-/**
- * Converts markdown to HTML
- * @param {string} markdown
- * @returns {Promise<string>}
- */
-export function getHtmlFrom(markdown: string): Promise<string>;
-/**
- * Converts markdown to plain text
- * @param {string} markdown
- * @returns {Promise<string>}
- */
-export function getTextFrom(markdown: string): Promise<string>;

package/lib/markdown.mjs

@@ -1,45 +0,0 @@
-import { unified } from 'unified';
-import remarkParse from 'remark-parse';
-import remarkRehype from 'remark-rehype'
-import rehypeStringify from 'rehype-stringify';
-
-/**
- * Converts markdown to HTML without wrapping in a <p>
- * @param {string} markdown 
- * @returns {Promise<string>}
- */
-export async function getInlineHtmlFrom(markdown) {
-    let html = await getHtmlFrom(markdown);
-
-    // There may be a better way to unwrap this... maybe a visitor
-    if (html.substring(0, 3) == '<p>' && html.substring(html.length - 4) == '</p>') {
-        html = html.substring(3, html.length - 4);
-    }
-
-    return html;
-}
-
-/**
- * Converts markdown to HTML
- * @param {string} markdown 
- * @returns {Promise<string>}
- */
-export async function getHtmlFrom(markdown) {
-    const vfile = await unified()
-    .use(remarkParse)
-    .use(remarkRehype)
-    .use(rehypeStringify)
-    .process(markdown)
-
-    return String(vfile);
-}
-
-/**
- * Converts markdown to plain text
- * @param {string} markdown 
- * @returns {Promise<string>}
- */
-export async function getTextFrom(markdown) {
-    const html = await getInlineHtmlFrom(markdown);
-    return html.replace(/<.*?>/g, '');
-}