@xyd-js/framework 0.1.0-xyd.6 → 0.1.0-xyd.73
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 +21 -0
- package/dist/Sidebar-CdavG0uc.d.ts +23 -0
- package/dist/hydration.d.ts +9 -3
- package/dist/hydration.js +189 -191
- package/dist/hydration.js.map +1 -1
- package/dist/index.d.ts +22 -4
- package/dist/index.js +34 -15
- package/dist/index.js.map +1 -1
- package/dist/react.d.ts +49 -9
- package/dist/react.js +446 -528
- package/dist/react.js.map +1 -1
- package/package.json +19 -16
- package/dist/hydration.d.mts +0 -11
- package/dist/hydration.mjs +0 -245
- package/dist/hydration.mjs.map +0 -1
- package/dist/index.d.mts +0 -6
- package/dist/index.mjs +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/react.d.mts +0 -32
- package/dist/react.mjs +0 -651
- package/dist/react.mjs.map +0 -1
- package/dist/sidebar-Dwf54qYp.d.mts +0 -15
- package/dist/sidebar-Dwf54qYp.d.ts +0 -15
- package/packages/hydration/README.md +0 -3
- package/packages/hydration/index.ts +0 -3
- package/packages/hydration/settings-to-props.ts +0 -325
- package/packages/react/README.md +0 -3
- package/packages/react/components/index.tsx +0 -337
- package/packages/react/components/sidebar/index.ts +0 -3
- package/packages/react/components/sidebar/sidebar-group.tsx +0 -240
- package/packages/react/components/sidebar/sidebar.tsx +0 -127
- package/packages/react/contexts/framework.tsx +0 -78
- package/packages/react/contexts/index.ts +0 -2
- package/packages/react/contexts/ui.tsx +0 -6
- package/packages/react/hooks/index.ts +0 -3
- package/packages/react/hooks/useMatchedNav.tsx +0 -29
- package/packages/react/index.ts +0 -12
- package/packages/react/utils/manualHydration.ts +0 -25
- package/packages/theme/context.tsx +0 -19
- package/packages/theme/index.ts +0 -0
- package/postcss.config.cjs +0 -5
- package/src/index.ts +0 -1
- package/src/types.ts +0 -5
- package/tsconfig.json +0 -45
- package/tsup.config.ts +0 -28
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 xyd
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Metadata } from '@xyd-js/core';
|
|
2
|
+
|
|
3
|
+
interface FwSidebarGroupProps {
|
|
4
|
+
group: string;
|
|
5
|
+
groupIndex: number;
|
|
6
|
+
items: FwSidebarItemProps[];
|
|
7
|
+
icon?: string;
|
|
8
|
+
}
|
|
9
|
+
interface FwSidebarItemProps {
|
|
10
|
+
title: string;
|
|
11
|
+
href: string;
|
|
12
|
+
uniqIndex: number;
|
|
13
|
+
icon?: string;
|
|
14
|
+
sidebarTitle?: string;
|
|
15
|
+
items?: FwSidebarItemProps[];
|
|
16
|
+
active?: boolean;
|
|
17
|
+
readonly level?: number;
|
|
18
|
+
readonly groupIndex?: number;
|
|
19
|
+
readonly itemIndex?: number;
|
|
20
|
+
readonly pageMeta?: Metadata;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export type { FwSidebarGroupProps as F };
|
package/dist/hydration.d.ts
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
|
-
import { Settings } from '@xyd-js/core';
|
|
1
|
+
import { Settings, MetadataMap, Metadata } from '@xyd-js/core';
|
|
2
2
|
import { IBreadcrumb, INavLinks } from '@xyd-js/ui';
|
|
3
|
-
import { F as FwSidebarGroupProps } from './
|
|
3
|
+
import { F as FwSidebarGroupProps } from './Sidebar-CdavG0uc.js';
|
|
4
4
|
|
|
5
|
-
declare function mapSettingsToProps(settings: Settings,
|
|
5
|
+
declare function mapSettingsToProps(settings: Settings, pagePathMapping: {
|
|
6
|
+
[key: string]: string;
|
|
7
|
+
}, slug: string, frontmatters?: MetadataMap): Promise<{
|
|
6
8
|
groups: FwSidebarGroupProps[];
|
|
7
9
|
breadcrumbs: IBreadcrumb[];
|
|
8
10
|
navlinks?: INavLinks;
|
|
11
|
+
hiddenPages?: {
|
|
12
|
+
[key: string]: boolean;
|
|
13
|
+
};
|
|
14
|
+
metadata?: Metadata | null;
|
|
9
15
|
}>;
|
|
10
16
|
|
|
11
17
|
export { mapSettingsToProps };
|
package/dist/hydration.js
CHANGED
|
@@ -1,91 +1,28 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
var __export = (target, all) => {
|
|
6
|
-
for (var name in all)
|
|
7
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
8
|
-
};
|
|
9
|
-
var __copyProps = (to, from, except, desc) => {
|
|
10
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
|
11
|
-
for (let key of __getOwnPropNames(from))
|
|
12
|
-
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
13
|
-
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
14
|
-
}
|
|
15
|
-
return to;
|
|
16
|
-
};
|
|
17
|
-
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
18
|
-
|
|
19
|
-
// packages/hydration/index.ts
|
|
20
|
-
var hydration_exports = {};
|
|
21
|
-
__export(hydration_exports, {
|
|
22
|
-
mapSettingsToProps: () => mapSettingsToProps
|
|
23
|
-
});
|
|
24
|
-
module.exports = __toCommonJS(hydration_exports);
|
|
25
|
-
|
|
26
|
-
// packages/hydration/settings-to-props.ts
|
|
27
|
-
var import_navigation = require("@xyd-js/content/navigation");
|
|
28
|
-
function filterNavigation(settings, slug) {
|
|
29
|
-
var _a;
|
|
30
|
-
const sidebarItems = [];
|
|
31
|
-
let multiSidebarMatch = null;
|
|
32
|
-
(_a = settings == null ? void 0 : settings.structure) == null ? void 0 : _a.sidebar.filter((sidebar) => {
|
|
33
|
-
var _a2;
|
|
34
|
-
if ("match" in sidebar) {
|
|
35
|
-
const sideMatch = normalizeHref(sidebar.match);
|
|
36
|
-
const normalizeSlug = normalizeHref(slug);
|
|
37
|
-
if (normalizeSlug.startsWith(sideMatch)) {
|
|
38
|
-
if (multiSidebarMatch) {
|
|
39
|
-
const findByMatchLvl = multiSidebarMatch.match.split("/").length;
|
|
40
|
-
const urlMatchLvl = sideMatch.split("/").length;
|
|
41
|
-
if (urlMatchLvl > findByMatchLvl) {
|
|
42
|
-
multiSidebarMatch = sidebar;
|
|
43
|
-
}
|
|
44
|
-
} else {
|
|
45
|
-
multiSidebarMatch = sidebar;
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
return;
|
|
49
|
-
}
|
|
50
|
-
const ok = (0, import_navigation.filterNavigationByLevels)(((_a2 = settings == null ? void 0 : settings.structure) == null ? void 0 : _a2.header) || [], slug)(sidebar);
|
|
51
|
-
if (ok) {
|
|
52
|
-
sidebarItems.push(sidebar);
|
|
53
|
-
}
|
|
54
|
-
});
|
|
55
|
-
if (multiSidebarMatch != null) {
|
|
56
|
-
const side = multiSidebarMatch;
|
|
57
|
-
sidebarItems.push(...side.items);
|
|
58
|
-
}
|
|
59
|
-
return sidebarItems;
|
|
60
|
-
}
|
|
61
|
-
function normalizeHrefCheck(first, second) {
|
|
62
|
-
if (first.startsWith("/")) {
|
|
63
|
-
first = first.slice(1);
|
|
64
|
-
}
|
|
65
|
-
if (second.startsWith("/")) {
|
|
66
|
-
second = second.slice(1);
|
|
67
|
-
}
|
|
68
|
-
return first === second;
|
|
69
|
-
}
|
|
70
|
-
function normalizeHref(href) {
|
|
71
|
-
if (href.startsWith("/")) {
|
|
72
|
-
return href;
|
|
73
|
-
}
|
|
74
|
-
return `/${href}`;
|
|
75
|
-
}
|
|
76
|
-
function safePageLink(page) {
|
|
77
|
-
return (page == null ? void 0 : page.startsWith("/")) ? page : `/${page}`;
|
|
78
|
-
}
|
|
79
|
-
async function mapSettingsToProps(settings, slug) {
|
|
1
|
+
// packages/hydration/mapSettingsToProps.ts
|
|
2
|
+
import { pageFrontMatters } from "@xyd-js/content";
|
|
3
|
+
async function mapSettingsToProps(settings, pagePathMapping, slug, frontmatters) {
|
|
4
|
+
let uniqIndex = 0;
|
|
80
5
|
const filteredNav = filterNavigation(settings, slug);
|
|
81
|
-
|
|
6
|
+
if (!frontmatters) {
|
|
7
|
+
frontmatters = await pageFrontMatters(filteredNav, pagePathMapping);
|
|
8
|
+
}
|
|
82
9
|
const slugFrontmatter = frontmatters[slug] || null;
|
|
83
10
|
const breadcrumbs = [];
|
|
84
11
|
let navlinks = void 0;
|
|
12
|
+
const hiddenPages = Object.keys(frontmatters).reduce((acc, page) => {
|
|
13
|
+
if (frontmatters[page].hidden) {
|
|
14
|
+
acc[page] = true;
|
|
15
|
+
}
|
|
16
|
+
return acc;
|
|
17
|
+
}, {});
|
|
85
18
|
function mapItems(page, currentNav, nav) {
|
|
86
|
-
var _a;
|
|
87
|
-
if (
|
|
88
|
-
|
|
19
|
+
var _a, _b;
|
|
20
|
+
if (!frontmatters) {
|
|
21
|
+
console.error("frontmatters not found");
|
|
22
|
+
return null;
|
|
23
|
+
}
|
|
24
|
+
if (typeof page !== "string" && !("virtual" in page)) {
|
|
25
|
+
const items = (_b = (_a = page.pages) == null ? void 0 : _a.map((p) => mapItems(p, page, nav))) == null ? void 0 : _b.filter(Boolean);
|
|
89
26
|
if (items == null ? void 0 : items.find((item) => normalizeHrefCheck(item.href, slug))) {
|
|
90
27
|
breadcrumbs.unshift({
|
|
91
28
|
title: page.group || "",
|
|
@@ -97,10 +34,21 @@ async function mapSettingsToProps(settings, slug) {
|
|
|
97
34
|
title: page.group,
|
|
98
35
|
href: "",
|
|
99
36
|
active: false,
|
|
37
|
+
uniqIndex: uniqIndex++,
|
|
38
|
+
icon: page.icon,
|
|
100
39
|
items
|
|
101
40
|
};
|
|
102
41
|
}
|
|
103
|
-
|
|
42
|
+
let pageName = "";
|
|
43
|
+
if (typeof page === "string") {
|
|
44
|
+
pageName = page;
|
|
45
|
+
} else {
|
|
46
|
+
pageName = page.page;
|
|
47
|
+
}
|
|
48
|
+
if (hiddenPages[pageName]) {
|
|
49
|
+
return null;
|
|
50
|
+
}
|
|
51
|
+
const matterTitle = frontmatters && frontmatters[pageName] && frontmatters[pageName].title;
|
|
104
52
|
let title = "";
|
|
105
53
|
if (typeof matterTitle === "string") {
|
|
106
54
|
title = matterTitle;
|
|
@@ -108,10 +56,11 @@ async function mapSettingsToProps(settings, slug) {
|
|
|
108
56
|
title = matterTitle;
|
|
109
57
|
}
|
|
110
58
|
if (!title) {
|
|
111
|
-
console.
|
|
59
|
+
console.debug(`\u26A0\uFE0F Title not found for page "${pageName}"`);
|
|
112
60
|
}
|
|
113
|
-
|
|
114
|
-
|
|
61
|
+
const meta = frontmatters[pageName];
|
|
62
|
+
if (slugFrontmatter && slugFrontmatter === meta) {
|
|
63
|
+
const nlinks = mapNavToLinks(pageName, currentNav, nav, frontmatters, hiddenPages);
|
|
115
64
|
if (nlinks) {
|
|
116
65
|
navlinks = nlinks;
|
|
117
66
|
}
|
|
@@ -125,147 +74,196 @@ async function mapSettingsToProps(settings, slug) {
|
|
|
125
74
|
breadcrumbs.push({
|
|
126
75
|
// @ts-ignore
|
|
127
76
|
title,
|
|
128
|
-
href:
|
|
77
|
+
href: pageName
|
|
129
78
|
});
|
|
130
79
|
}
|
|
131
80
|
return {
|
|
132
|
-
// @ts-ignore
|
|
133
81
|
title,
|
|
134
|
-
href: safePageLink(
|
|
135
|
-
active: false
|
|
136
|
-
|
|
82
|
+
href: safePageLink(pageName),
|
|
83
|
+
active: false,
|
|
84
|
+
uniqIndex: uniqIndex++,
|
|
85
|
+
icon: (meta == null ? void 0 : meta.icon) || "",
|
|
86
|
+
sidebarTitle: (meta == null ? void 0 : meta.sidebarTitle) || "",
|
|
87
|
+
pageMeta: meta || null
|
|
137
88
|
};
|
|
138
89
|
}
|
|
139
90
|
const groups = filteredNav.map((nav) => {
|
|
140
|
-
var _a;
|
|
141
|
-
if ("
|
|
91
|
+
var _a, _b, _c;
|
|
92
|
+
if ("route" in nav) {
|
|
93
|
+
if ((_a = nav.pages) == null ? void 0 : _a.length) {
|
|
94
|
+
const items2 = (((_b = nav.pages) == null ? void 0 : _b.map((p) => mapItems(p, nav, filteredNav))) || []).filter(Boolean);
|
|
95
|
+
return {
|
|
96
|
+
items: items2
|
|
97
|
+
};
|
|
98
|
+
}
|
|
142
99
|
return {
|
|
143
100
|
group: "",
|
|
144
|
-
items: []
|
|
101
|
+
items: [],
|
|
102
|
+
groupIndex: 0
|
|
145
103
|
};
|
|
146
104
|
}
|
|
105
|
+
const items = (((_c = nav.pages) == null ? void 0 : _c.map((p) => mapItems(p, nav, filteredNav))) || []).filter(Boolean);
|
|
147
106
|
return {
|
|
148
107
|
group: nav.group,
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
})) || []
|
|
108
|
+
icon: nav == null ? void 0 : nav.icon,
|
|
109
|
+
items
|
|
152
110
|
};
|
|
153
111
|
}) || [];
|
|
154
112
|
return {
|
|
155
113
|
groups,
|
|
156
114
|
breadcrumbs,
|
|
157
|
-
navlinks
|
|
115
|
+
navlinks,
|
|
116
|
+
hiddenPages,
|
|
117
|
+
metadata: slugFrontmatter
|
|
158
118
|
};
|
|
159
119
|
}
|
|
160
|
-
function
|
|
161
|
-
var _a, _b
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
120
|
+
function filterNavigation(settings, slug) {
|
|
121
|
+
var _a, _b;
|
|
122
|
+
const sidebarItems = [];
|
|
123
|
+
let multiSidebarMatch = null;
|
|
124
|
+
let flatPagesOnly = false;
|
|
125
|
+
let foundRoute = false;
|
|
126
|
+
function findRoute(sidebar) {
|
|
127
|
+
var _a2;
|
|
128
|
+
if ("route" in sidebar) {
|
|
129
|
+
const sideMatch = normalizeHref(sidebar.route);
|
|
130
|
+
const normalizeSlug = normalizeHref(slug);
|
|
131
|
+
if (normalizeSlug.startsWith(sideMatch)) {
|
|
132
|
+
if (multiSidebarMatch) {
|
|
133
|
+
const findByMatchLvl = multiSidebarMatch.route.split("/").length;
|
|
134
|
+
const urlMatchLvl = sideMatch.split("/").length;
|
|
135
|
+
if (urlMatchLvl > findByMatchLvl) {
|
|
136
|
+
if (!foundRoute) {
|
|
137
|
+
foundRoute = true;
|
|
138
|
+
sidebarItems.length = 0;
|
|
139
|
+
}
|
|
140
|
+
multiSidebarMatch = sidebar;
|
|
141
|
+
}
|
|
142
|
+
} else {
|
|
143
|
+
if (!foundRoute) {
|
|
144
|
+
foundRoute = true;
|
|
145
|
+
sidebarItems.length = 0;
|
|
146
|
+
}
|
|
147
|
+
multiSidebarMatch = sidebar;
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
if ("pages" in sidebar && ((_a2 = sidebar.pages) == null ? void 0 : _a2.length)) {
|
|
151
|
+
for (const page of sidebar.pages) {
|
|
152
|
+
findRoute(page);
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
}
|
|
169
156
|
return;
|
|
170
157
|
}
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
if (prev && next) {
|
|
174
|
-
if (typeof prev !== "string" || typeof next !== "string") {
|
|
175
|
-
console.error("currently nested pages for navlinks are not supported (step 1)");
|
|
158
|
+
(_a = settings == null ? void 0 : settings.navigation) == null ? void 0 : _a.sidebar.filter((sidebar) => {
|
|
159
|
+
if (flatPagesOnly) {
|
|
176
160
|
return;
|
|
177
161
|
}
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
162
|
+
if (typeof sidebar === "string") {
|
|
163
|
+
flatPagesOnly = true;
|
|
164
|
+
return;
|
|
165
|
+
}
|
|
166
|
+
if ("route" in sidebar) {
|
|
167
|
+
findRoute(sidebar);
|
|
168
|
+
return;
|
|
169
|
+
}
|
|
170
|
+
if (foundRoute) {
|
|
171
|
+
return;
|
|
172
|
+
}
|
|
173
|
+
sidebarItems.push(sidebar);
|
|
174
|
+
});
|
|
175
|
+
if (multiSidebarMatch != null) {
|
|
176
|
+
const side = multiSidebarMatch;
|
|
177
|
+
sidebarItems.push(...(side == null ? void 0 : side.pages) || []);
|
|
192
178
|
}
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
179
|
+
if (flatPagesOnly) {
|
|
180
|
+
sidebarItems.push({
|
|
181
|
+
pages: (_b = settings == null ? void 0 : settings.navigation) == null ? void 0 : _b.sidebar
|
|
182
|
+
});
|
|
197
183
|
}
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
console.error("currently nested pages for navlinks are not supported (step 2)");
|
|
204
|
-
} else {
|
|
205
|
-
prev = prevNavLastPge;
|
|
206
|
-
}
|
|
207
|
-
}
|
|
184
|
+
return sidebarItems;
|
|
185
|
+
}
|
|
186
|
+
function normalizeHrefCheck(first, second) {
|
|
187
|
+
if (first.startsWith("/")) {
|
|
188
|
+
first = first.slice(1);
|
|
208
189
|
}
|
|
209
|
-
if (
|
|
210
|
-
|
|
211
|
-
if (nextNav) {
|
|
212
|
-
const nextNavFirstPage = (_g = nextNav == null ? void 0 : nextNav.pages) == null ? void 0 : _g[0];
|
|
213
|
-
if (typeof nextNavFirstPage != "string") {
|
|
214
|
-
console.error("currently nested pages for navlinks are not supported (step 3)");
|
|
215
|
-
} else {
|
|
216
|
-
next = nextNavFirstPage;
|
|
217
|
-
}
|
|
218
|
-
}
|
|
190
|
+
if (second.startsWith("/")) {
|
|
191
|
+
second = second.slice(1);
|
|
219
192
|
}
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
193
|
+
return first === second;
|
|
194
|
+
}
|
|
195
|
+
function normalizeHref(href) {
|
|
196
|
+
if (href.startsWith("/")) {
|
|
197
|
+
return href;
|
|
198
|
+
}
|
|
199
|
+
return `/${href}`;
|
|
200
|
+
}
|
|
201
|
+
function safePageLink(page) {
|
|
202
|
+
return (page == null ? void 0 : page.startsWith("/")) ? page : `/${page}`;
|
|
203
|
+
}
|
|
204
|
+
function mapNavToLinks(page, currentNav, nav, frontmatters, hiddenPages) {
|
|
205
|
+
var _a, _b;
|
|
206
|
+
if (!currentNav.group) {
|
|
207
|
+
console.debug("current nav need group to calculate navlinks");
|
|
208
|
+
return;
|
|
209
|
+
}
|
|
210
|
+
const allPages = [];
|
|
211
|
+
nav.forEach((group, groupIndex) => {
|
|
212
|
+
if (group.pages) {
|
|
213
|
+
group.pages.forEach((pageItem, pageIndex) => {
|
|
214
|
+
let pageName = "";
|
|
215
|
+
if (typeof pageItem === "string") {
|
|
216
|
+
pageName = pageItem;
|
|
217
|
+
} else if ("virtual" in pageItem) {
|
|
218
|
+
pageName = pageItem.page;
|
|
219
|
+
} else if ("pages" in pageItem) {
|
|
220
|
+
return;
|
|
221
|
+
} else if ("page" in pageItem && typeof pageItem === "object") {
|
|
222
|
+
pageName = pageItem.page;
|
|
228
223
|
}
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
224
|
+
if (pageName && !hiddenPages[pageName]) {
|
|
225
|
+
allPages.push({
|
|
226
|
+
page: pageName,
|
|
227
|
+
group: group.group || "",
|
|
228
|
+
groupIndex,
|
|
229
|
+
pageIndex
|
|
230
|
+
});
|
|
231
|
+
}
|
|
232
|
+
});
|
|
232
233
|
}
|
|
234
|
+
});
|
|
235
|
+
const currentPageIndex = allPages.findIndex((p) => p.page === page);
|
|
236
|
+
if (currentPageIndex === -1) {
|
|
237
|
+
return void 0;
|
|
233
238
|
}
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
239
|
+
const prevPage = allPages[currentPageIndex - 1];
|
|
240
|
+
const nextPage = allPages[currentPageIndex + 1];
|
|
241
|
+
let prevLink;
|
|
242
|
+
let nextLink;
|
|
243
|
+
if (prevPage) {
|
|
244
|
+
const prevTitle = ((_a = frontmatters[prevPage.page]) == null ? void 0 : _a.title) || prevPage.page;
|
|
245
|
+
if (typeof prevTitle === "string") {
|
|
246
|
+
prevLink = {
|
|
247
|
+
title: prevTitle,
|
|
248
|
+
href: safePageLink(prevPage.page)
|
|
243
249
|
};
|
|
244
|
-
} else {
|
|
245
|
-
console.error("currently nested pages for navlinks are not supported (step 5)");
|
|
246
250
|
}
|
|
247
251
|
}
|
|
248
|
-
if (
|
|
249
|
-
|
|
250
|
-
|
|
252
|
+
if (nextPage) {
|
|
253
|
+
const nextTitle = ((_b = frontmatters[nextPage.page]) == null ? void 0 : _b.title) || nextPage.page;
|
|
254
|
+
if (typeof nextTitle === "string") {
|
|
255
|
+
nextLink = {
|
|
256
|
+
title: nextTitle,
|
|
257
|
+
href: safePageLink(nextPage.page)
|
|
258
|
+
};
|
|
259
|
+
}
|
|
251
260
|
}
|
|
252
|
-
const prevTitle = ((_j = frontmatters[prev]) == null ? void 0 : _j.title) || "";
|
|
253
|
-
const nextTitle = ((_k = frontmatters[next]) == null ? void 0 : _k.title) || "";
|
|
254
261
|
return {
|
|
255
|
-
prev:
|
|
256
|
-
|
|
257
|
-
title: prevTitle,
|
|
258
|
-
href: safePageLink(prev)
|
|
259
|
-
},
|
|
260
|
-
next: {
|
|
261
|
-
// @ts-ignore
|
|
262
|
-
title: nextTitle,
|
|
263
|
-
href: safePageLink(next)
|
|
264
|
-
}
|
|
262
|
+
prev: prevLink || void 0,
|
|
263
|
+
next: nextLink || void 0
|
|
265
264
|
};
|
|
266
265
|
}
|
|
267
|
-
|
|
268
|
-
0 && (module.exports = {
|
|
266
|
+
export {
|
|
269
267
|
mapSettingsToProps
|
|
270
|
-
}
|
|
268
|
+
};
|
|
271
269
|
//# sourceMappingURL=hydration.js.map
|
package/dist/hydration.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../packages/hydration/index.ts","../packages/hydration/settings-to-props.ts"],"sourcesContent":["export {\n mapSettingsToProps\n} from \"./settings-to-props\"","// server-only\n\nimport {Sidebar, PageFrontMatter, Settings, SidebarMulti} from \"@xyd-js/core\";\nimport {filterNavigationByLevels, pageFrontMatters} from \"@xyd-js/content/navigation\";\nimport {IBreadcrumb, INavLinks} from \"@xyd-js/ui\";\n\nimport {FwSidebarGroupProps} from \"../react\";\n\n// TODO: framework vs content responsibility\n\nfunction filterNavigation(settings: Settings, slug: string): Sidebar[] {\n const sidebarItems: Sidebar[] = []\n\n let multiSidebarMatch: SidebarMulti | null = null\n\n settings?.structure?.sidebar.filter(sidebar => {\n if (\"match\" in sidebar) {\n const sideMatch = normalizeHref(sidebar.match)\n const normalizeSlug = normalizeHref(slug)\n\n // TODO: startWith is not enough e.g `/docs/apps/buildISSUE` if `/docs/apps/build`\n if (normalizeSlug.startsWith(sideMatch)) {\n if (multiSidebarMatch) {\n const findByMatchLvl = multiSidebarMatch.match.split(\"/\").length\n const urlMatchLvl = sideMatch.split(\"/\").length\n\n if (urlMatchLvl > findByMatchLvl) {\n multiSidebarMatch = sidebar\n }\n } else {\n multiSidebarMatch = sidebar\n }\n }\n\n return\n }\n\n // TODO: better algorithm\n const ok = filterNavigationByLevels(settings?.structure?.header || [], slug)(sidebar)\n\n if (ok) {\n sidebarItems.push(sidebar)\n }\n })\n\n if (multiSidebarMatch != null) {\n const side = multiSidebarMatch as SidebarMulti\n sidebarItems.push(...side.items)\n }\n\n return sidebarItems\n}\n\n// TODO: rename this because it's no longer 'navigation' because it returns breadcrumbs, sidebar and nextlinks props\n// TODO: breadcrumbs and frontmatters as content plugins?\n// TODO: idea - calculate breadcrumbs and navlinks near server-side component?\n\nfunction normalizeHrefCheck(first: string, second: string) {\n if (first.startsWith(\"/\")) {\n first = first.slice(1)\n }\n\n if (second.startsWith(\"/\")) {\n second = second.slice(1)\n }\n\n return first === second\n}\n\nfunction normalizeHref(href: string) {\n if (href.startsWith(\"/\")) {\n return href\n }\n\n return `/${href}`\n}\n\nfunction safePageLink(page: string): string {\n return page?.startsWith(\"/\") ? page : `/${page}`\n}\n\n// mapNavigationToProps maps @xyd-js/core navigation into @xyd-js/ui props\nexport async function mapSettingsToProps(\n settings: Settings,\n slug: string\n): Promise<{\n groups: FwSidebarGroupProps[],\n breadcrumbs: IBreadcrumb[]\n navlinks?: INavLinks\n}> {\n const filteredNav = filterNavigation(settings, slug)\n const frontmatters = await pageFrontMatters(filteredNav)\n\n const slugFrontmatter = frontmatters[slug] || null\n const breadcrumbs: IBreadcrumb[] = []\n let navlinks: INavLinks | undefined = undefined\n\n function mapItems(\n page: string | Sidebar,\n currentNav: Sidebar,\n nav: Sidebar[]\n ) {\n if (typeof page !== \"string\") {\n const items = page.pages?.map((p) => mapItems(p, page, nav))\n\n if (items?.find(item => normalizeHrefCheck(item.href, slug))) {\n breadcrumbs.unshift({\n title: page.group || \"\",\n href: \"\", // TODO:\n })\n }\n\n return {\n title: page.group,\n href: \"\",\n active: false,\n items,\n }\n }\n\n const matterTitle = frontmatters && frontmatters[page] && frontmatters[page].title\n\n let title = \"\"\n\n if (typeof matterTitle === \"string\") {\n title = matterTitle\n } else {\n // @ts-ignore\n title = matterTitle\n }\n\n if (!title) {\n console.error(\"Title not found for page\", page)\n }\n\n // TODO: better data structures - for example flat array of filtered nav\n if (slugFrontmatter && (slugFrontmatter === frontmatters[page])) {\n const nlinks = mapNavToLinks(page, currentNav, nav, frontmatters)\n\n if (nlinks) {\n navlinks = nlinks\n }\n\n if (currentNav.group) {\n breadcrumbs.push({\n title: currentNav.group,\n href: \"\", // TODO:\n })\n }\n breadcrumbs.push({\n // @ts-ignore\n title,\n href: page,\n })\n }\n\n return {\n // @ts-ignore\n title,\n href: safePageLink(page),\n active: false // TODO:\n }\n }\n\n const groups = filteredNav.map((nav) => {\n // TODO: finish\n if (\"match\" in nav) {\n return {\n group: \"\",\n items: [],\n } as FwSidebarGroupProps\n }\n\n return {\n group: nav.group,\n items: nav.pages?.map((p) => {\n // @ts-ignore\n return mapItems(p, nav, filteredNav)\n }) || [],\n } as FwSidebarGroupProps\n }) || []\n\n return {\n groups,\n breadcrumbs,\n navlinks\n }\n}\n\nfunction mapNavToLinks(\n page: string | Sidebar,\n currentNav: Sidebar,\n nav: Sidebar[],\n frontmatters: PageFrontMatter\n): INavLinks | undefined {\n if (!currentNav.group) {\n console.error(\"current nav need group to calculate navlinks\")\n return\n }\n\n const currentPageIndex = currentNav?.pages?.findIndex(p => page === p)\n const foundPageIndex = currentPageIndex != undefined && currentPageIndex !== -1\n\n if (!foundPageIndex) {\n return\n }\n\n let prev = currentNav?.pages?.[currentPageIndex - 1]\n let next = currentNav?.pages?.[currentPageIndex + 1]\n\n if (prev && next) {\n if (typeof prev !== \"string\" || typeof next !== \"string\") {\n console.error(\"currently nested pages for navlinks are not supported (step 1)\")\n return\n }\n\n const prevTitle = frontmatters[prev]?.title || \"\"\n const nextTitle = frontmatters[next]?.title || \"\"\n\n // prev and next found on same nav (pages)\n return {\n prev: {\n // @ts-ignore\n title: prevTitle,\n href: safePageLink(prev),\n },\n next: {\n // @ts-ignore\n title: nextTitle,\n href: safePageLink(next),\n }\n }\n }\n\n const currentNavPosition = nav.findIndex(n => n.group === currentNav.group)\n const foundNavIndex = currentNavPosition != undefined && currentNavPosition !== -1\n\n if (!foundNavIndex) {\n return\n }\n\n // search prev in previous nav\n if (!prev) {\n const prevNav = nav[currentNavPosition - 1]\n\n if (prevNav) {\n const prevNavLastPge = prevNav?.pages?.[prevNav.pages.length - 1]\n\n if (typeof prevNavLastPge != \"string\") {\n console.error(\"currently nested pages for navlinks are not supported (step 2)\")\n } else {\n prev = prevNavLastPge\n }\n }\n }\n\n // search next in next nav\n if (!next) {\n const nextNav = nav[currentNavPosition + 1]\n\n if (nextNav) {\n const nextNavFirstPage = nextNav?.pages?.[0]\n\n if (typeof nextNavFirstPage != \"string\") {\n console.error(\"currently nested pages for navlinks are not supported (step 3)\")\n } else {\n next = nextNavFirstPage\n }\n }\n }\n\n\n if (!prev) {\n if (typeof next == \"string\") {\n const nextTitle = frontmatters[next]?.title || \"\"\n\n return {\n next: {\n // @ts-ignore\n title: nextTitle,\n href: safePageLink(next),\n },\n }\n } else {\n console.error(\"currently nested pages for navlinks are not supported (step 4)\")\n }\n }\n\n if (!next) {\n if (typeof prev == \"string\") {\n const nextTitle = frontmatters[prev]?.title || \"\"\n\n return {\n prev: {\n // @ts-ignore\n title: nextTitle,\n href: safePageLink(prev),\n },\n }\n } else {\n console.error(\"currently nested pages for navlinks are not supported (step 5)\")\n }\n }\n\n if (typeof prev !== \"string\" || typeof next !== \"string\") {\n console.error(\"currently nested pages for navlinks are not supported (step 6)\")\n return\n }\n\n const prevTitle = frontmatters[prev]?.title || \"\"\n const nextTitle = frontmatters[next]?.title || \"\"\n\n return {\n prev: {\n // @ts-ignore\n title: prevTitle,\n href: safePageLink(prev),\n },\n next: {\n // @ts-ignore\n title: nextTitle,\n href: safePageLink(next),\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACGA,wBAAyD;AAOzD,SAAS,iBAAiB,UAAoB,MAAyB;AAVvE;AAWI,QAAM,eAA0B,CAAC;AAEjC,MAAI,oBAAyC;AAE7C,6CAAU,cAAV,mBAAqB,QAAQ,OAAO,aAAW;AAfnD,QAAAA;AAgBQ,QAAI,WAAW,SAAS;AACpB,YAAM,YAAY,cAAc,QAAQ,KAAK;AAC7C,YAAM,gBAAgB,cAAc,IAAI;AAGxC,UAAI,cAAc,WAAW,SAAS,GAAG;AACrC,YAAI,mBAAmB;AACnB,gBAAM,iBAAiB,kBAAkB,MAAM,MAAM,GAAG,EAAE;AAC1D,gBAAM,cAAc,UAAU,MAAM,GAAG,EAAE;AAEzC,cAAI,cAAc,gBAAgB;AAC9B,gCAAoB;AAAA,UACxB;AAAA,QACJ,OAAO;AACH,8BAAoB;AAAA,QACxB;AAAA,MACJ;AAEA;AAAA,IACJ;AAGA,UAAM,SAAK,8CAAyBA,MAAA,qCAAU,cAAV,gBAAAA,IAAqB,WAAU,CAAC,GAAG,IAAI,EAAE,OAAO;AAEpF,QAAI,IAAI;AACJ,mBAAa,KAAK,OAAO;AAAA,IAC7B;AAAA,EACJ;AAEA,MAAI,qBAAqB,MAAM;AAC3B,UAAM,OAAO;AACb,iBAAa,KAAK,GAAG,KAAK,KAAK;AAAA,EACnC;AAEA,SAAO;AACX;AAMA,SAAS,mBAAmB,OAAe,QAAgB;AACvD,MAAI,MAAM,WAAW,GAAG,GAAG;AACvB,YAAQ,MAAM,MAAM,CAAC;AAAA,EACzB;AAEA,MAAI,OAAO,WAAW,GAAG,GAAG;AACxB,aAAS,OAAO,MAAM,CAAC;AAAA,EAC3B;AAEA,SAAO,UAAU;AACrB;AAEA,SAAS,cAAc,MAAc;AACjC,MAAI,KAAK,WAAW,GAAG,GAAG;AACtB,WAAO;AAAA,EACX;AAEA,SAAO,IAAI,IAAI;AACnB;AAEA,SAAS,aAAa,MAAsB;AACxC,UAAO,6BAAM,WAAW,QAAO,OAAO,IAAI,IAAI;AAClD;AAGA,eAAsB,mBAClB,UACA,MAKD;AACC,QAAM,cAAc,iBAAiB,UAAU,IAAI;AACnD,QAAM,eAAe,UAAM,oCAAiB,WAAW;AAEvD,QAAM,kBAAkB,aAAa,IAAI,KAAK;AAC9C,QAAM,cAA6B,CAAC;AACpC,MAAI,WAAkC;AAEtC,WAAS,SACL,MACA,YACA,KACF;AArGN;AAsGQ,QAAI,OAAO,SAAS,UAAU;AAC1B,YAAM,SAAQ,UAAK,UAAL,mBAAY,IAAI,CAAC,MAAM,SAAS,GAAG,MAAM,GAAG;AAE1D,UAAI,+BAAO,KAAK,UAAQ,mBAAmB,KAAK,MAAM,IAAI,IAAI;AAC1D,oBAAY,QAAQ;AAAA,UAChB,OAAO,KAAK,SAAS;AAAA,UACrB,MAAM;AAAA;AAAA,QACV,CAAC;AAAA,MACL;AAEA,aAAO;AAAA,QACH,OAAO,KAAK;AAAA,QACZ,MAAM;AAAA,QACN,QAAQ;AAAA,QACR;AAAA,MACJ;AAAA,IACJ;AAEA,UAAM,cAAc,gBAAgB,aAAa,IAAI,KAAK,aAAa,IAAI,EAAE;AAE7E,QAAI,QAAQ;AAEZ,QAAI,OAAO,gBAAgB,UAAU;AACjC,cAAQ;AAAA,IACZ,OAAO;AAEH,cAAQ;AAAA,IACZ;AAEA,QAAI,CAAC,OAAO;AACR,cAAQ,MAAM,4BAA4B,IAAI;AAAA,IAClD;AAGA,QAAI,mBAAoB,oBAAoB,aAAa,IAAI,GAAI;AAC7D,YAAM,SAAS,cAAc,MAAM,YAAY,KAAK,YAAY;AAEhE,UAAI,QAAQ;AACR,mBAAW;AAAA,MACf;AAEA,UAAI,WAAW,OAAO;AAClB,oBAAY,KAAK;AAAA,UACb,OAAO,WAAW;AAAA,UAClB,MAAM;AAAA;AAAA,QACV,CAAC;AAAA,MACL;AACA,kBAAY,KAAK;AAAA;AAAA,QAEb;AAAA,QACA,MAAM;AAAA,MACV,CAAC;AAAA,IACL;AAEA,WAAO;AAAA;AAAA,MAEH;AAAA,MACA,MAAM,aAAa,IAAI;AAAA,MACvB,QAAQ;AAAA;AAAA,IACZ;AAAA,EACJ;AAEA,QAAM,SAAS,YAAY,IAAI,CAAC,QAAQ;AApK5C;AAsKQ,QAAI,WAAW,KAAK;AAChB,aAAO;AAAA,QACH,OAAO;AAAA,QACP,OAAO,CAAC;AAAA,MACZ;AAAA,IACJ;AAEA,WAAO;AAAA,MACH,OAAO,IAAI;AAAA,MACX,SAAO,SAAI,UAAJ,mBAAW,IAAI,CAAC,MAAM;AAEzB,eAAO,SAAS,GAAG,KAAK,WAAW;AAAA,MACvC,OAAM,CAAC;AAAA,IACX;AAAA,EACJ,CAAC,KAAK,CAAC;AAEP,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AACJ;AAEA,SAAS,cACL,MACA,YACA,KACA,cACqB;AAlMzB;AAmMI,MAAI,CAAC,WAAW,OAAO;AACnB,YAAQ,MAAM,8CAA8C;AAC5D;AAAA,EACJ;AAEA,QAAM,oBAAmB,8CAAY,UAAZ,mBAAmB,UAAU,OAAK,SAAS;AACpE,QAAM,iBAAiB,oBAAoB,UAAa,qBAAqB;AAE7E,MAAI,CAAC,gBAAgB;AACjB;AAAA,EACJ;AAEA,MAAI,QAAO,8CAAY,UAAZ,mBAAoB,mBAAmB;AAClD,MAAI,QAAO,8CAAY,UAAZ,mBAAoB,mBAAmB;AAElD,MAAI,QAAQ,MAAM;AACd,QAAI,OAAO,SAAS,YAAY,OAAO,SAAS,UAAU;AACtD,cAAQ,MAAM,gEAAgE;AAC9E;AAAA,IACJ;AAEA,UAAMC,eAAY,kBAAa,IAAI,MAAjB,mBAAoB,UAAS;AAC/C,UAAMC,eAAY,kBAAa,IAAI,MAAjB,mBAAoB,UAAS;AAG/C,WAAO;AAAA,MACH,MAAM;AAAA;AAAA,QAEF,OAAOD;AAAA,QACP,MAAM,aAAa,IAAI;AAAA,MAC3B;AAAA,MACA,MAAM;AAAA;AAAA,QAEF,OAAOC;AAAA,QACP,MAAM,aAAa,IAAI;AAAA,MAC3B;AAAA,IACJ;AAAA,EACJ;AAEA,QAAM,qBAAqB,IAAI,UAAU,OAAK,EAAE,UAAU,WAAW,KAAK;AAC1E,QAAM,gBAAgB,sBAAsB,UAAa,uBAAuB;AAEhF,MAAI,CAAC,eAAe;AAChB;AAAA,EACJ;AAGA,MAAI,CAAC,MAAM;AACP,UAAM,UAAU,IAAI,qBAAqB,CAAC;AAE1C,QAAI,SAAS;AACT,YAAM,kBAAiB,wCAAS,UAAT,mBAAiB,QAAQ,MAAM,SAAS;AAE/D,UAAI,OAAO,kBAAkB,UAAU;AACnC,gBAAQ,MAAM,gEAAgE;AAAA,MAClF,OAAO;AACH,eAAO;AAAA,MACX;AAAA,IACJ;AAAA,EACJ;AAGA,MAAI,CAAC,MAAM;AACP,UAAM,UAAU,IAAI,qBAAqB,CAAC;AAE1C,QAAI,SAAS;AACT,YAAM,oBAAmB,wCAAS,UAAT,mBAAiB;AAE1C,UAAI,OAAO,oBAAoB,UAAU;AACrC,gBAAQ,MAAM,gEAAgE;AAAA,MAClF,OAAO;AACH,eAAO;AAAA,MACX;AAAA,IACJ;AAAA,EACJ;AAGA,MAAI,CAAC,MAAM;AACP,QAAI,OAAO,QAAQ,UAAU;AACzB,YAAMA,eAAY,kBAAa,IAAI,MAAjB,mBAAoB,UAAS;AAE/C,aAAO;AAAA,QACH,MAAM;AAAA;AAAA,UAEF,OAAOA;AAAA,UACP,MAAM,aAAa,IAAI;AAAA,QAC3B;AAAA,MACJ;AAAA,IACJ,OAAO;AACH,cAAQ,MAAM,gEAAgE;AAAA,IAClF;AAAA,EACJ;AAEA,MAAI,CAAC,MAAM;AACP,QAAI,OAAO,QAAQ,UAAU;AACzB,YAAMA,eAAY,kBAAa,IAAI,MAAjB,mBAAoB,UAAS;AAE/C,aAAO;AAAA,QACH,MAAM;AAAA;AAAA,UAEF,OAAOA;AAAA,UACP,MAAM,aAAa,IAAI;AAAA,QAC3B;AAAA,MACJ;AAAA,IACJ,OAAO;AACH,cAAQ,MAAM,gEAAgE;AAAA,IAClF;AAAA,EACJ;AAEA,MAAI,OAAO,SAAS,YAAY,OAAO,SAAS,UAAU;AACtD,YAAQ,MAAM,gEAAgE;AAC9E;AAAA,EACJ;AAEA,QAAM,cAAY,kBAAa,IAAI,MAAjB,mBAAoB,UAAS;AAC/C,QAAM,cAAY,kBAAa,IAAI,MAAjB,mBAAoB,UAAS;AAE/C,SAAO;AAAA,IACH,MAAM;AAAA;AAAA,MAEF,OAAO;AAAA,MACP,MAAM,aAAa,IAAI;AAAA,IAC3B;AAAA,IACA,MAAM;AAAA;AAAA,MAEF,OAAO;AAAA,MACP,MAAM,aAAa,IAAI;AAAA,IAC3B;AAAA,EACJ;AACJ;","names":["_a","prevTitle","nextTitle"]}
|
|
1
|
+
{"version":3,"sources":["../packages/hydration/mapSettingsToProps.ts"],"sourcesContent":["// server-only\n\nimport { Sidebar, MetadataMap, Settings, SidebarRoute, Metadata, PageURL } from \"@xyd-js/core\";\nimport { pageFrontMatters } from \"@xyd-js/content\";\nimport { IBreadcrumb, INavLinks } from \"@xyd-js/ui\";\n\nimport { FwSidebarGroupProps } from \"../react\";\n\n// TODO: framework vs content responsibility\n\n// mapSettingsToProps maps @xyd-js/core settings into xyd props\nexport async function mapSettingsToProps(\n settings: Settings,\n pagePathMapping: { [key: string]: string },\n slug: string,\n frontmatters?: MetadataMap\n): Promise<{\n groups: FwSidebarGroupProps[],\n breadcrumbs: IBreadcrumb[]\n navlinks?: INavLinks\n hiddenPages?: { [key: string]: boolean }\n metadata?: Metadata | null\n}> {\n let uniqIndex = 0\n const filteredNav = filterNavigation(settings, slug)\n if (!frontmatters) {\n frontmatters = await pageFrontMatters(filteredNav, pagePathMapping) as MetadataMap\n }\n\n const slugFrontmatter = frontmatters[slug] || null\n const breadcrumbs: IBreadcrumb[] = []\n let navlinks: INavLinks | undefined = undefined\n\n const hiddenPages = Object.keys(frontmatters).reduce((acc, page) => {\n if (frontmatters[page].hidden) {\n acc[page] = true\n }\n\n return acc\n }, {})\n\n function mapItems(\n page: PageURL,\n currentNav: Sidebar,\n nav: Sidebar[]\n ) {\n if (!frontmatters) {\n console.error(\"frontmatters not found\")\n return null\n }\n\n if (typeof page !== \"string\" && !(\"virtual\" in page)) {\n const items = page.pages\n ?.map((p) => mapItems(p, page, nav))\n ?.filter(Boolean)\n\n if (items?.find(item => normalizeHrefCheck(item.href, slug))) {\n breadcrumbs.unshift({\n title: page.group || \"\",\n href: \"\", // TODO:\n })\n }\n\n return {\n title: page.group,\n href: \"\",\n active: false,\n uniqIndex: uniqIndex++,\n icon: page.icon,\n items,\n }\n }\n let pageName = \"\"\n if (typeof page === \"string\") {\n pageName = page\n } else {\n pageName = page.page\n }\n\n if (hiddenPages[pageName]) {\n return null\n }\n\n const matterTitle = frontmatters && frontmatters[pageName] && frontmatters[pageName].title\n\n let title = \"\"\n\n if (typeof matterTitle === \"string\") {\n title = matterTitle\n } else {\n // @ts-ignore\n title = matterTitle\n }\n\n if (!title) {\n console.debug(`⚠️ Title not found for page \"${pageName}\"`)\n }\n\n const meta = frontmatters[pageName]\n\n // TODO: better data structures - for example flat array of filtered nav\n if (slugFrontmatter && (slugFrontmatter === meta)) {\n const nlinks = mapNavToLinks(pageName, currentNav, nav, frontmatters, hiddenPages)\n\n if (nlinks) {\n navlinks = nlinks\n }\n\n if (currentNav.group) {\n breadcrumbs.push({\n title: currentNav.group,\n href: \"\", // TODO:\n })\n }\n breadcrumbs.push({\n // @ts-ignore\n title,\n href: pageName,\n })\n }\n\n return {\n title,\n href: safePageLink(pageName),\n active: false,\n uniqIndex: uniqIndex++,\n icon: meta?.icon || \"\",\n sidebarTitle: meta?.sidebarTitle || \"\",\n pageMeta: meta || null,\n }\n }\n\n const groups = filteredNav\n .map((nav) => {\n // TODO: finish\n if (\"route\" in nav) {\n if (nav.pages?.length) {\n const items = (nav.pages?.map((p) => mapItems(p, nav, filteredNav)) || [])\n .filter(Boolean)\n\n return {\n items\n } as FwSidebarGroupProps\n }\n\n return {\n group: \"\",\n items: [],\n groupIndex: 0,\n } as FwSidebarGroupProps\n }\n\n const items = (nav.pages?.map((p) => mapItems(p, nav, filteredNav)) || [])\n .filter(Boolean)\n\n return {\n group: nav.group,\n icon: nav?.icon,\n items\n } as FwSidebarGroupProps\n }) || []\n\n return {\n groups,\n breadcrumbs,\n navlinks,\n hiddenPages,\n metadata: slugFrontmatter\n }\n}\n\nfunction filterNavigation(settings: Settings, slug: string): Sidebar[] {\n const sidebarItems: Sidebar[] = []\n\n let multiSidebarMatch: SidebarRoute | null = null\n\n let flatPagesOnly = false\n\n let foundRoute = false\n\n function findRoute(sidebar: Sidebar | SidebarRoute) {\n if (\"route\" in sidebar) {\n const sideMatch = normalizeHref(sidebar.route)\n const normalizeSlug = normalizeHref(slug)\n\n // TODO: startWith is not enough e.g `/docs/apps/buildISSUE` if `/docs/apps/build`\n if (normalizeSlug.startsWith(sideMatch)) {\n if (multiSidebarMatch) {\n const findByMatchLvl = multiSidebarMatch.route.split(\"/\").length\n const urlMatchLvl = sideMatch.split(\"/\").length\n\n if (urlMatchLvl > findByMatchLvl) {\n if (!foundRoute) {\n foundRoute = true\n sidebarItems.length = 0\n }\n \n multiSidebarMatch = sidebar\n }\n } else {\n if (!foundRoute) {\n foundRoute = true\n sidebarItems.length = 0\n }\n \n multiSidebarMatch = sidebar\n }\n }\n\n if (\"pages\" in sidebar && sidebar.pages?.length) {\n for (const page of sidebar.pages) {\n findRoute(page)\n }\n }\n }\n\n return\n }\n\n settings?.navigation?.sidebar.filter(sidebar => {\n if (flatPagesOnly) {\n return\n }\n if (typeof sidebar === \"string\") {\n flatPagesOnly = true\n return\n }\n\n if (\"route\" in sidebar) {\n findRoute(sidebar)\n\n return\n }\n\n if (foundRoute) {\n return\n }\n\n sidebarItems.push(sidebar)\n })\n\n if (multiSidebarMatch != null) {\n const side = multiSidebarMatch as SidebarRoute\n sidebarItems.push(...(side?.pages || []))\n }\n\n if (flatPagesOnly) {\n sidebarItems.push({\n pages: settings?.navigation?.sidebar as string[]\n })\n }\n\n return sidebarItems\n}\n\n// TODO: rename this because it's no longer 'navigation' because it returns breadcrumbs, sidebar and nextlinks props\n// TODO: breadcrumbs and frontmatters as content plugins?\n// TODO: idea - calculate breadcrumbs and navlinks near server-side component?\n\nfunction normalizeHrefCheck(first: string, second: string) {\n if (first.startsWith(\"/\")) {\n first = first.slice(1)\n }\n\n if (second.startsWith(\"/\")) {\n second = second.slice(1)\n }\n\n return first === second\n}\n\nfunction normalizeHref(href: string) {\n if (href.startsWith(\"/\")) {\n return href\n }\n\n return `/${href}`\n}\n\nfunction safePageLink(page: string): string {\n return page?.startsWith(\"/\") ? page : `/${page}`\n}\n\n// TODO: support next-prev for different 'groups' levels\nfunction mapNavToLinks(\n page: string,\n currentNav: Sidebar,\n nav: Sidebar[],\n frontmatters: MetadataMap,\n hiddenPages: { [key: string]: boolean }\n): INavLinks | undefined {\n if (!currentNav.group) {\n console.debug(\"current nav need group to calculate navlinks\")\n return\n }\n\n // Flatten all pages from all groups to find the sequence\n const allPages: Array<{ page: string, group: string, groupIndex: number, pageIndex: number }> = []\n\n nav.forEach((group, groupIndex) => {\n if (group.pages) {\n group.pages.forEach((pageItem, pageIndex) => {\n let pageName = \"\"\n if (typeof pageItem === \"string\") {\n pageName = pageItem\n } else if (\"virtual\" in pageItem) {\n pageName = pageItem.page\n } else if (\"pages\" in pageItem) {\n // This is a nested Sidebar, skip for now as it's not supported\n return\n } else if (\"page\" in pageItem && typeof pageItem === \"object\") {\n // This is a VirtualPage object with page property\n pageName = (pageItem as { page: string }).page\n }\n\n if (pageName && !hiddenPages[pageName]) {\n allPages.push({\n page: pageName,\n group: group.group || \"\",\n groupIndex,\n pageIndex\n })\n }\n })\n }\n })\n\n // Find current page in the flattened list\n const currentPageIndex = allPages.findIndex(p => p.page === page)\n\n if (currentPageIndex === -1) {\n return undefined\n }\n\n // Get previous and next pages\n const prevPage = allPages[currentPageIndex - 1]\n const nextPage = allPages[currentPageIndex + 1]\n\n let prevLink\n let nextLink\n\n if (prevPage) {\n const prevTitle = frontmatters[prevPage.page]?.title || prevPage.page\n if (typeof prevTitle === \"string\") {\n prevLink = {\n title: prevTitle,\n href: safePageLink(prevPage.page),\n }\n }\n }\n\n if (nextPage) {\n const nextTitle = frontmatters[nextPage.page]?.title || nextPage.page\n if (typeof nextTitle === \"string\") {\n nextLink = {\n title: nextTitle,\n href: safePageLink(nextPage.page),\n }\n }\n }\n\n return {\n prev: prevLink || undefined,\n next: nextLink || undefined,\n }\n}\n"],"mappings":";AAGA,SAAS,wBAAwB;AAQjC,eAAsB,mBAClB,UACA,iBACA,MACA,cAOD;AACC,MAAI,YAAY;AAChB,QAAM,cAAc,iBAAiB,UAAU,IAAI;AACnD,MAAI,CAAC,cAAc;AACf,mBAAe,MAAM,iBAAiB,aAAa,eAAe;AAAA,EACtE;AAEA,QAAM,kBAAkB,aAAa,IAAI,KAAK;AAC9C,QAAM,cAA6B,CAAC;AACpC,MAAI,WAAkC;AAEtC,QAAM,cAAc,OAAO,KAAK,YAAY,EAAE,OAAO,CAAC,KAAK,SAAS;AAChE,QAAI,aAAa,IAAI,EAAE,QAAQ;AAC3B,UAAI,IAAI,IAAI;AAAA,IAChB;AAEA,WAAO;AAAA,EACX,GAAG,CAAC,CAAC;AAEL,WAAS,SACL,MACA,YACA,KACF;AA7CN;AA8CQ,QAAI,CAAC,cAAc;AACf,cAAQ,MAAM,wBAAwB;AACtC,aAAO;AAAA,IACX;AAEA,QAAI,OAAO,SAAS,YAAY,EAAE,aAAa,OAAO;AAClD,YAAM,SAAQ,gBAAK,UAAL,mBACR,IAAI,CAAC,MAAM,SAAS,GAAG,MAAM,GAAG,OADxB,mBAER,OAAO;AAEb,UAAI,+BAAO,KAAK,UAAQ,mBAAmB,KAAK,MAAM,IAAI,IAAI;AAC1D,oBAAY,QAAQ;AAAA,UAChB,OAAO,KAAK,SAAS;AAAA,UACrB,MAAM;AAAA;AAAA,QACV,CAAC;AAAA,MACL;AAEA,aAAO;AAAA,QACH,OAAO,KAAK;AAAA,QACZ,MAAM;AAAA,QACN,QAAQ;AAAA,QACR,WAAW;AAAA,QACX,MAAM,KAAK;AAAA,QACX;AAAA,MACJ;AAAA,IACJ;AACA,QAAI,WAAW;AACf,QAAI,OAAO,SAAS,UAAU;AAC1B,iBAAW;AAAA,IACf,OAAO;AACH,iBAAW,KAAK;AAAA,IACpB;AAEA,QAAI,YAAY,QAAQ,GAAG;AACvB,aAAO;AAAA,IACX;AAEA,UAAM,cAAc,gBAAgB,aAAa,QAAQ,KAAK,aAAa,QAAQ,EAAE;AAErF,QAAI,QAAQ;AAEZ,QAAI,OAAO,gBAAgB,UAAU;AACjC,cAAQ;AAAA,IACZ,OAAO;AAEH,cAAQ;AAAA,IACZ;AAEA,QAAI,CAAC,OAAO;AACR,cAAQ,MAAM,0CAAgC,QAAQ,GAAG;AAAA,IAC7D;AAEA,UAAM,OAAO,aAAa,QAAQ;AAGlC,QAAI,mBAAoB,oBAAoB,MAAO;AAC/C,YAAM,SAAS,cAAc,UAAU,YAAY,KAAK,cAAc,WAAW;AAEjF,UAAI,QAAQ;AACR,mBAAW;AAAA,MACf;AAEA,UAAI,WAAW,OAAO;AAClB,oBAAY,KAAK;AAAA,UACb,OAAO,WAAW;AAAA,UAClB,MAAM;AAAA;AAAA,QACV,CAAC;AAAA,MACL;AACA,kBAAY,KAAK;AAAA;AAAA,QAEb;AAAA,QACA,MAAM;AAAA,MACV,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,MACH;AAAA,MACA,MAAM,aAAa,QAAQ;AAAA,MAC3B,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,OAAM,6BAAM,SAAQ;AAAA,MACpB,eAAc,6BAAM,iBAAgB;AAAA,MACpC,UAAU,QAAQ;AAAA,IACtB;AAAA,EACJ;AAEA,QAAM,SAAS,YACV,IAAI,CAAC,QAAQ;AArItB;AAuIY,QAAI,WAAW,KAAK;AAChB,WAAI,SAAI,UAAJ,mBAAW,QAAQ;AACnB,cAAMA,YAAS,SAAI,UAAJ,mBAAW,IAAI,CAAC,MAAM,SAAS,GAAG,KAAK,WAAW,OAAM,CAAC,GACnE,OAAO,OAAO;AAEnB,eAAO;AAAA,UACH,OAAAA;AAAA,QACJ;AAAA,MACJ;AAEA,aAAO;AAAA,QACH,OAAO;AAAA,QACP,OAAO,CAAC;AAAA,QACR,YAAY;AAAA,MAChB;AAAA,IACJ;AAEA,UAAM,WAAS,SAAI,UAAJ,mBAAW,IAAI,CAAC,MAAM,SAAS,GAAG,KAAK,WAAW,OAAM,CAAC,GACnE,OAAO,OAAO;AAEnB,WAAO;AAAA,MACH,OAAO,IAAI;AAAA,MACX,MAAM,2BAAK;AAAA,MACX;AAAA,IACJ;AAAA,EACJ,CAAC,KAAK,CAAC;AAEX,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU;AAAA,EACd;AACJ;AAEA,SAAS,iBAAiB,UAAoB,MAAyB;AA3KvE;AA4KI,QAAM,eAA0B,CAAC;AAEjC,MAAI,oBAAyC;AAE7C,MAAI,gBAAgB;AAEpB,MAAI,aAAa;AAEjB,WAAS,UAAU,SAAiC;AApLxD,QAAAC;AAqLQ,QAAI,WAAW,SAAS;AACpB,YAAM,YAAY,cAAc,QAAQ,KAAK;AAC7C,YAAM,gBAAgB,cAAc,IAAI;AAGxC,UAAI,cAAc,WAAW,SAAS,GAAG;AACrC,YAAI,mBAAmB;AACnB,gBAAM,iBAAiB,kBAAkB,MAAM,MAAM,GAAG,EAAE;AAC1D,gBAAM,cAAc,UAAU,MAAM,GAAG,EAAE;AAEzC,cAAI,cAAc,gBAAgB;AAC9B,gBAAI,CAAC,YAAY;AACb,2BAAa;AACb,2BAAa,SAAS;AAAA,YAC1B;AAEA,gCAAoB;AAAA,UACxB;AAAA,QACJ,OAAO;AACH,cAAI,CAAC,YAAY;AACb,yBAAa;AACb,yBAAa,SAAS;AAAA,UAC1B;AAEA,8BAAoB;AAAA,QACxB;AAAA,MACJ;AAEA,UAAI,WAAW,aAAWA,MAAA,QAAQ,UAAR,gBAAAA,IAAe,SAAQ;AAC7C,mBAAW,QAAQ,QAAQ,OAAO;AAC9B,oBAAU,IAAI;AAAA,QAClB;AAAA,MACJ;AAAA,IACJ;AAEA;AAAA,EACJ;AAEA,6CAAU,eAAV,mBAAsB,QAAQ,OAAO,aAAW;AAC5C,QAAI,eAAe;AACf;AAAA,IACJ;AACA,QAAI,OAAO,YAAY,UAAU;AAC7B,sBAAgB;AAChB;AAAA,IACJ;AAEA,QAAI,WAAW,SAAS;AACpB,gBAAU,OAAO;AAEjB;AAAA,IACJ;AAEA,QAAI,YAAY;AACZ;AAAA,IACJ;AAEA,iBAAa,KAAK,OAAO;AAAA,EAC7B;AAEA,MAAI,qBAAqB,MAAM;AAC3B,UAAM,OAAO;AACb,iBAAa,KAAK,IAAI,6BAAM,UAAS,CAAC,CAAE;AAAA,EAC5C;AAEA,MAAI,eAAe;AACf,iBAAa,KAAK;AAAA,MACd,QAAO,0CAAU,eAAV,mBAAsB;AAAA,IACjC,CAAC;AAAA,EACL;AAEA,SAAO;AACX;AAMA,SAAS,mBAAmB,OAAe,QAAgB;AACvD,MAAI,MAAM,WAAW,GAAG,GAAG;AACvB,YAAQ,MAAM,MAAM,CAAC;AAAA,EACzB;AAEA,MAAI,OAAO,WAAW,GAAG,GAAG;AACxB,aAAS,OAAO,MAAM,CAAC;AAAA,EAC3B;AAEA,SAAO,UAAU;AACrB;AAEA,SAAS,cAAc,MAAc;AACjC,MAAI,KAAK,WAAW,GAAG,GAAG;AACtB,WAAO;AAAA,EACX;AAEA,SAAO,IAAI,IAAI;AACnB;AAEA,SAAS,aAAa,MAAsB;AACxC,UAAO,6BAAM,WAAW,QAAO,OAAO,IAAI,IAAI;AAClD;AAGA,SAAS,cACL,MACA,YACA,KACA,cACA,aACqB;AAlSzB;AAmSI,MAAI,CAAC,WAAW,OAAO;AACnB,YAAQ,MAAM,8CAA8C;AAC5D;AAAA,EACJ;AAGA,QAAM,WAA0F,CAAC;AAEjG,MAAI,QAAQ,CAAC,OAAO,eAAe;AAC/B,QAAI,MAAM,OAAO;AACb,YAAM,MAAM,QAAQ,CAAC,UAAU,cAAc;AACzC,YAAI,WAAW;AACf,YAAI,OAAO,aAAa,UAAU;AAC9B,qBAAW;AAAA,QACf,WAAW,aAAa,UAAU;AAC9B,qBAAW,SAAS;AAAA,QACxB,WAAW,WAAW,UAAU;AAE5B;AAAA,QACJ,WAAW,UAAU,YAAY,OAAO,aAAa,UAAU;AAE3D,qBAAY,SAA8B;AAAA,QAC9C;AAEA,YAAI,YAAY,CAAC,YAAY,QAAQ,GAAG;AACpC,mBAAS,KAAK;AAAA,YACV,MAAM;AAAA,YACN,OAAO,MAAM,SAAS;AAAA,YACtB;AAAA,YACA;AAAA,UACJ,CAAC;AAAA,QACL;AAAA,MACJ,CAAC;AAAA,IACL;AAAA,EACJ,CAAC;AAGD,QAAM,mBAAmB,SAAS,UAAU,OAAK,EAAE,SAAS,IAAI;AAEhE,MAAI,qBAAqB,IAAI;AACzB,WAAO;AAAA,EACX;AAGA,QAAM,WAAW,SAAS,mBAAmB,CAAC;AAC9C,QAAM,WAAW,SAAS,mBAAmB,CAAC;AAE9C,MAAI;AACJ,MAAI;AAEJ,MAAI,UAAU;AACV,UAAM,cAAY,kBAAa,SAAS,IAAI,MAA1B,mBAA6B,UAAS,SAAS;AACjE,QAAI,OAAO,cAAc,UAAU;AAC/B,iBAAW;AAAA,QACP,OAAO;AAAA,QACP,MAAM,aAAa,SAAS,IAAI;AAAA,MACpC;AAAA,IACJ;AAAA,EACJ;AAEA,MAAI,UAAU;AACV,UAAM,cAAY,kBAAa,SAAS,IAAI,MAA1B,mBAA6B,UAAS,SAAS;AACjE,QAAI,OAAO,cAAc,UAAU;AAC/B,iBAAW;AAAA,QACP,OAAO;AAAA,QACP,MAAM,aAAa,SAAS,IAAI;AAAA,MACpC;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,MAAM,YAAY;AAAA,IAClB,MAAM,YAAY;AAAA,EACtB;AACJ;","names":["items","_a"]}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,24 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
import React from 'react';
|
|
2
|
+
|
|
3
|
+
declare enum SurfaceTarget {
|
|
4
|
+
NavRight = "nav.right",
|
|
5
|
+
SidebarTop = "sidebar.top",
|
|
6
|
+
PageFooterBottom = "page.footer.bottom",
|
|
7
|
+
SidebarItemLeft = "sidebar.item.left",
|
|
8
|
+
SidebarItemRight = "sidebar.item.right"
|
|
9
|
+
}
|
|
10
|
+
type SurfaceTargetType = SurfaceTarget | `${SurfaceTarget}`;
|
|
11
|
+
interface SurfaceOptions {
|
|
12
|
+
append?: boolean;
|
|
13
|
+
}
|
|
14
|
+
interface ROSurface {
|
|
15
|
+
get(target: SurfaceTargetType): React.JSX.Element | React.JSX.Element[] | undefined;
|
|
16
|
+
}
|
|
17
|
+
declare class Surfaces implements ROSurface {
|
|
18
|
+
private registry;
|
|
19
|
+
define(target: SurfaceTargetType, component: React.JSX.Element | React.ComponentType<any>, // TODO: fix any
|
|
20
|
+
opts?: SurfaceOptions): void;
|
|
21
|
+
get(target: SurfaceTargetType): React.JSX.Element | React.JSX.Element[] | undefined;
|
|
4
22
|
}
|
|
5
23
|
|
|
6
|
-
export type
|
|
24
|
+
export { type ROSurface, type SurfaceOptions, SurfaceTarget, type SurfaceTargetType, Surfaces };
|