astro-accelerator-utils 0.3.97 → 0.3.99

package/index.d.mts

@@ -1,3 +1,6 @@
+import { Accelerator } from './lib/v1/accelerator.mjs';
+export type PagePredicate = import("./types/PagePredicate").PagePredicate;
+export type MarkdownInstance = import("./types/Astro").MarkdownInstance;
 /**
  * @typedef { import("./types/PagePredicate").PagePredicate } PagePredicate
  * @typedef { import("./types/Astro").MarkdownInstance} MarkdownInstance
@@ -7,116 +10,113 @@
  * @param {MarkdownInstance} p
  * @returns {boolean}
  */
-export function showInSitemap(p: MarkdownInstance): boolean;
+export declare 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;
+export declare 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;
+export declare 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;
+export declare 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;
+export declare 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;
+export declare 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;
+export declare 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;
+export declare 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;
+export declare 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;
+export declare 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 declare 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;
+export declare 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;
+export declare 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;
+export declare 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 declare function sortByModDateDesc(a: MarkdownInstance, b: MarkdownInstance): any;
+export declare const PostFiltering: {
+    showInSitemap: typeof showInSitemap;
+    showInSearch: typeof showInSearch;
+    showInMenu: typeof showInMenu;
+    isAuthor: typeof isAuthor;
+    notAuthor: typeof notAuthor;
+    isSearch: typeof isSearch;
+    notSearch: typeof notSearch;
+    hasDate: typeof hasDate;
+    hasModDate: typeof hasModDate;
+    isListable: typeof isListable;
+    forTaxonomy: typeof forTaxonomy;
+};
+export declare const PostOrdering: {
+    sortByPubDate: typeof sortByPubDate;
+    sortByPubDateDesc: typeof sortByPubDateDesc;
+    sortByModDate: typeof sortByModDate;
+    sortByModDateDesc: typeof sortByModDateDesc;
+};
 export { Accelerator };
-export type PagePredicate = import("./types/PagePredicate").PagePredicate;
-export type MarkdownInstance = import("./types/Astro").MarkdownInstance;
-import { Accelerator } from './lib/v1/accelerator.mjs';

package/lib/v1/accelerator.d.mts

@@ -1,11 +1,18 @@
+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';
+export type Site = import("../../types/Site").Site;
 /**
  * @typedef { import("../../types/Site").Site } Site
  */
-export class Accelerator {
-    /**
-     * @param {Site} site
-     */
-    constructor(site: Site);
+export declare class Accelerator {
     cacheMaxAge: number;
     dateOptions: Intl.DateTimeFormatOptions;
     shortDateOptions: Intl.DateTimeFormatOptions;
@@ -13,6 +20,10 @@ export class Accelerator {
     subfolder: string;
     useTrailingUrlSlash: boolean | undefined;
     captureStatistics: boolean;
+    /**
+     * @param {Site} site
+     */
+    constructor(site: Site);
     get authors(): Authors;
     get cache(): Cache;
     get dateFormatter(): DateFormatter;
@@ -24,14 +35,3 @@ export class Accelerator {
     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/authors.d.mts

@@ -1,15 +1,18 @@
+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 {
+export declare class Authors {
+    posts: Posts;
     /**
      * Constructor
      * @param {Posts} posts
      */
     constructor(posts: Posts);
-    posts: Posts;
     /**
      * Gets a list of authors, and exposes main author and contributors
      * @param {Frontmatter} frontmatter
@@ -23,6 +26,3 @@ export class Authors {
      */
     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;

package/lib/v1/cache.d.mts

@@ -1,10 +1,10 @@
-export class Cache {
+export declare class Cache {
+    maxAge: number;
     /**
      * Constructor
      * @param {number} maxAge
      */
     constructor(maxAge: number);
-    maxAge: number;
     /**
      * Gets an item from the cache, falls back to supplied function
      * @param {string} key

package/lib/v1/dates.d.mts

@@ -1,15 +1,16 @@
 /**
  * @typedef { import("../types/Site") } Site
  */
-export class DateFormatter {
+export type Site = import("../types/Site");
+export declare class DateFormatter {
+    dateOptions: Intl.DateTimeFormatOptions;
+    shortDateOptions: Intl.DateTimeFormatOptions;
     /**
      * Constructor
      * @param {Intl.DateTimeFormatOptions} dateOptions
      * @param {Intl.DateTimeFormatOptions} shortDateOptions
      */
     constructor(dateOptions: Intl.DateTimeFormatOptions, shortDateOptions: Intl.DateTimeFormatOptions);
-    dateOptions: Intl.DateTimeFormatOptions;
-    shortDateOptions: Intl.DateTimeFormatOptions;
     /**
      * Returns the formatted pubDate
      * @param {string | Date} date
@@ -39,4 +40,3 @@ export class DateFormatter {
      */
     formatShortDateWithoutDay(date: string | Date, lang: string): string;
 }
-export type Site = any;

package/lib/v1/markdown.d.mts

@@ -1,4 +1,4 @@
-export class Markdown {
+export declare class Markdown {
     /**
      * Converts markdown to HTML without wrapping in a <p>
      * @param {string} markdown

package/lib/v1/navigation.d.mts

@@ -1,4 +1,13 @@
-export class Navigation {
+export type Posts = import("./posts.mjs").Posts;
+export type Taxonomy = import("./taxonomy.mjs").Taxonomy;
+export type UrlFormatter = import("./urls.mjs").UrlFormatter;
+export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
+export type NavPage = import("../../types/NavPage").NavPage;
+export type MenuItem = import("../../types/NavPage").MenuItem;
+export declare class Navigation {
+    posts: import("./posts.mjs").Posts;
+    urlFormatter: import("./urls.mjs").UrlFormatter;
+    taxonomy: import("./taxonomy.mjs").Taxonomy;
     /**
      * Constructor
      * @param {Posts} posts
@@ -6,9 +15,6 @@ export class Navigation {
      * @param {Taxonomy} taxonomy
      */
     constructor(posts: Posts, urlFormatter: UrlFormatter, taxonomy: Taxonomy);
-    posts: import("./posts.mjs").Posts;
-    urlFormatter: import("./urls.mjs").UrlFormatter;
-    taxonomy: import("./taxonomy.mjs").Taxonomy;
     /**
      * Returns a list of breadcrumbs
      * @param {URL} currentUrl
@@ -24,7 +30,7 @@ export class Navigation {
      * @param {(MenuItem | 'auto')[]} menu
      * @returns {NavPage[]}
      */
-    menu(currentUrl: URL, subfolder: string, menu: (MenuItem | "auto")[]): NavPage[];
+    menu(currentUrl: URL, subfolder: string, menu: (MenuItem | 'auto')[]): NavPage[];
     addMenuItem(pages: any, item: any, subfolder: any): void;
     /**
      *
@@ -47,7 +53,7 @@ export class Navigation {
      * @param {(MenuItem | 'categories' | 'tags' | 'toptags')[]} menu
      * @returns {NavPage[]}
      */
-    footer(currentUrl: URL, _: TranslationProvider, translations: any, subfolder: string, menu: (MenuItem | "categories" | "tags" | "toptags")[]): NavPage[];
+    footer(currentUrl: URL, _: TranslationProvider, translations: any, subfolder: string, menu: (MenuItem | 'categories' | 'tags' | 'toptags')[]): NavPage[];
     addFooterItem(pages: any, item: any, links: any, _: any, translations: any, subfolder: any, entries: any): void;
     /**
      *
@@ -102,7 +108,19 @@ export class Navigation {
      * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item
      * @returns {item is NavPage}
      */
-    isNavPage(item: NavPage | "auto" | "tags" | "toptags" | "categories"): item is NavPage;
+    isNavPage(item: NavPage | 'auto' | 'tags' | 'toptags' | 'categories'): item is NavPage;
+    /**
+     * Counts non-empty path segments so trailing slashes do not affect depth
+     * @param {string | null | undefined} path
+     * @returns {number}
+     */
+    pathDepth(path: string | null | undefined): number;
+    /**
+     * Normalizes a path for comparison by joining non-empty segments
+     * @param {string | null | undefined} path
+     * @returns {string}
+     */
+    normalizePath(path: string | null | undefined): string;
     /**
      * Pops matching page from array
      * @param {MarkdownInstance[]} allPages
@@ -111,9 +129,3 @@ export class Navigation {
      */
     popMatchingPage(allPages: MarkdownInstance[], search: string): import("../../types/Astro").MarkdownInstance | null;
 }
-export type Posts = import("./posts.mjs").Posts;
-export type Taxonomy = import("./taxonomy.mjs").Taxonomy;
-export type UrlFormatter = import("./urls.mjs").UrlFormatter;
-export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
-export type NavPage = import("../../types/NavPage").NavPage;
-export type MenuItem = import("../../types/NavPage").MenuItem;

package/lib/v1/navigation.mjs

@@ -120,7 +120,7 @@ export class Navigation {
             page.url != '/'
             && mp.url != page.url
             && mp.url.startsWith(page.url)
-            && mp.url.split('/').length == (page.url.split('/').length + 1)
+            && this.pathDepth(mp.url) == (this.pathDepth(page.url) + 1)
         )
         .sort((mp) => mp.order);
 
@@ -458,6 +458,30 @@ export class Navigation {
         return true;
     }
 
+    /**
+     * Counts non-empty path segments so trailing slashes do not affect depth
+     * @param {string | null | undefined} path
+     * @returns {number}
+     */
+    pathDepth(path) {
+        const url = path ?? '/';
+        return url.split('/').filter((segment) => segment.length > 0).length;
+    }
+
+    /**
+     * Normalizes a path for comparison by joining non-empty segments
+     * @param {string | null | undefined} path
+     * @returns {string}
+     */
+    normalizePath(path) {
+        const depth = this.pathDepth(path);
+        if (depth === 0) {
+            return '/';
+        }
+
+        return '/' + (path ?? '/').split('/').filter((segment) => segment.length > 0).join('/');
+    }
+
     /**
      * Pops matching page from array
      * @param {MarkdownInstance[]} allPages 
@@ -468,9 +492,10 @@ export class Navigation {
         const numberToRemove = 1;
         let indexToRemove = -1;
         let match = null;
+        const normalizedSearch = this.normalizePath(search);
 
         for (let i = 0; i < allPages.length; i++) {
-            if (allPages[i].url == search) {
+            if (this.normalizePath(allPages[i].url) === normalizedSearch) {
                 indexToRemove = i;
                 match = allPages[i];
             }

package/lib/v1/paging.d.mts

@@ -1,7 +1,8 @@
 /**
  * @typedef { import("../../types/Link").Link } Link
  */
-export class Paging {
+export type Link = import("../../types/Link").Link;
+export declare class Paging {
     /**
      * Provides a list of paging links, 1 ... 3 4 5 ... 7
      * @param {number} limit
@@ -12,4 +13,3 @@ export class Paging {
      */
     links(limit: number, numberOfPages: number, currentPage: number, url: string): Link[];
 }
-export type Link = import("../../types/Link").Link;

package/lib/v1/posts.d.mts

@@ -2,15 +2,17 @@
  * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
  * @typedef { import("./cache.mjs").Cache } Cache
  */
-export class Posts {
+export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
+export type Cache = import("./cache.mjs").Cache;
+export declare class Posts {
+    cache: import("./cache.mjs").Cache;
+    fetchAll: () => any;
     /**
      * Constructor
      * @param {Cache} cache
      * @param {() => MarkdownInstance[]} [fetchAll]
      */
     constructor(cache: Cache, fetchAll?: () => MarkdownInstance[]);
-    cache: import("./cache.mjs").Cache;
-    fetchAll: () => any;
     /**
      * Gets all markdown posts in the site
      * @returns {MarkdownInstance[]}
@@ -22,5 +24,3 @@ export class Posts {
      */
     root(subfolder: any): MarkdownInstance[];
 }
-export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
-export type Cache = import("./cache.mjs").Cache;

package/lib/v1/taxonomy.d.mts

@@ -1,3 +1,11 @@
+export type Cache = import("./cache.mjs").Cache;
+export type Posts = import("./posts.mjs").Posts;
+export type UrlFormatter = import("./urls.mjs").UrlFormatter;
+export type Site = import("../../types/Site").Site;
+export type TaxonomyList = import("../../types/Taxonomy").TaxonomyList;
+export type TaxonomyEntry = import("../../types/Taxonomy").TaxonomyEntry;
+export type TaxonomyLinks = import("../../types/Taxonomy").TaxonomyLinks;
+export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
 /**
  * @typedef { import("./cache.mjs").Cache } Cache
  * @typedef { import("./posts.mjs").Posts } Posts
@@ -8,7 +16,10 @@
  * @typedef { import("../../types/Taxonomy").TaxonomyLinks } TaxonomyLinks
  * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
  */
-export class Taxonomy {
+export declare class Taxonomy {
+    cache: import("./cache.mjs").Cache;
+    posts: import("./posts.mjs").Posts;
+    urlFormatter: import("./urls.mjs").UrlFormatter;
     /**
      * Constructor
      * @param {Cache} cache
@@ -16,9 +27,6 @@ export class Taxonomy {
      * @param {UrlFormatter} urlFormatter
      */
     constructor(cache: Cache, posts: Posts, urlFormatter: UrlFormatter);
-    cache: import("./cache.mjs").Cache;
-    posts: import("./posts.mjs").Posts;
-    urlFormatter: import("./urls.mjs").UrlFormatter;
     /**
      *
      * @returns {TaxonomyList}
@@ -43,7 +51,7 @@ export class Taxonomy {
      * @param {TaxonomyEntry} b
      * @returns
      */
-    sortByTitle(a: TaxonomyEntry, b: TaxonomyEntry): 0 | 1 | -1;
+    sortByTitle(a: TaxonomyEntry, b: TaxonomyEntry): -1 | 0 | 1;
     /**
      * Sorts taxonomy entries by title
      * @param {TaxonomyEntry} a
@@ -52,11 +60,3 @@ export class Taxonomy {
      */
     sortByVolume(a: TaxonomyEntry, b: TaxonomyEntry): number;
 }
-export type Cache = import("./cache.mjs").Cache;
-export type Posts = import("./posts.mjs").Posts;
-export type UrlFormatter = import("./urls.mjs").UrlFormatter;
-export type Site = import("../../types/Site").Site;
-export type TaxonomyList = import("../../types/Taxonomy").TaxonomyList;
-export type TaxonomyEntry = import("../../types/Taxonomy").TaxonomyEntry;
-export type TaxonomyLinks = import("../../types/Taxonomy").TaxonomyLinks;
-export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;

package/lib/v1/urls.d.mts

@@ -1,4 +1,7 @@
-export class UrlFormatter {
+export declare class UrlFormatter {
+    siteUrl: string;
+    subfolder: string;
+    useTrailingUrlSlash: boolean;
     /**
      * Constructor
      * @param {string} siteUrl
@@ -6,9 +9,6 @@ export class UrlFormatter {
      * @param {boolean} useTrailingUrlSlash
      */
     constructor(siteUrl: string, subfolder: string, useTrailingUrlSlash: boolean);
-    siteUrl: string;
-    subfolder: string;
-    useTrailingUrlSlash: boolean;
     /** Uses config to decide whether to add or remove trailing slashes
      * @param {URL} url
      * @returns {URL}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.3.97",
+  "version": "0.3.99",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",
@@ -37,13 +37,13 @@
   "homepage": "https://astro.stevefenton.co.uk/",
   "devDependencies": {
     "@cucumber/cucumber": "^13.0.0",
-    "@types/node": "^26.1.0",
+    "@types/node": "^26.1.1",
     "c8": "^11.0.0",
     "cspell": "^10.0.1",
     "rehype-stringify": "^10.0.1",
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.2",
-    "typescript": "^6.0.3",
+    "typescript": "^7.0.2",
     "unified": "^11.0.5"
   }
 }