astro-accelerator-utils 0.3.6 → 0.3.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -201
- package/README.md +19 -19
- package/index.d.mts +4 -4
- package/index.mjs +9 -9
- package/lib/postFiltering.d.mts +48 -48
- package/lib/postFiltering.mjs +116 -116
- package/lib/postOrdering.d.mts +32 -32
- package/lib/postOrdering.mjs +51 -51
- package/lib/v1/accelerator.d.mts +36 -36
- package/lib/v1/accelerator.mjs +70 -70
- package/lib/v1/authors.d.mts +28 -28
- package/lib/v1/authors.mjs +71 -71
- package/lib/v1/cache.d.mts +43 -43
- package/lib/v1/cache.mjs +99 -99
- package/lib/v1/dates.d.mts +19 -19
- package/lib/v1/dates.mjs +26 -26
- package/lib/v1/markdown.d.mts +20 -20
- package/lib/v1/markdown.mjs +45 -45
- package/lib/v1/navigation.d.mts +111 -111
- package/lib/v1/navigation.mjs +446 -427
- package/lib/v1/paging.d.mts +15 -15
- package/lib/v1/paging.mjs +77 -77
- package/lib/v1/posts.d.mts +26 -26
- package/lib/v1/posts.mjs +47 -47
- package/lib/v1/statistics-stub.d.mts +5 -5
- package/lib/v1/statistics-stub.mjs +9 -9
- package/lib/v1/statistics.d.mts +39 -39
- package/lib/v1/statistics.mjs +78 -78
- package/lib/v1/taxonomy.d.mts +62 -62
- package/lib/v1/taxonomy.mjs +144 -144
- package/lib/v1/urls.d.mts +40 -40
- package/lib/v1/urls.mjs +104 -104
- package/package.json +3 -3
- package/types/Astro.d.ts +19 -19
- package/types/AuthorList.d.ts +8 -8
- package/types/BannerImage.d.ts +4 -4
- package/types/Frontmatter.d.ts +30 -30
- package/types/Link.d.ts +6 -6
- package/types/NavPage.d.ts +22 -22
- package/types/PagePredicate.d.ts +2 -2
- package/types/Site.d.ts +43 -43
- package/types/Taxonomy.d.ts +15 -15
package/lib/v1/navigation.d.mts
CHANGED
|
@@ -1,111 +1,111 @@
|
|
|
1
|
-
export class Navigation {
|
|
2
|
-
/**
|
|
3
|
-
* Constructor
|
|
4
|
-
* @param {Posts} posts
|
|
5
|
-
* @param {UrlFormatter} urlFormatter
|
|
6
|
-
* @param {Taxonomy} taxonomy
|
|
7
|
-
*/
|
|
8
|
-
constructor(posts: Posts, urlFormatter: UrlFormatter, taxonomy: Taxonomy);
|
|
9
|
-
posts: import("./posts.mjs").Posts;
|
|
10
|
-
urlFormatter: import("./urls.mjs").UrlFormatter;
|
|
11
|
-
taxonomy: import("./taxonomy.mjs").Taxonomy;
|
|
12
|
-
/**
|
|
13
|
-
* Returns a list of breadcrumbs
|
|
14
|
-
* @param {URL} currentUrl
|
|
15
|
-
* @param {string} subfolder
|
|
16
|
-
* @param {number} customCount
|
|
17
|
-
* @returns {NavPage[]}
|
|
18
|
-
*/
|
|
19
|
-
breadcrumbs(currentUrl: URL, subfolder: string, customCount: number): NavPage[];
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @param {URL} currentUrl
|
|
23
|
-
* @param {string} subfolder
|
|
24
|
-
* @param {(MenuItem | 'auto')[]} menu
|
|
25
|
-
* @returns {NavPage[]}
|
|
26
|
-
*/
|
|
27
|
-
menu(currentUrl: URL, subfolder: string, menu: (MenuItem | 'auto')[]): NavPage[];
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @param {NavPage} page
|
|
31
|
-
* @param {NavPage[]} pageList
|
|
32
|
-
*/
|
|
33
|
-
getChildren(page: NavPage, pageList: NavPage[]): import("../../types/NavPage").NavPage[];
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @param {string} subfolder
|
|
37
|
-
* @returns {NavPage[]}
|
|
38
|
-
*/
|
|
39
|
-
autoMenu(subfolder: string): NavPage[];
|
|
40
|
-
/**
|
|
41
|
-
*
|
|
42
|
-
* @param {URL} currentUrl
|
|
43
|
-
* @param {TranslationProvider} _
|
|
44
|
-
* @param {any} translations
|
|
45
|
-
* @param {string} subfolder
|
|
46
|
-
* @param {(MenuItem | 'categories' | 'tags' | 'toptags')[]} menu
|
|
47
|
-
* @returns {NavPage[]}
|
|
48
|
-
*/
|
|
49
|
-
footer(currentUrl: URL, _: TranslationProvider, translations: any, subfolder: string, menu: (MenuItem | 'categories' | 'tags' | 'toptags')[]): NavPage[];
|
|
50
|
-
/**
|
|
51
|
-
*
|
|
52
|
-
* @param {TaxonomyLinks} links
|
|
53
|
-
* @param {TranslationProvider} _
|
|
54
|
-
* @param {any} translations
|
|
55
|
-
* @param {string} subfolder
|
|
56
|
-
* @param {TaxonomyList} entries
|
|
57
|
-
* @returns {NavPage[]}
|
|
58
|
-
*/
|
|
59
|
-
getCategories(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @param {TaxonomyLinks} links
|
|
63
|
-
* @param {TranslationProvider} _
|
|
64
|
-
* @param {any} translations
|
|
65
|
-
* @param {string} subfolder
|
|
66
|
-
* @param {TaxonomyList} entries
|
|
67
|
-
* @returns {NavPage[]}
|
|
68
|
-
*/
|
|
69
|
-
getTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
|
|
70
|
-
/**
|
|
71
|
-
*
|
|
72
|
-
* @param {TaxonomyLinks} links
|
|
73
|
-
* @param {TranslationProvider} _
|
|
74
|
-
* @param {any} translations
|
|
75
|
-
* @param {string} subfolder
|
|
76
|
-
* @param {TaxonomyList} entries
|
|
77
|
-
* @returns {NavPage[]}
|
|
78
|
-
*/
|
|
79
|
-
getTopTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
|
|
80
|
-
/**
|
|
81
|
-
* Walks a NavPage tree to set current page
|
|
82
|
-
* @param {NavPage[]} pages
|
|
83
|
-
* @param {URL} currentUrl
|
|
84
|
-
*/
|
|
85
|
-
setCurrentPage(pages: NavPage[], currentUrl: URL): void;
|
|
86
|
-
/**
|
|
87
|
-
* Converts a MarkdownInstance into a NavPage
|
|
88
|
-
* @param {MarkdownInstance} page
|
|
89
|
-
* @returns {NavPage}
|
|
90
|
-
*/
|
|
91
|
-
mapNavPage(page: MarkdownInstance): NavPage;
|
|
92
|
-
/**
|
|
93
|
-
* Checks whether the item is a NavPage
|
|
94
|
-
* @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item
|
|
95
|
-
* @returns {item is NavPage}
|
|
96
|
-
*/
|
|
97
|
-
isNavPage(item: NavPage | 'auto' | 'tags' | 'toptags' | 'categories'): item is import("../../types/NavPage").NavPage;
|
|
98
|
-
/**
|
|
99
|
-
* Pops matching page from array
|
|
100
|
-
* @param {MarkdownInstance[]} allPages
|
|
101
|
-
* @param {string} search
|
|
102
|
-
* @returns
|
|
103
|
-
*/
|
|
104
|
-
popMatchingPage(allPages: MarkdownInstance[], search: string): import("../../types/Astro").MarkdownInstance;
|
|
105
|
-
}
|
|
106
|
-
export type Posts = import("./posts.mjs").Posts;
|
|
107
|
-
export type Taxonomy = import("./taxonomy.mjs").Taxonomy;
|
|
108
|
-
export type UrlFormatter = import("./urls.mjs").UrlFormatter;
|
|
109
|
-
export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
|
|
110
|
-
export type NavPage = import("../../types/NavPage").NavPage;
|
|
111
|
-
export type MenuItem = import("../../types/NavPage").MenuItem;
|
|
1
|
+
export class Navigation {
|
|
2
|
+
/**
|
|
3
|
+
* Constructor
|
|
4
|
+
* @param {Posts} posts
|
|
5
|
+
* @param {UrlFormatter} urlFormatter
|
|
6
|
+
* @param {Taxonomy} taxonomy
|
|
7
|
+
*/
|
|
8
|
+
constructor(posts: Posts, urlFormatter: UrlFormatter, taxonomy: Taxonomy);
|
|
9
|
+
posts: import("./posts.mjs").Posts;
|
|
10
|
+
urlFormatter: import("./urls.mjs").UrlFormatter;
|
|
11
|
+
taxonomy: import("./taxonomy.mjs").Taxonomy;
|
|
12
|
+
/**
|
|
13
|
+
* Returns a list of breadcrumbs
|
|
14
|
+
* @param {URL} currentUrl
|
|
15
|
+
* @param {string} subfolder
|
|
16
|
+
* @param {number} customCount
|
|
17
|
+
* @returns {NavPage[]}
|
|
18
|
+
*/
|
|
19
|
+
breadcrumbs(currentUrl: URL, subfolder: string, customCount: number): NavPage[];
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @param {URL} currentUrl
|
|
23
|
+
* @param {string} subfolder
|
|
24
|
+
* @param {(MenuItem | 'auto')[]} menu
|
|
25
|
+
* @returns {NavPage[]}
|
|
26
|
+
*/
|
|
27
|
+
menu(currentUrl: URL, subfolder: string, menu: (MenuItem | 'auto')[]): NavPage[];
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @param {NavPage} page
|
|
31
|
+
* @param {NavPage[]} pageList
|
|
32
|
+
*/
|
|
33
|
+
getChildren(page: NavPage, pageList: NavPage[]): import("../../types/NavPage").NavPage[];
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @param {string} subfolder
|
|
37
|
+
* @returns {NavPage[]}
|
|
38
|
+
*/
|
|
39
|
+
autoMenu(subfolder: string): NavPage[];
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @param {URL} currentUrl
|
|
43
|
+
* @param {TranslationProvider} _
|
|
44
|
+
* @param {any} translations
|
|
45
|
+
* @param {string} subfolder
|
|
46
|
+
* @param {(MenuItem | 'categories' | 'tags' | 'toptags')[]} menu
|
|
47
|
+
* @returns {NavPage[]}
|
|
48
|
+
*/
|
|
49
|
+
footer(currentUrl: URL, _: TranslationProvider, translations: any, subfolder: string, menu: (MenuItem | 'categories' | 'tags' | 'toptags')[]): NavPage[];
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @param {TaxonomyLinks} links
|
|
53
|
+
* @param {TranslationProvider} _
|
|
54
|
+
* @param {any} translations
|
|
55
|
+
* @param {string} subfolder
|
|
56
|
+
* @param {TaxonomyList} entries
|
|
57
|
+
* @returns {NavPage[]}
|
|
58
|
+
*/
|
|
59
|
+
getCategories(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @param {TaxonomyLinks} links
|
|
63
|
+
* @param {TranslationProvider} _
|
|
64
|
+
* @param {any} translations
|
|
65
|
+
* @param {string} subfolder
|
|
66
|
+
* @param {TaxonomyList} entries
|
|
67
|
+
* @returns {NavPage[]}
|
|
68
|
+
*/
|
|
69
|
+
getTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @param {TaxonomyLinks} links
|
|
73
|
+
* @param {TranslationProvider} _
|
|
74
|
+
* @param {any} translations
|
|
75
|
+
* @param {string} subfolder
|
|
76
|
+
* @param {TaxonomyList} entries
|
|
77
|
+
* @returns {NavPage[]}
|
|
78
|
+
*/
|
|
79
|
+
getTopTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
|
|
80
|
+
/**
|
|
81
|
+
* Walks a NavPage tree to set current page
|
|
82
|
+
* @param {NavPage[]} pages
|
|
83
|
+
* @param {URL} currentUrl
|
|
84
|
+
*/
|
|
85
|
+
setCurrentPage(pages: NavPage[], currentUrl: URL): void;
|
|
86
|
+
/**
|
|
87
|
+
* Converts a MarkdownInstance into a NavPage
|
|
88
|
+
* @param {MarkdownInstance} page
|
|
89
|
+
* @returns {NavPage}
|
|
90
|
+
*/
|
|
91
|
+
mapNavPage(page: MarkdownInstance): NavPage;
|
|
92
|
+
/**
|
|
93
|
+
* Checks whether the item is a NavPage
|
|
94
|
+
* @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item
|
|
95
|
+
* @returns {item is NavPage}
|
|
96
|
+
*/
|
|
97
|
+
isNavPage(item: NavPage | 'auto' | 'tags' | 'toptags' | 'categories'): item is import("../../types/NavPage").NavPage;
|
|
98
|
+
/**
|
|
99
|
+
* Pops matching page from array
|
|
100
|
+
* @param {MarkdownInstance[]} allPages
|
|
101
|
+
* @param {string} search
|
|
102
|
+
* @returns
|
|
103
|
+
*/
|
|
104
|
+
popMatchingPage(allPages: MarkdownInstance[], search: string): import("../../types/Astro").MarkdownInstance;
|
|
105
|
+
}
|
|
106
|
+
export type Posts = import("./posts.mjs").Posts;
|
|
107
|
+
export type Taxonomy = import("./taxonomy.mjs").Taxonomy;
|
|
108
|
+
export type UrlFormatter = import("./urls.mjs").UrlFormatter;
|
|
109
|
+
export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
|
|
110
|
+
export type NavPage = import("../../types/NavPage").NavPage;
|
|
111
|
+
export type MenuItem = import("../../types/NavPage").MenuItem;
|