astro-accelerator-utils 0.3.7 → 0.3.9

package/lib/postFiltering.mjs

@@ -1,117 +1,117 @@
-/**
- * @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 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 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) {
-    console.log('No frontmatter layout for ' + p.url);
-    return false;
-  }
-
-  if (p.frontmatter.layout.includes('/Redirect.astro')) {
-    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;
+/**
+ * @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 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 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) {
+    console.log('No frontmatter layout for ' + p.url);
+    return false;
+  }
+
+  if (p.frontmatter.layout.includes('/Redirect.astro')) {
+    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;
 }

package/lib/postOrdering.d.mts

@@ -1,32 +1,32 @@
-/**
- * @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;
+/**
+ * @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 +1,51 @@
-/**
- * @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);
-}
+/**
+ * @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);
+}

package/lib/v1/accelerator.d.mts

@@ -1,36 +1,36 @@
-/**
- * @typedef { import("../../types/Site").Site } Site
- */
-export class Accelerator {
-    /**
-     * @param {Site} site
-     */
-    constructor(site: Site);
-    cacheMaxAge: number;
-    dateOptions: Intl.DateTimeFormatOptions;
-    siteUrl: string;
-    subfolder: string;
-    useTrailingUrlSlash: boolean;
-    captureStatistics: boolean;
-    get authors(): Authors;
-    get cache(): Cache;
-    get dateFormatter(): DateFormatter;
-    get markdown(): Markdown;
-    get navigation(): Navigation;
-    get paging(): Paging;
-    get posts(): Posts;
-    get taxonomy(): Taxonomy;
-    get urlFormatter(): UrlFormatter;
-    get statistics(): typeof StatisticsStub;
-}
-export type Site = import("../../types/Site").Site;
-import { Authors } from "./authors.mjs";
-import { Cache } from "./cache.mjs";
-import { DateFormatter } from "./dates.mjs";
-import { Markdown } from "./markdown.mjs";
-import { Navigation } from "./navigation.mjs";
-import { Paging } from "./paging.mjs";
-import { Posts } from "./posts.mjs";
-import { Taxonomy } from "./taxonomy.mjs";
-import { UrlFormatter } from "./urls.mjs";
-import { StatisticsStub } from "./statistics-stub.mjs";
+/**
+ * @typedef { import("../../types/Site").Site } Site
+ */
+export class Accelerator {
+    /**
+     * @param {Site} site
+     */
+    constructor(site: Site);
+    cacheMaxAge: number;
+    dateOptions: Intl.DateTimeFormatOptions;
+    siteUrl: string;
+    subfolder: string;
+    useTrailingUrlSlash: boolean;
+    captureStatistics: boolean;
+    get authors(): Authors;
+    get cache(): Cache;
+    get dateFormatter(): DateFormatter;
+    get markdown(): Markdown;
+    get navigation(): Navigation;
+    get paging(): Paging;
+    get posts(): Posts;
+    get taxonomy(): Taxonomy;
+    get urlFormatter(): UrlFormatter;
+    get statistics(): typeof StatisticsStub;
+}
+export type Site = import("../../types/Site").Site;
+import { Authors } from "./authors.mjs";
+import { Cache } from "./cache.mjs";
+import { DateFormatter } from "./dates.mjs";
+import { Markdown } from "./markdown.mjs";
+import { Navigation } from "./navigation.mjs";
+import { Paging } from "./paging.mjs";
+import { Posts } from "./posts.mjs";
+import { Taxonomy } from "./taxonomy.mjs";
+import { UrlFormatter } from "./urls.mjs";
+import { StatisticsStub } from "./statistics-stub.mjs";

package/lib/v1/accelerator.mjs

@@ -1,71 +1,71 @@
-import { Authors } from './authors.mjs';
-import { Cache } from './cache.mjs';
-import { DateFormatter } from './dates.mjs';
-import { Markdown } from './markdown.mjs';
-import { Navigation } from './navigation.mjs';
-import { Paging } from './paging.mjs';
-import { Posts } from './posts.mjs';
-import { Taxonomy } from './taxonomy.mjs';
-import { UrlFormatter } from './urls.mjs';
-import { Statistics } from './statistics.mjs';
-import { StatisticsStub } from './statistics-stub.mjs';
-
-/**
- * @typedef { import("../../types/Site").Site } Site
- */
-
-export class Accelerator {
-    /**
-     * @param {Site} site
-     */
-    constructor(site) {
-        this.cacheMaxAge = site.cacheMaxAge;
-        this.dateOptions = site.dateOptions;
-        this.siteUrl = site.url;
-        this.subfolder = site.subfolder;
-        this.useTrailingUrlSlash = site.useTrailingUrlSlash;
-        this.captureStatistics = site.captureStatistics;
-    }
-
-    get authors() {
-        return new Authors(this.posts);
-    }
-
-    get cache() {
-        return new Cache(this.cacheMaxAge);
-    }
-
-    get dateFormatter() {
-        return new DateFormatter(this.dateOptions)
-    }
-
-    get markdown() {
-        return new Markdown();
-    }
-
-    get navigation() {
-        return new Navigation(this.posts, this.urlFormatter, this.taxonomy);
-    }
-
-    get paging() {
-        return new Paging();
-    }
-
-    get posts() {
-        return new Posts(this.cache);
-    }
-
-    get taxonomy() {
-        return new Taxonomy(this.cache, this.posts, this.urlFormatter);
-    }
-
-    get urlFormatter() {
-        return new UrlFormatter(this.siteUrl, this.subfolder, this.useTrailingUrlSlash);
-    }
-
-    get statistics() {
-        return (this.captureStatistics)
-            ? Statistics
-            : StatisticsStub;
-    }
+import { Authors } from './authors.mjs';
+import { Cache } from './cache.mjs';
+import { DateFormatter } from './dates.mjs';
+import { Markdown } from './markdown.mjs';
+import { Navigation } from './navigation.mjs';
+import { Paging } from './paging.mjs';
+import { Posts } from './posts.mjs';
+import { Taxonomy } from './taxonomy.mjs';
+import { UrlFormatter } from './urls.mjs';
+import { Statistics } from './statistics.mjs';
+import { StatisticsStub } from './statistics-stub.mjs';
+
+/**
+ * @typedef { import("../../types/Site").Site } Site
+ */
+
+export class Accelerator {
+    /**
+     * @param {Site} site
+     */
+    constructor(site) {
+        this.cacheMaxAge = site.cacheMaxAge;
+        this.dateOptions = site.dateOptions;
+        this.siteUrl = site.url;
+        this.subfolder = site.subfolder;
+        this.useTrailingUrlSlash = site.useTrailingUrlSlash;
+        this.captureStatistics = site.captureStatistics;
+    }
+
+    get authors() {
+        return new Authors(this.posts);
+    }
+
+    get cache() {
+        return new Cache(this.cacheMaxAge);
+    }
+
+    get dateFormatter() {
+        return new DateFormatter(this.dateOptions)
+    }
+
+    get markdown() {
+        return new Markdown();
+    }
+
+    get navigation() {
+        return new Navigation(this.posts, this.urlFormatter, this.taxonomy);
+    }
+
+    get paging() {
+        return new Paging();
+    }
+
+    get posts() {
+        return new Posts(this.cache);
+    }
+
+    get taxonomy() {
+        return new Taxonomy(this.cache, this.posts, this.urlFormatter);
+    }
+
+    get urlFormatter() {
+        return new UrlFormatter(this.siteUrl, this.subfolder, this.useTrailingUrlSlash);
+    }
+
+    get statistics() {
+        return (this.captureStatistics)
+            ? Statistics
+            : StatisticsStub;
+    }
 }

package/lib/v1/authors.d.mts

@@ -1,28 +1,28 @@
-/**
- * @typedef { import("../../types/AuthorList").AuthorList } AuthorList
- * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
- * @typedef { import("../../types/Frontmatter").Frontmatter } Frontmatter
- */
-export class Authors {
-    /**
-     * Constructor
-     * @param {Posts} posts
-     */
-    constructor(posts: Posts);
-    posts: Posts;
-    /**
-     * Gets a list of authors, and exposes main author and contributors
-     * @param {Frontmatter} frontmatter
-     * @returns {AuthorList}
-     */
-    forPost(frontmatter: Frontmatter): AuthorList;
-    /**
-     * Get a single author by id/slug
-     * @param {string} slug
-     * @returns {MarkdownInstance}
-     */
-    info(slug: string): MarkdownInstance;
-}
-export type AuthorList = import("../../types/AuthorList").AuthorList;
-export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
-export type Frontmatter = import("../../types/Frontmatter").Frontmatter;
+/**
+ * @typedef { import("../../types/AuthorList").AuthorList } AuthorList
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ * @typedef { import("../../types/Frontmatter").Frontmatter } Frontmatter
+ */
+export class Authors {
+    /**
+     * Constructor
+     * @param {Posts} posts
+     */
+    constructor(posts: Posts);
+    posts: Posts;
+    /**
+     * Gets a list of authors, and exposes main author and contributors
+     * @param {Frontmatter} frontmatter
+     * @returns {AuthorList}
+     */
+    forPost(frontmatter: Frontmatter): AuthorList;
+    /**
+     * Get a single author by id/slug
+     * @param {string} slug
+     * @returns {MarkdownInstance}
+     */
+    info(slug: string): MarkdownInstance;
+}
+export type AuthorList = import("../../types/AuthorList").AuthorList;
+export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
+export type Frontmatter = import("../../types/Frontmatter").Frontmatter;