astro-accelerator-utils 0.3.90 → 0.3.92

package/index.d.mts

@@ -1,4 +1,122 @@
+/**
+ * @typedef { import("./types/PagePredicate").PagePredicate } PagePredicate
+ * @typedef { import("./types/Astro").MarkdownInstance} MarkdownInstance
+ */
+/**
+ * Predicate for whether a page should appear in the sitemap
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function showInSitemap(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page should appear in the site search
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function showInSearch(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page should appear in the navigation menu
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function showInMenu(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page is an author page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function isAuthor(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page is an author page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function notAuthor(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page is a search page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function isSearch(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page is an search page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function notSearch(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page has a modified date
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function hasDate(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page has a modified date
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function hasModDate(p: MarkdownInstance): boolean;
+/**
+ * Predicate for whether a page should be listed
+ * @param {MarkdownInstance<Record<string, any>>} p
+ * @returns {boolean}
+ */
+export function isListable(p: MarkdownInstance<Record<string, any>>): boolean;
+/**
+ * Predicate for whether a page should be used to create tag and category lists.
+ * Specifically, this allows future-dated posts to cause taxonomy pages to be created,
+ * @param {MarkdownInstance<Record<string, any>>} p
+ * @returns {boolean}
+ */
+export function forTaxonomy(p: MarkdownInstance<Record<string, any>>): boolean;
+/**
+ * Sorts by the pubDate field
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByPubDate(a: MarkdownInstance, b: MarkdownInstance): any;
+/**
+ * Sorts by the pubDate field in descending order
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByPubDateDesc(a: MarkdownInstance, b: MarkdownInstance): any;
+/**
+ * Sorts by the modDate field
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByModDate(a: MarkdownInstance, b: MarkdownInstance): any;
+/**
+ * Sorts by the modDate field
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByModDateDesc(a: MarkdownInstance, b: MarkdownInstance): any;
+export namespace PostFiltering {
+    export { showInSitemap };
+    export { showInSearch };
+    export { showInMenu };
+    export { isAuthor };
+    export { notAuthor };
+    export { isSearch };
+    export { notSearch };
+    export { hasDate };
+    export { hasModDate };
+    export { isListable };
+    export { forTaxonomy };
+}
+export namespace PostOrdering {
+    export { sortByPubDate };
+    export { sortByPubDateDesc };
+    export { sortByModDate };
+    export { sortByModDateDesc };
+}
+export { Accelerator };
+export type PagePredicate = import("./types/PagePredicate").PagePredicate;
+export type MarkdownInstance = import("./types/Astro").MarkdownInstance;
 import { Accelerator } from './lib/v1/accelerator.mjs';
-import * as PostFiltering from './lib/postFiltering.mjs';
-import * as PostOrdering from './lib/postOrdering.mjs';
-export { Accelerator, PostFiltering, PostOrdering };

package/index.mjs

@@ -1,9 +1,252 @@
 import { Accelerator } from './lib/v1/accelerator.mjs';
-import * as PostFiltering from './lib/postFiltering.mjs';
-import * as PostOrdering from './lib/postOrdering.mjs';
-
-export {
-    Accelerator,
-    PostFiltering,
-    PostOrdering
-};
+
+/**
+ * @typedef { import("./types/PagePredicate").PagePredicate } PagePredicate
+ * @typedef { import("./types/Astro").MarkdownInstance} MarkdownInstance
+ */
+
+/**
+ * Predicate for whether a page should appear in the sitemap
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function showInSitemap (p) {
+  if (typeof p.frontmatter.navSitemap !== 'undefined'
+    && p.frontmatter.navSitemap == false) {
+    return false;
+  }
+
+  return isListable(p);
+}
+
+/**
+ * Predicate for whether a page should appear in the site search
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function showInSearch (p) {
+  if (typeof p.frontmatter.navSearch !== 'undefined'
+    && p.frontmatter.navSearch == false) {
+    return false;
+  }
+
+  return isListable(p);
+}
+
+/**
+ * Predicate for whether a page should appear in the navigation menu
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function showInMenu (p) {
+  if (typeof p.frontmatter.navMenu !== 'undefined'
+    && p.frontmatter.navMenu == false) {
+    return false;
+  }
+
+  return true;
+}
+
+/**
+ * Predicate for whether a page is an author page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function isAuthor (p) {
+  if (p?.frontmatter?.layout?.indexOf('/Author.astro') > -1) {
+    return true;
+  }
+
+  return false;
+}
+
+/**
+ * Predicate for whether a page is an author page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function notAuthor (p) {
+  return !isAuthor(p);
+}
+
+/**
+ * Predicate for whether a page is a search page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function isSearch (p) {
+  if (p?.frontmatter?.layout?.indexOf('/Search.astro') > -1) {
+    return true;
+  }
+
+  return false;
+}
+
+/**
+ * Predicate for whether a page is an search page
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function notSearch (p) {
+  return !isSearch(p);
+}
+
+/**
+ * Predicate for whether a page has a modified date
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function hasDate (p) {
+  if (p?.frontmatter?.modDate != null || p?.frontmatter?.pubDate != null) {
+    return true;
+  }
+
+  return false;
+}
+
+/**
+ * Predicate for whether a page has a modified date
+ * @param {MarkdownInstance} p
+ * @returns {boolean}
+ */
+export function hasModDate (p) {
+  if (p?.frontmatter?.modDate != null) {
+    return true;
+  }
+
+  return false;
+}
+
+/**
+ * Predicate for whether a page should be listed
+ * @param {MarkdownInstance<Record<string, any>>} p
+ * @returns {boolean}
+ */
+export function isListable (p) {
+  if (p.url == null || p.url === '') {
+    return false;
+  }
+
+  if (p.frontmatter == null || p.frontmatter.layout == null) {
+    return false;
+  }
+
+  if (p.frontmatter.layout.includes('/Redirect.astro')) {
+    return false;
+  }
+
+  if (p.frontmatter.listable != null && p.frontmatter.listable == false) {
+    return false;
+  }
+
+  if (p.frontmatter.draft == true) {
+    return false;
+  }
+
+  if (p.frontmatter.pubDate != null && Date.parse(p.frontmatter.pubDate) > Date.now()) {
+    return false;
+  }
+
+  return true;
+}
+
+/**
+ * Predicate for whether a page should be used to create tag and category lists.
+ * Specifically, this allows future-dated posts to cause taxonomy pages to be created,
+ * @param {MarkdownInstance<Record<string, any>>} p
+ * @returns {boolean}
+ */
+export function forTaxonomy (p) {
+  if (p.url == null || p.url === '') {
+    return false;
+  }
+
+  if (p.frontmatter == null || p.frontmatter.layout == null) {
+    return false;
+  }
+
+  if (p.frontmatter.layout.includes('/Redirect.astro')) {
+    return false;
+  }
+
+  if (p.frontmatter.listable != null && p.frontmatter.listable == false) {
+    return false;
+  }
+
+  if (p.frontmatter.draft == true) {
+    return false;
+  }
+
+  return true;
+}
+
+/**
+ * Sorts by the pubDate field
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByPubDate (a, b) {
+  const dateA = a.frontmatter.pubDate || '1970-01-01';
+  const dateB = b.frontmatter.pubDate || '1970-01-01';
+  return dateA.localeCompare(dateB);
+}
+
+/**
+ * Sorts by the pubDate field in descending order
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByPubDateDesc (a, b) {
+  const dateA = a.frontmatter.pubDate || '1970-01-01';
+  const dateB = b.frontmatter.pubDate || '1970-01-01';
+  return dateB.localeCompare(dateA);
+}
+
+/**
+ * Sorts by the modDate field
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByModDate (a, b) {
+  const dateA = a.frontmatter.modDate || a.frontmatter.pubDate || '1970-01-01';
+  const dateB = b.frontmatter.modDate || b.frontmatter.pubDate || '1970-01-01';
+  return dateA.localeCompare(dateB);
+}
+
+/**
+ * Sorts by the modDate field
+ * @param {MarkdownInstance} a
+ * @param {MarkdownInstance} b
+ * @returns {any}
+ */
+export function sortByModDateDesc (a, b) {
+  const dateA = a.frontmatter.modDate || a.frontmatter.pubDate || '1970-01-01';
+  const dateB = b.frontmatter.modDate || b.frontmatter.pubDate || '1970-01-01';
+  return dateB.localeCompare(dateA);
+}
+
+export const PostFiltering = {
+  showInSitemap,
+  showInSearch,
+  showInMenu,
+  isAuthor,
+  notAuthor,
+  isSearch,
+  notSearch,
+  hasDate,
+  hasModDate,
+  isListable,
+  forTaxonomy
+};
+
+export const PostOrdering = {
+  sortByPubDate,
+  sortByPubDateDesc,
+  sortByModDate,
+  sortByModDateDesc
+};
+
+export { Accelerator };

package/lib/v1/authors.mjs

@@ -1,4 +1,4 @@
-import * as PostFiltering from '../postFiltering.mjs';
+import { PostFiltering } from '../../index.mjs';
 
 /**
  * @typedef { import("../../types/AuthorList").AuthorList } AuthorList

package/lib/v1/navigation.mjs

@@ -1,4 +1,4 @@
-import * as PostFiltering from '../postFiltering.mjs';
+import { PostFiltering } from '../../index.mjs';
 
 /**
  * @typedef { import("./posts.mjs").Posts } Posts

package/lib/v1/taxonomy.mjs

@@ -1,4 +1,4 @@
-import * as PostFiltering from '../postFiltering.mjs';
+import { PostFiltering } from '../../index.mjs';
 
 /**
  * @typedef { import("./cache.mjs").Cache } Cache

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.3.90",
+  "version": "0.3.92",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",
@@ -37,7 +37,7 @@
   "homepage": "https://astro.stevefenton.co.uk/",
   "devDependencies": {
     "@cucumber/cucumber": "^13.0.0",
-    "@types/node": "^25.9.2",
+    "@types/node": "^25.9.3",
     "c8": "^11.0.0",
     "cspell": "^10.0.1",
     "rehype-stringify": "^10.0.1",

package/lib/postFiltering.d.mts

@@ -1,73 +0,0 @@
-/**
- * @typedef { import("../types/PagePredicate").PagePredicate } PagePredicate
- * @typedef { import("../types/Astro").MarkdownInstance} MarkdownInstance
- */
-/**
- * Predicate for whether a page should appear in the sitemap
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function showInSitemap(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page should appear in the site search
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function showInSearch(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page should appear in the navigation menu
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function showInMenu(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page is an author page
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function isAuthor(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page is an author page
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function notAuthor(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page is a search page
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function isSearch(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page is an search page
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function notSearch(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page has a modified date
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function hasDate(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page has a modified date
- * @param {MarkdownInstance} p
- * @returns {boolean}
- */
-export function hasModDate(p: MarkdownInstance): boolean;
-/**
- * Predicate for whether a page should be listed
- * @param {MarkdownInstance<Record<string, any>>} p
- * @returns {boolean}
- */
-export function isListable(p: MarkdownInstance<Record<string, any>>): boolean;
-/**
- * Predicate for whether a page should be used to create tag and category lists.
- * Specifically, this allows future-dated posts to cause taxonomy pages to be created,
- * @param {MarkdownInstance<Record<string, any>>} p
- * @returns {boolean}
- */
-export function forTaxonomy(p: MarkdownInstance<Record<string, any>>): boolean;
-export type PagePredicate = import("../types/PagePredicate").PagePredicate;
-export type MarkdownInstance = import("../types/Astro").MarkdownInstance;

package/lib/postFiltering.mjs

@@ -1,181 +0,0 @@
-/**
- * @typedef { import("../types/PagePredicate").PagePredicate } PagePredicate
- * @typedef { import("../types/Astro").MarkdownInstance} MarkdownInstance
- */
-
-/**
- * Predicate for whether a page should appear in the sitemap
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function showInSitemap (p) {
-  // User setting to remove from sitemap
-  if (typeof p.frontmatter.navSitemap !== 'undefined'
-    && p.frontmatter.navSitemap == false) {
-    return false;
-  }
-
-  return isListable(p);
-}
-
-/**
- * Predicate for whether a page should appear in the site search
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function showInSearch (p) {
-  // User setting to remove from search
-  if (typeof p.frontmatter.navSearch !== 'undefined'
-    && p.frontmatter.navSearch == false) {
-    return false;
-  }
-
-  return isListable(p);
-}
-
-/**
- * Predicate for whether a page should appear in the navigation menu
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function showInMenu (p) {
-  if (typeof p.frontmatter.navMenu !== 'undefined'
-    && p.frontmatter.navMenu == false) {
-    return false;
-  }
-
-  return true;
-}
-
-/**
- * Predicate for whether a page is an author page
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function isAuthor (p) {
-  if (p?.frontmatter?.layout?.indexOf('/Author.astro') > -1) {
-    return true;
-  }
-
-  return false;
-}
-
-/**
- * Predicate for whether a page is an author page
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function notAuthor (p) {
-  return !isAuthor(p);
-}
-
-/**
- * Predicate for whether a page is a search page
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function isSearch (p) {
-  if (p?.frontmatter?.layout?.indexOf('/Search.astro') > -1) {
-    return true;
-  }
-
-  return false;
-}
-
-/**
- * Predicate for whether a page is an search page
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function notSearch (p) {
-  return !isSearch(p);
-}
-
-/**
- * Predicate for whether a page has a modified date
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function hasDate (p) {
-  if (p?.frontmatter?.modDate != null || p?.frontmatter?.pubDate != null) {
-    return true;
-  }
-
-  return false;
-}
-
-/**
- * Predicate for whether a page has a modified date
- * @param {MarkdownInstance} p 
- * @returns {boolean}
- */
-export function hasModDate (p) {
-  if (p?.frontmatter?.modDate != null) {
-    return true;
-  }
-
-  return false;
-}
-
-/**
- * Predicate for whether a page should be listed
- * @param {MarkdownInstance<Record<string, any>>} p 
- * @returns {boolean}
- */
-export function isListable (p) {
-  if (p.url == null || p.url === '') {
-    return false;
-  }
-
-  if (p.frontmatter == null || p.frontmatter.layout == null) {
-    return false;
-  }
-
-  if (p.frontmatter.layout.includes('/Redirect.astro')) {
-    return false;
-  }
-
-  if (p.frontmatter.listable != null && p.frontmatter.listable == false) {
-    return false;
-  }
-
-  if (p.frontmatter.draft == true) {
-    return false;
-  }
-
-  if (p.frontmatter.pubDate != null && Date.parse(p.frontmatter.pubDate) > Date.now()) {
-    return false;
-  }
-
-  return true;
-}
-
-/**
- * Predicate for whether a page should be used to create tag and category lists.
- * Specifically, this allows future-dated posts to cause taxonomy pages to be created,
- * @param {MarkdownInstance<Record<string, any>>} p 
- * @returns {boolean}
- */
-export function forTaxonomy (p) {
-  if (p.url == null || p.url === '') {
-    return false;
-  }
-
-  if (p.frontmatter == null || p.frontmatter.layout == null) {
-    return false;
-  }
-
-  if (p.frontmatter.layout.includes('/Redirect.astro')) {
-    return false;
-  }
-
-  if (p.frontmatter.listable != null && p.frontmatter.listable == false) {
-    return false;
-  }
-
-  if (p.frontmatter.draft == true) {
-    return false;
-  }
-
-  return true;
-}

package/lib/postOrdering.d.mts

@@ -1,32 +0,0 @@
-/**
- * @typedef { import("../types/Astro").MarkdownInstance} MarkdownInstance
- */
-/**
- * Sorts by the pubDate field
- * @param {MarkdownInstance} a
- * @param {MarkdownInstance} b
- * @returns {any}
- */
-export function sortByPubDate(a: MarkdownInstance, b: MarkdownInstance): any;
-/**
- * Sorts by the pubDate field in descending order
- * @param {MarkdownInstance} a
- * @param {MarkdownInstance} b
- * @returns {any}
- */
-export function sortByPubDateDesc(a: MarkdownInstance, b: MarkdownInstance): any;
-/**
- * Sorts by the modDate field
- * @param {MarkdownInstance} a
- * @param {MarkdownInstance} b
- * @returns {any}
- */
-export function sortByModDate(a: MarkdownInstance, b: MarkdownInstance): any;
-/**
- * Sorts by the modDate field
- * @param {MarkdownInstance} a
- * @param {MarkdownInstance} b
- * @returns {any}
- */
-export function sortByModDateDesc(a: MarkdownInstance, b: MarkdownInstance): any;
-export type MarkdownInstance = import("../types/Astro").MarkdownInstance;

package/lib/postOrdering.mjs

@@ -1,51 +0,0 @@
-/**
- * @typedef { import("../types/Astro").MarkdownInstance} MarkdownInstance
- */
-
-/**
- * Sorts by the pubDate field
- * @param {MarkdownInstance} a 
- * @param {MarkdownInstance} b 
- * @returns {any}
- */
-export function sortByPubDate (a, b) {
-  const dateA = a.frontmatter.pubDate || '1970-01-01';
-  const dateB = b.frontmatter.pubDate || '1970-01-01';
-  return dateA.localeCompare(dateB);
-}
-
-/**
- * Sorts by the pubDate field in descending order
- * @param {MarkdownInstance} a 
- * @param {MarkdownInstance} b 
- * @returns {any}
- */
-export function sortByPubDateDesc (a, b) {
-  const dateA = a.frontmatter.pubDate || '1970-01-01';
-  const dateB = b.frontmatter.pubDate || '1970-01-01';
-  return dateB.localeCompare(dateA);
-}
-
-/**
- * Sorts by the modDate field
- * @param {MarkdownInstance} a 
- * @param {MarkdownInstance} b 
- * @returns {any}
- */
-export function sortByModDate (a, b) {
-  const dateA = a.frontmatter.modDate || a.frontmatter.pubDate || '1970-01-01';
-  const dateB = b.frontmatter.modDate || b.frontmatter.pubDate || '1970-01-01';
-  return dateA.localeCompare(dateB);
-}
-
-/**
- * Sorts by the modDate field
- * @param {MarkdownInstance} a 
- * @param {MarkdownInstance} b 
- * @returns {any}
- */
-export function sortByModDateDesc (a, b) {
-  const dateA = a.frontmatter.modDate || a.frontmatter.pubDate || '1970-01-01';
-  const dateB = b.frontmatter.modDate || b.frontmatter.pubDate || '1970-01-01';
-  return dateB.localeCompare(dateA);
-}