astro-accelerator-utils 0.0.19 → 0.0.21

package/index.d.mts

@@ -1,7 +1,7 @@
 import * as PostQueries from "./lib/postQueries.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 import * as PostOrdering from "./lib/postOrdering.mjs";
-import * as Cache from "./lib/Cache.mjs";
+import * as Cache from "./lib/cache.mjs";
 import * as Dates from "./lib/dates.mjs";
 import * as Urls from "./lib/urls.mjs";
 export { PostQueries, PostFiltering, PostOrdering, Cache, Dates, Urls };

package/index.mjs

@@ -1,7 +1,7 @@
 import * as PostQueries from "./lib/postQueries.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 import * as PostOrdering from "./lib/postOrdering.mjs";
-import * as Cache from "./lib/Cache.mjs";
+import * as Cache from "./lib/cache.mjs";
 import * as Dates from "./lib/dates.mjs";
 import * as Urls from "./lib/urls.mjs";
 

package/lib/Cache.d.mts

@@ -18,7 +18,7 @@ export function getItem(key: string): any;
 /**
  * Adds an item to the cache
  * @param {string} key
- * @param {object} value
+ * @param {any} value
  */
-export function setItem(key: string, value: object): Promise<void>;
+export function setItem(key: string, value: any): Promise<void>;
 export const maxAge: 200;

package/lib/{Cache.mjs → cache.mjs}

@@ -21,7 +21,7 @@ export async function getCachePath () {
  */
 export async function getItemPath (key) {
     const cachePath = await getCachePath();
-    return path.join(cachePath, key + '.cache');
+    return path.join(cachePath, key + '.json');
 }
 
 /**
@@ -51,7 +51,7 @@ export async function getItem (key) {
 /**
  * Adds an item to the cache
  * @param {string} key 
- * @param {object} value 
+ * @param {any} value 
  */
 export async function setItem (key, value) {
     const itemPath = await getItemPath(key);

package/lib/dates.d.mts

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

package/lib/dates.mjs

@@ -1,8 +1,12 @@
+/**
+ * @typedef { import("../types/Site") } Site
+ */
+
 /**
  * Returns the formatted pubDate
  * @param {any} frontmatter 
  * @param {string} lang 
- * @param {any} site 
+ * @param {Site} site 
  * @returns {string}
  */
 export function formatDate (frontmatter, lang, site) {
@@ -19,7 +23,7 @@ export function formatDate (frontmatter, lang, site) {
  * Returns the formatted modDate
  * @param {any} frontmatter 
  * @param {string} lang 
- * @param {any} site 
+ * @param {Site} site 
  * @returns {string}
  */
   export function formatModifiedDate (frontmatter, lang, site) {

package/lib/postFiltering.d.mts

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

package/lib/postFiltering.mjs

@@ -1,6 +1,12 @@
+/**
+ * @typedef { import("../types/PageFunction") } PageFunction
+ * @typedef { import("../types/PagePredicate") } PagePredicate
+ * @typedef { import("../types/Markdown") } Markdown
+ */
+
 /**
  * Predicate for whether a page should appear in the sitemap
- * @param {import("../types/Markdown").Markdown<Record<string, any>} p 
+ * @param {Markdown} p 
  * @returns {boolean}
  */
 export function showInSitemap (p) {
@@ -15,7 +21,7 @@ export function showInSitemap (p) {
 
 /**
  * Predicate for whether a page should appear in the site search
- * @param {import("../types/Markdown").Markdown<Record<string, any>} p 
+ * @param {Markdown} p 
  * @returns {boolean}
  */
 export function showInSearch (p) {
@@ -30,7 +36,7 @@ export function showInSearch (p) {
 
 /**
  * Predicate for whether a page should appear in the navigation menu
- * @param {import("../types/Markdown").Markdown<Record<string, any>} p 
+ * @param {Markdown} p 
  * @returns {boolean}
  */
 export function showInMenu (p) {
@@ -44,7 +50,7 @@ export function showInMenu (p) {
 
 /**
  * Predicate for whether a page is an author page
- * @param {import("../types/Markdown").Markdown<Record<string, any>} p 
+ * @param {Markdown} p 
  * @returns {boolean}
  */
 export function isAuthor (p) {
@@ -57,7 +63,7 @@ export function isAuthor (p) {
 
 /**
  * Predicate for whether a page is a search page
- * @param {import("../types/Markdown").Markdown<Record<string, any>} p 
+ * @param {Markdown} p 
  * @returns {boolean}
  */
 export function isSearch (p) {
@@ -70,7 +76,7 @@ export function isSearch (p) {
 
 /**
  * Predicate for whether a page should be listed
- * @param {import("../types/Markdown").Markdown<Record<string, any>} p 
+ * @param {Markdown} p 
  * @returns {boolean}
  */
 export function isListable (p) {

package/lib/postOrdering.d.mts

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

package/lib/postOrdering.mjs

@@ -1,7 +1,11 @@
+/**
+ * @typedef { import("../types/Markdown") } Markdown
+ */
+
 /**
  * Sorts by the pubDate field
- * @param {import("../types/Markdown").Markdown<Record<string, any>} a 
- * @param {import("../types/Markdown").Markdown<Record<string, any>} b 
+ * @param {Markdown} a 
+ * @param {Markdown} b 
  * @returns {any}
  */
 export function sortByPubDate (a, b) {
@@ -10,8 +14,8 @@ export function sortByPubDate (a, b) {
 
 /**
  * Sorts by the pubDate field in descending order
- * @param {import("../types/Markdown").Markdown<Record<string, any>} a 
- * @param {import("../types/Markdown").Markdown<Record<string, any>} b 
+ * @param {Markdown} a 
+ * @param {Markdown} b 
  * @returns {any}
  */
 export function sortByPubDateDesc (a, b) {
@@ -20,8 +24,8 @@ export function sortByPubDateDesc (a, b) {
 
 /**
  * Sorts by the modDate field
- * @param {import("../types/Markdown").Markdown<Record<string, any>} a 
- * @param {import("../types/Markdown").Markdown<Record<string, any>} b 
+ * @param {Markdown} a 
+ * @param {Markdown} b 
  * @returns {any}
  */
 export function sortByModDate (a, b) {

package/lib/postQueries.d.mts

@@ -1,7 +1,15 @@
+/**
+ * @typedef { import("../types/PageFunction") } PageFunction
+ * @typedef { import("../types/PagePredicate") } PagePredicate
+ * @typedef { import("../types/Markdown") } Markdown
+ */
 /**
  * Fetches pages
- * @param {import("../types/PageFunction.js").PageFunction} fetchPages
- * @param {import("../types/PagePredicate.js").PagePredicate} filter
- * @returns {import("../types/Markdown").Markdown<Record<string, any>[]}
+ * @param {PageFunction} fetchPages
+ * @param {PagePredicate} [filter]
+ * @returns {Markdown[]}
  */
-export function getPages(fetchPages: import("../types/PageFunction.js").PageFunction, filter: import("../types/PagePredicate.js").PagePredicate): import("../types/Markdown").Markdown<Record<string, any>[]>;
+export function getPages(fetchPages: PageFunction, filter?: PagePredicate): Markdown[];
+export type PageFunction = typeof import("../types/PageFunction");
+export type PagePredicate = typeof import("../types/PagePredicate");
+export type Markdown = typeof import("../types/Markdown");

package/lib/postQueries.mjs

@@ -1,10 +1,16 @@
 import { getItem, setItem } from "./Cache.mjs";
 
+/**
+ * @typedef { import("../types/PageFunction") } PageFunction
+ * @typedef { import("../types/PagePredicate") } PagePredicate
+ * @typedef { import("../types/Markdown") } Markdown
+ */
+
 /**
  * Fetches pages
- * @param {import("../types/PageFunction").PageFunction} fetchPages 
- * @param {import("../types/PagePredicate").PagePredicate} filter 
- * @returns {import("../types/Markdown").Markdown<Record<string, any>[]}
+ * @param {PageFunction} fetchPages 
+ * @param {PagePredicate} [filter]
+ * @returns {Markdown[]}
  */
 export async function getPages (fetchPages, filter) {
     const key = 'PageQueries__getPages';

package/lib/urls.d.mts

@@ -1,3 +1,6 @@
+/**
+ * @typedef { import("../types/Site") } Site
+ */
 /**
  * Ensures trailing slash is used
  * @param {URL} url
@@ -7,7 +10,8 @@ export function addSlashToUrl(url: URL): URL;
 /**
  * Ensures trailing slash is used
  * @param {string} address
- * @param {import("../types/Site").Site} site
+ * @param {Site} site
  * @returns {string}
  */
-export function addSlashToAddress(address: string, site: import("../types/Site").Site): string;
+export function addSlashToAddress(address: string, site: Site): string;
+export type Site = typeof import("../types/Site");

package/lib/urls.mjs

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types/Site") } Site
+ */
+
 /**
  * Ensures trailing slash is used
  * @param {URL} url 
@@ -11,7 +15,7 @@ export function addSlashToUrl(url) {
 /**
  * Ensures trailing slash is used
  * @param {string} address 
- * @param {import("../types/Site").Site} site 
+ * @param {Site} site 
  * @returns {string}
  */
 export function addSlashToAddress(address, site) {

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "files": [
     "index.mjs",
     "index.d.mts",
-    "lib/*"
+    "lib/*",
+    "types/*.d.ts"
   ],
   "types": "index.d.mts",
   "scripts": {

package/types/Markdown.d.ts

@@ -0,0 +1,4 @@
+export interface Markdown {
+    url: string;
+    frontmatter: Record<string, any>;
+}

package/types/PageFunction.d.ts

@@ -0,0 +1,2 @@
+import { Markdown } from "./Markdown";
+export type PageFunction = () => Markdown[];

package/types/PagePredicate.d.ts

@@ -0,0 +1,2 @@
+import { Markdown } from "./Markdown";
+export type PagePredicate = (value: Markdown, index: number, array: Markdown[]) => boolean;

package/types/Site.d.ts

@@ -0,0 +1,34 @@
+export type Site = {
+    url: string;
+    dateOptions: Intl.DateTimeFormatOptions;
+    subfolder: string;
+    feedUrl: string;
+    title: string;
+    description: string;
+    defaultLanguage: string;
+    themeColor: string;
+    owner: string;
+    default: {
+        lang: string;
+        locale: string;
+        dir: string;
+    };
+    search: {
+        fallbackUrl: 'https://www.google.com/search' | string;
+        fallbackSite: 'q' | string;
+        fallbackQuery: 'q' | string;
+    };
+    pageSize: number;
+    pageLinks: number;
+    rssLimit: number;
+    featureFlags: {
+        codeBlocks: 'copy'[];
+        figures: 'enlarge'[];
+        youTubeLinks: 'embed'[];
+    };
+    images: {
+        contentSize: string;
+        listerSize: string;
+        authorSize: string;
+    };
+};