astro-accelerator-utils 0.2.39 → 0.3.0

package/README.md

@@ -7,3 +7,14 @@ Utility classes for Astro Accelerator
 [![npm](https://img.shields.io/npm/v/astro-accelerator-utils?color=blue&style=plastic)](https://www.npmjs.com/package/astro-accelerator-utils/)
 [![npm](https://img.shields.io/npm/dm/astro-accelerator-utils?style=plastic)](https://www.npmjs.com/package/astro-accelerator-utils/)
 
+## Update Type Information
+
+Run the command:
+
+    pnpm types
+
+## Running Tests
+
+Run the command:
+
+    pnpm test

package/lib/v1/navigation.d.mts

@@ -1,10 +1,3 @@
-/**
- * @typedef { import("./posts.mjs").Posts } Posts
- * @typedef { import("./taxonomy.mjs").Taxonomy } Taxonomy
- * @typedef { import("./urls.mjs").UrlFormatter } UrlFormatter
- * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
- * @typedef { import("../../types/NavPage").NavPage } NavPage
- */
 export class Navigation {
     /**
      * Constructor
@@ -28,10 +21,10 @@ export class Navigation {
      *
      * @param {URL} currentUrl
      * @param {string} subfolder
-     * @param {(NavPage | 'auto')[]} menu
+     * @param {(MenuItem | 'auto')[]} menu
      * @returns {NavPage[]}
      */
-    menu(currentUrl: URL, subfolder: string, menu: (NavPage | 'auto')[]): NavPage[];
+    menu(currentUrl: URL, subfolder: string, menu: (MenuItem | 'auto')[]): NavPage[];
     /**
      *
      * @param {NavPage} page
@@ -50,10 +43,10 @@ export class Navigation {
      * @param {TranslationProvider} _
      * @param {any} translations
      * @param {string} subfolder
-     * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu
+     * @param {(MenuItem | 'categories' | 'tags' | 'toptags')[]} menu
      * @returns {NavPage[]}
      */
-    footer(currentUrl: URL, _: TranslationProvider, translations: any, subfolder: string, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): NavPage[];
+    footer(currentUrl: URL, _: TranslationProvider, translations: any, subfolder: string, menu: (MenuItem | 'categories' | 'tags' | 'toptags')[]): NavPage[];
     /**
      *
      * @param {TaxonomyLinks} links
@@ -115,3 +108,4 @@ 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

@@ -6,8 +6,17 @@ import * as PostFiltering from '../postFiltering.mjs';
  * @typedef { import("./urls.mjs").UrlFormatter } UrlFormatter
  * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
  * @typedef { import("../../types/NavPage").NavPage } NavPage
+ * @typedef { import("../../types/NavPage").MenuItem } MenuItem
  */
 
+const defaults = {
+    url: '',
+    ariaCurrent: false,
+    isOpen: false,
+    section: '',
+    children: []
+}
+
 export class Navigation {
     /**
      * Constructor
@@ -64,7 +73,7 @@ export class Navigation {
      * 
      * @param {URL} currentUrl 
      * @param {string} subfolder
-     * @param {(NavPage | 'auto')[]} menu
+     * @param {(MenuItem | 'auto')[]} menu
      * @returns {NavPage[]}
      */
     menu(currentUrl, subfolder, menu) {
@@ -72,7 +81,7 @@ export class Navigation {
         for (let i = 0; i < menu.length; i++) {
             const item = menu[i];
             if (this.isNavPage(item)) {
-                pages.push(item);
+                pages.push({ ...defaults, ...item });
             } else {
                 const p = this.autoMenu(subfolder);
                 for (let j = 0; j < p.length; j++) {
@@ -155,7 +164,7 @@ export class Navigation {
      * @param {TranslationProvider} _ 
      * @param {any} translations 
      * @param {string} subfolder 
-     * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu 
+     * @param {(MenuItem | 'categories' | 'tags' | 'toptags')[]} menu 
      * @returns {NavPage[]}
      */
     footer(currentUrl, _, translations, subfolder, menu) {
@@ -174,7 +183,7 @@ export class Navigation {
         for (let i = 0; i < menu.length; i++) {
             const item = menu[i];
             if (this.isNavPage(item)) {
-                pages.push(item);
+                pages.push({ ...defaults, ...item });
             } else {
                 switch (item) {
                     case 'tags':

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.2.39",
+  "version": "0.3.0",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",
+  "packageManager": "pnpm@8.7.0",
   "files": [
     "index.mjs",
     "index.d.mts",

package/types/NavPage.d.ts

@@ -9,3 +9,14 @@ export interface NavPage {
     children: NavPage[];
     rel?: string;
 }
+export interface MenuItem {
+    title: string;
+    order: number;
+    isOpen?: boolean;
+    ariaCurrent?: 'page' | false;
+    fullTitle?: string;
+    children?: MenuItem[];
+    section?: string;
+    url?: string;
+    rel?: string;
+}