astro-accelerator-utils 0.1.4 → 0.1.5

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/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,7 +1,11 @@
+/**
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ */
+
 export class Posts {
     /**
      * Constructor
-     * @param {() => MarkdownInstance[]} fetchAll 
+     * @param {() => MarkdownInstance[]} [fetchAll]
      */
     constructor(fetchAll) {
         /* istanbul ignore next */
@@ -9,6 +13,10 @@ export class Posts {
         this.allPosts = [];
     }
 
+    /**
+     * Gets all markdown posts in the site
+     * @returns {MarkdownInstance[]}
+     */
     all () {
         if (this.allPosts.length === 0) {
             const pageImportResult = this.fetchAll();
@@ -18,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.4",
+  "version": "0.1.5",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",