astro-accelerator-utils 0.0.30 → 0.0.31

package/lib/postFiltering.d.mts

@@ -4,34 +4,34 @@
  */
 /**
  * Predicate for whether a page should appear in the sitemap
- * @param {MarkdownInstance<Record<string, any>>} p
+ * @param {MarkdownInstance} p
  * @returns {boolean}
  */
-export function showInSitemap(p: any): boolean;
+export function showInSitemap(p: MarkdownInstance): boolean;
 /**
  * Predicate for whether a page should appear in the site search
- * @param {MarkdownInstance<Record<string, any>>} p
+ * @param {MarkdownInstance} p
  * @returns {boolean}
  */
-export function showInSearch(p: any): boolean;
+export function showInSearch(p: MarkdownInstance): boolean;
 /**
  * Predicate for whether a page should appear in the navigation menu
- * @param {MarkdownInstance<Record<string, any>>} p
+ * @param {MarkdownInstance} p
  * @returns {boolean}
  */
-export function showInMenu(p: any): boolean;
+export function showInMenu(p: MarkdownInstance): boolean;
 /**
  * Predicate for whether a page is an author page
- * @param {MarkdownInstance<Record<string, any>>} p
+ * @param {MarkdownInstance} p
  * @returns {boolean}
  */
-export function isAuthor(p: any): boolean;
+export function isAuthor(p: MarkdownInstance): boolean;
 /**
  * Predicate for whether a page is a search page
- * @param {MarkdownInstance<Record<string, any>>} p
+ * @param {MarkdownInstance} p
  * @returns {boolean}
  */
-export function isSearch(p: any): boolean;
+export function isSearch(p: MarkdownInstance): boolean;
 /**
  * Predicate for whether a page should be listed
  * @param {MarkdownInstance<Record<string, any>>} p
@@ -39,4 +39,4 @@ export function isSearch(p: any): boolean;
  */
 export function isListable(p: any): boolean;
 export type PagePredicate = import("../types/PagePredicate").PagePredicate;
-export type MarkdownInstance = any;
+export type MarkdownInstance = import("../types/Astro").MarkdownInstance;

package/lib/postFiltering.mjs

@@ -5,7 +5,7 @@
 
 /**
  * Predicate for whether a page should appear in the sitemap
- * @param {MarkdownInstance<Record<string, any>>} p 
+ * @param {MarkdownInstance} p 
  * @returns {boolean}
  */
 export function showInSitemap (p) {
@@ -20,7 +20,7 @@ export function showInSitemap (p) {
 
 /**
  * Predicate for whether a page should appear in the site search
- * @param {MarkdownInstance<Record<string, any>>} p 
+ * @param {MarkdownInstance} p 
  * @returns {boolean}
  */
 export function showInSearch (p) {
@@ -35,7 +35,7 @@ export function showInSearch (p) {
 
 /**
  * Predicate for whether a page should appear in the navigation menu
- * @param {MarkdownInstance<Record<string, any>>} p 
+ * @param {MarkdownInstance} p 
  * @returns {boolean}
  */
 export function showInMenu (p) {
@@ -49,7 +49,7 @@ export function showInMenu (p) {
 
 /**
  * Predicate for whether a page is an author page
- * @param {MarkdownInstance<Record<string, any>>} p 
+ * @param {MarkdownInstance} p 
  * @returns {boolean}
  */
 export function isAuthor (p) {
@@ -62,7 +62,7 @@ export function isAuthor (p) {
 
 /**
  * Predicate for whether a page is a search page
- * @param {MarkdownInstance<Record<string, any>>} p 
+ * @param {MarkdownInstance} p 
  * @returns {boolean}
  */
 export function isSearch (p) {

package/lib/postOrdering.d.mts

@@ -3,23 +3,23 @@
  */
 /**
  * Sorts by the pubDate field
- * @param {MarkdownInstance<Record<string, any>>} a
- * @param {MarkdownInstance<Record<string, any>>} b
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
  * @returns {any}
  */
-export function sortByPubDate(a: any, b: any): any;
+export function sortByPubDate(a: MarkdownInstance, b: MarkdownInstance): any;
 /**
  * Sorts by the pubDate field in descending order
- * @param {MarkdownInstance<Record<string, any>>} a
- * @param {MarkdownInstance<Record<string, any>>} b
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
  * @returns {any}
  */
-export function sortByPubDateDesc(a: any, b: any): any;
+export function sortByPubDateDesc(a: MarkdownInstance, b: MarkdownInstance): any;
 /**
  * Sorts by the modDate field
- * @param {MarkdownInstance<Record<string, any>>} a
- * @param {MarkdownInstance<Record<string, any>>} b
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
  * @returns {any}
  */
-export function sortByModDate(a: any, b: any): any;
-export type MarkdownInstance = any;
+export function sortByModDate(a: MarkdownInstance, b: MarkdownInstance): any;
+export type MarkdownInstance = import("../types/Astro").MarkdownInstance;

package/lib/postOrdering.mjs

@@ -4,8 +4,8 @@
 
 /**
  * Sorts by the pubDate field
- * @param {MarkdownInstance<Record<string, any>>} a 
- * @param {MarkdownInstance<Record<string, any>>} b 
+ * @param {MarkdownInstance} a 
+ * @param {MarkdownInstance} b 
  * @returns {any}
  */
 export function sortByPubDate (a, b) {
@@ -14,8 +14,8 @@ export function sortByPubDate (a, b) {
 
 /**
  * Sorts by the pubDate field in descending order
- * @param {MarkdownInstance<Record<string, any>>} a 
- * @param {MarkdownInstance<Record<string, any>>} b 
+ * @param {MarkdownInstance} a 
+ * @param {MarkdownInstance} b 
  * @returns {any}
  */
 export function sortByPubDateDesc (a, b) {
@@ -24,8 +24,8 @@ export function sortByPubDateDesc (a, b) {
 
 /**
  * Sorts by the modDate field
- * @param {MarkdownInstance<Record<string, any>>} a 
- * @param {MarkdownInstance<Record<string, any>>} b 
+ * @param {MarkdownInstance} a 
+ * @param {MarkdownInstance} b 
  * @returns {any}
  */
 export function sortByModDate (a, b) {

package/lib/postQueries.d.mts

@@ -1,22 +1,28 @@
 /**
  * Fetches pages
  * @param {PagePredicate} [filter]
- * @returns {Promise<MarkdownInstance<Record<string, any>>[]>}
+ * @returns {Promise<MarkdownInstance}
  */
-export function getPages(filter?: PagePredicate): Promise<MarkdownInstance<Record<string, any>>[]>;
+export function getPages(filter?: PagePredicate): Promise<MarkdownInstance>;
 /**
  *
  * @param {Site} site
  * @param {PagePredicate} [filter]
- * @returns {Promise<MarkdownInstance<Record<string,any>>[]>}
+ * @returns {Promise<MarkdownInstance[]>}
  */
-export function getTopLevelPages(site: Site, filter?: PagePredicate): Promise<MarkdownInstance<Record<string, any>>[]>;
+export function getTopLevelPages(site: Site, filter?: PagePredicate): Promise<MarkdownInstance[]>;
 /**
  * Gets a list of authors, and exposes main author and contributors
  * @param {Frontmatter} frontmatter
  * @returns {Promise<AuthorList>}
  */
 export function getAuthors(frontmatter: Frontmatter): Promise<AuthorList>;
+/**
+ *
+ * @param {string} slug
+ * @returns {Promise<AuthorInfo>}
+ */
+export function getAuthorInfo(slug: string): Promise<AuthorInfo>;
 /**
  * Returns a list of breadcrumbs
  * @param {URL} currentUrl
@@ -26,11 +32,11 @@ export function getAuthors(frontmatter: Frontmatter): Promise<AuthorList>;
 export function getBreadcrumbs(currentUrl: URL, site: Site): NavPage[];
 /**
  * Converts a MarkdownInstance into a NavPage
- * @param {MarkdownInstance<Record<string, any>>} page
+ * @param {MarkdownInstance} page
  * @param {Site}
  * @returns {NavPage}
  */
-export function mapNavPage(page: any, site: any): NavPage;
+export function mapNavPage(page: MarkdownInstance, site: any): NavPage;
 /**
  * Walks the tree to set current page
  * @param {NavPage[]} pages
@@ -39,14 +45,15 @@ export function mapNavPage(page: any, site: any): NavPage;
 export function setCurrentPage(pages: NavPage[], currentUrl: URL): void;
 /**
  * Pops matching page from array
- * @param {MarkdownInstance<Record<string, any>>[]} allPages
+ * @param {MarkdownInstance[]} allPages
  * @param {string} search
  * @returns
  */
-export function popMatchingPage(allPages: MarkdownInstance<Record<string, any>>[], search: string): any;
+export function popMatchingPage(allPages: MarkdownInstance[], search: string): import("../types/Astro").MarkdownInstance;
 export type PagePredicate = import("../types/PagePredicate").PagePredicate;
 export type Frontmatter = import("../types/Frontmatter").Frontmatter;
-export type MarkdownInstance = any;
+export type MarkdownInstance = import("../types/Astro").MarkdownInstance;
 export type AuthorList = import("../types/AuthorList").AuthorList;
+export type AuthorInfo = import("../types/AuthorInfo").AuthorInfo;
 export type NavPage = import("../types/NavPage").NavPage;
 export type Site = import("../types/Site").Site;

package/lib/postQueries.mjs

@@ -7,6 +7,7 @@ import * as Urls from './urls.mjs';
  * @typedef { import("../types/Frontmatter").Frontmatter } Frontmatter
  * @typedef { import("../types/Astro").MarkdownInstance } MarkdownInstance
  * @typedef { import("../types/AuthorList").AuthorList } AuthorList
+ * @typedef { import("../types/AuthorInfo").AuthorInfo } AuthorInfo
  * @typedef { import("../types/NavPage").NavPage } NavPage
  * @typedef { import("../types/Site").Site } Site
  */
@@ -18,7 +19,7 @@ function fetchAll () {
 /**
  * Fetches pages
  * @param {PagePredicate} [filter]
- * @returns {Promise<MarkdownInstance<Record<string, any>>[]>}
+ * @returns {Promise<MarkdownInstance}
  */
 export async function getPages (filter) {
     const key = 'PageQueries__getPages';
@@ -41,12 +42,12 @@ export async function getPages (filter) {
  * 
  * @param {Site} site
  * @param {PagePredicate} [filter] 
- * @returns {Promise<MarkdownInstance<Record<string,any>>[]>}
+ * @returns {Promise<MarkdownInstance[]>}
  */
 export async function getTopLevelPages (site, filter) {
     const key = 'PageQueries__getTopLevelPages';
     
-    /** @type {MarkdownInstance<Record<string, any>>[]} */
+    /** @type {MarkdownInstance[]} */
     let allPages = await getItem(key);
 
     if (allPages == null) {
@@ -111,6 +112,34 @@ export async function getAuthors (frontmatter) {
     return result;
 }
 
+/**
+ * 
+ * @param {string} slug 
+ * @returns {Promise<AuthorInfo>}
+ */
+export async function getAuthorInfo (slug) {
+    const cacheKey = 'Global__author_info';
+    
+    /** @type {AuthorInfo} */
+    let authorInfo = await getItem(cacheKey);
+
+    if (authorInfo == null) {
+        const allPages = await getPages();
+
+        const author = allPages
+            .filter(PostFiltering.isAuthor)
+            .filter(x => x.url?.split('/')[2] == slug)[0];
+
+        authorInfo = {
+            frontmatter: author.frontmatter
+        };
+  
+      await setItem(cacheKey, authorInfo);
+    }
+
+    return authorInfo;
+}
+
 /**
  * Returns a list of breadcrumbs
  * @param {URL} currentUrl 
@@ -142,7 +171,7 @@ export async function getBreadcrumbs (currentUrl, site) {
 
 /**
  * Converts a MarkdownInstance into a NavPage
- * @param {MarkdownInstance<Record<string, any>>} page 
+ * @param {MarkdownInstance} page 
  * @param {Site}
  * @returns {NavPage}
  */
@@ -194,7 +223,7 @@ export function setCurrentPage (pages, currentUrl) {
 
 /**
  * Pops matching page from array
- * @param {MarkdownInstance<Record<string, any>>[]} allPages 
+ * @param {MarkdownInstance[]} allPages 
  * @param {string} search 
  * @returns 
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.0.30",
+  "version": "0.0.31",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "files": [

package/types/Astro.d.ts

@@ -1,5 +1,6 @@
-export type MarkdownInstance<T extends Record<string, any>> = {
-    frontmatter: T;
+import { Frontmatter } from "./Frontmatter";
+export type MarkdownInstance = {
+    frontmatter: Frontmatter;
     /** Absolute file path (e.g. `/home/user/projects/.../file.md`) */
     file: string;
     /** Browser URL for files under `/src/pages` (e.g. `/en/guides/markdown-content`) */

package/types/AuthorInfo.d.ts

@@ -0,0 +1,4 @@
+import { Frontmatter } from "./Frontmatter";
+export interface AuthorInfo {
+    frontmatter: Frontmatter;
+}

package/types/AuthorList.d.ts

@@ -2,7 +2,7 @@ import type { MarkdownInstance } from "./Astro";
 import type { BannerImage } from "./BannerImage";
 export interface AuthorList {
     image: BannerImage | null;
-    writers: MarkdownInstance<Record<string, any>>[];
-    mainAuthor: MarkdownInstance<Record<string, any>> | null;
-    contributors: MarkdownInstance<Record<string, any>>[];
+    writers: MarkdownInstance[];
+    mainAuthor: MarkdownInstance | null;
+    contributors: MarkdownInstance[];
 }

package/types/PagePredicate.d.ts

@@ -1,2 +1,2 @@
 import { MarkdownInstance } from "./Astro";
-export type PagePredicate = (value: MarkdownInstance<Record<string, any>>, index: number, array: MarkdownInstance<Record<string, any>>[]) => boolean;
+export type PagePredicate = (value: MarkdownInstance, index: number, array: MarkdownInstance[]) => boolean;