@veluai/velu 0.2.25 → 0.2.28
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/README.md +80 -80
- package/dist/cli.js +44 -44
- package/package.json +64 -64
- package/runtime/velu-ui/base.css +320 -320
- package/runtime/velu-ui/components/Accordion.jsx +64 -64
- package/runtime/velu-ui/components/ApiClient.jsx +207 -207
- package/runtime/velu-ui/components/ApiField.jsx +87 -87
- package/runtime/velu-ui/components/ApiPath.jsx +63 -63
- package/runtime/velu-ui/components/ApiReferencePage.jsx +384 -384
- package/runtime/velu-ui/components/ApiSamples.jsx +36 -36
- package/runtime/velu-ui/components/ApiSidebar.jsx +125 -125
- package/runtime/velu-ui/components/AskBar.jsx +71 -71
- package/runtime/velu-ui/components/Callout.jsx +114 -114
- package/runtime/velu-ui/components/Card.jsx +131 -131
- package/runtime/velu-ui/components/ChangelogFilters.jsx +75 -75
- package/runtime/velu-ui/components/Chatbot.jsx +972 -972
- package/runtime/velu-ui/components/CodeBlock.jsx +375 -375
- package/runtime/velu-ui/components/Columns.jsx +56 -56
- package/runtime/velu-ui/components/ContextMenu.jsx +327 -327
- package/runtime/velu-ui/components/ErrorCard.jsx +138 -138
- package/runtime/velu-ui/components/Field.jsx +81 -81
- package/runtime/velu-ui/components/Image.jsx +163 -163
- package/runtime/velu-ui/components/Logo.jsx +31 -31
- package/runtime/velu-ui/components/MethodBadge.jsx +31 -31
- package/runtime/velu-ui/components/NavSelect.jsx +108 -108
- package/runtime/velu-ui/components/NotFound.jsx +63 -63
- package/runtime/velu-ui/components/PageFeedback.jsx +219 -219
- package/runtime/velu-ui/components/PageFooter.jsx +145 -145
- package/runtime/velu-ui/components/PageHeader.jsx +422 -422
- package/runtime/velu-ui/components/PageNav.jsx +77 -77
- package/runtime/velu-ui/components/PoweredBy.jsx +51 -51
- package/runtime/velu-ui/components/Prompt.jsx +115 -115
- package/runtime/velu-ui/components/Search.jsx +460 -460
- package/runtime/velu-ui/components/Sidebar.jsx +246 -246
- package/runtime/velu-ui/components/SocialLinks.jsx +90 -90
- package/runtime/velu-ui/components/Steps.jsx +65 -65
- package/runtime/velu-ui/components/ThemeToggle.jsx +48 -48
- package/runtime/velu-ui/components/Toc.jsx +537 -537
- package/runtime/velu-ui/components/TocBar.jsx +195 -195
- package/runtime/velu-ui/components/Tree.jsx +87 -87
- package/runtime/velu-ui/components/TryItBar.jsx +102 -102
- package/runtime/velu-ui/components/Update.jsx +92 -92
- package/runtime/velu-ui/components/accordion.css +92 -92
- package/runtime/velu-ui/components/api-page.css +208 -208
- package/runtime/velu-ui/components/api.css +635 -635
- package/runtime/velu-ui/components/ask-bar.css +103 -103
- package/runtime/velu-ui/components/card.css +105 -105
- package/runtime/velu-ui/components/changelog-filters.css +43 -43
- package/runtime/velu-ui/components/chatbot.css +687 -687
- package/runtime/velu-ui/components/code-block.css +263 -263
- package/runtime/velu-ui/components/context-menu.css +199 -199
- package/runtime/velu-ui/components/docs-layout.css +822 -822
- package/runtime/velu-ui/components/field.css +82 -82
- package/runtime/velu-ui/components/image.css +237 -237
- package/runtime/velu-ui/components/nav-select.css +157 -157
- package/runtime/velu-ui/components/not-found.css +94 -94
- package/runtime/velu-ui/components/page-feedback.css +261 -261
- package/runtime/velu-ui/components/page-footer.css +130 -130
- package/runtime/velu-ui/components/page-header.css +558 -558
- package/runtime/velu-ui/components/page-nav.css +50 -50
- package/runtime/velu-ui/components/powered-by.css +92 -92
- package/runtime/velu-ui/components/prompt.css +99 -99
- package/runtime/velu-ui/components/search.css +307 -307
- package/runtime/velu-ui/components/sidebar.css +205 -205
- package/runtime/velu-ui/components/steps.css +77 -77
- package/runtime/velu-ui/components/theme-toggle.css +102 -102
- package/runtime/velu-ui/components/toc-bar.css +234 -234
- package/runtime/velu-ui/components/tree.css +49 -49
- package/runtime/velu-ui/components/update.css +111 -111
- package/runtime/velu-ui/index.js +58 -58
- package/runtime/velu-ui/lib/api-send.js +118 -118
- package/runtime/velu-ui/lib/brand-icons.jsx +103 -103
- package/runtime/velu-ui/lib/component-schemas.js +100 -100
- package/runtime/velu-ui/lib/copyText.js +64 -64
- package/runtime/velu-ui/lib/docs-assistant.js +273 -273
- package/runtime/velu-ui/lib/lang-icons.jsx +147 -147
- package/runtime/velu-ui/lib/page-feedback.js +72 -72
- package/runtime/velu-ui/lib/pagefind.js +116 -116
- package/runtime/velu-ui/lib/prism-langs.js +957 -957
- package/runtime/velu-ui/lib/prism-loader.js +74 -74
- package/runtime/velu-ui/lib/resolveIcon.jsx +29 -29
- package/runtime/velu-ui/lib/scrollIntoNearestView.js +66 -66
- package/runtime/velu-ui/mdx-components.jsx +107 -107
- package/runtime/velu-ui/primitives/Cluster.jsx +49 -49
- package/runtime/velu-ui/primitives/Stack.jsx +63 -63
- package/runtime/velu-ui/primitives/Switcher.jsx +57 -57
- package/runtime/velu-ui/primitives/stack.css +3 -3
- package/runtime/velu-ui/primitives/switcher.css +25 -25
- package/runtime/velu-ui/styles.css +48 -48
- package/runtime/velu-ui/tokens.css +4 -4
- package/schema/velu.schema.json +419 -419
- package/src/lib/extract-mdx-error.js +170 -170
- package/src/lib/issues.js +159 -159
- package/src/lib/known-components.js +35 -35
- package/src/navigation.js +459 -459
- package/src/runtime/App.jsx +1754 -1754
- package/src/runtime/ErrorBoundary.jsx +54 -54
- package/src/runtime/client-entry.jsx +27 -27
- package/src/runtime/server-entry.jsx +24 -24
- package/src/template.html +48 -48
- package/templates/starter/ai-tools/claude-code.mdx +26 -26
- package/templates/starter/ai-tools/cursor.mdx +17 -17
- package/templates/starter/api-reference/introduction.mdx +43 -43
- package/templates/starter/development.mdx +19 -19
- package/templates/starter/essentials/code.mdx +29 -29
- package/templates/starter/essentials/images.mdx +29 -29
- package/templates/starter/essentials/markdown.mdx +25 -25
- package/templates/starter/essentials/navigation.mdx +39 -39
- package/templates/starter/essentials/settings.mdx +30 -30
- package/templates/starter/favicon.svg +6 -6
- package/templates/starter/index.mdx +31 -31
- package/templates/starter/openapi.json +160 -160
- package/templates/starter/quickstart.mdx +31 -31
- package/templates/starter/velu.json +40 -40
|
@@ -1,116 +1,116 @@
|
|
|
1
|
-
// Pagefind client — queries the static search index that `velu build` writes to
|
|
2
|
-
// /pagefind/. The index is a chunked, lazy-loaded WASM bundle: the browser only
|
|
3
|
-
// downloads the fragments it needs per query, so search scales to huge sites
|
|
4
|
-
// without shipping one giant index. Generated at build time; absent in dev
|
|
5
|
-
// (the dev preview shows search as "unavailable").
|
|
6
|
-
//
|
|
7
|
-
// The runtime is loaded via a NON-analyzable dynamic import (a Function-wrapped
|
|
8
|
-
// import) so neither Vite nor the bundler tries to resolve /pagefind/pagefind.js
|
|
9
|
-
// at build time — it only exists in the deployed output.
|
|
10
|
-
|
|
11
|
-
let _pf = null;
|
|
12
|
-
let _loading = null;
|
|
13
|
-
|
|
14
|
-
async function loadRuntime() {
|
|
15
|
-
if (_pf) return _pf;
|
|
16
|
-
if (_loading) return _loading;
|
|
17
|
-
_loading = (async () => {
|
|
18
|
-
const importer = new Function('p', 'return import(p)');
|
|
19
|
-
// BASE_URL is '/' normally, '/docs/' under subpath hosting — the index is
|
|
20
|
-
// emitted relative to the served root, so prefix the runtime URL to match.
|
|
21
|
-
const base = (import.meta.env.BASE_URL || '/').replace(/\/$/, '');
|
|
22
|
-
const mod = await importer(`${base}/pagefind/pagefind.js`);
|
|
23
|
-
if (typeof mod.init === 'function') await mod.init();
|
|
24
|
-
_pf = mod;
|
|
25
|
-
return mod;
|
|
26
|
-
})();
|
|
27
|
-
try {
|
|
28
|
-
return await _loading;
|
|
29
|
-
} catch (err) {
|
|
30
|
-
_loading = null;
|
|
31
|
-
throw err;
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
const stripHtml = (s) => String(s || '').replace(/<[^>]+>/g, '').replace(/\s+/g, ' ').trim();
|
|
36
|
-
|
|
37
|
-
// Pagefind returns directory URLs (/quickstart/, /a/b/, /); normalize to the
|
|
38
|
-
// router's path form (/quickstart, /a/b, /). Preserve any #anchor.
|
|
39
|
-
function normalizeUrl(url) {
|
|
40
|
-
if (!url) return '/';
|
|
41
|
-
let [path, hash] = String(url).split('#');
|
|
42
|
-
path = path.replace(/index\.html?$/i, '').replace(/\.html?$/i, '');
|
|
43
|
-
if (path.length > 1) path = path.replace(/\/+$/, '');
|
|
44
|
-
if (!path) path = '/';
|
|
45
|
-
return hash ? `${path}#${hash}` : path;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
// Breadcrumb from the URL path (everything but the leaf), title-cased.
|
|
49
|
-
function crumbsFromUrl(url) {
|
|
50
|
-
const segs = String(url).split('#')[0].split('/').filter(Boolean);
|
|
51
|
-
segs.pop();
|
|
52
|
-
return segs.map((s) => s.replace(/[-_]+/g, ' ').replace(/\b\w/g, (c) => c.toUpperCase()));
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Run a query against the static Pagefind index.
|
|
57
|
-
* @returns {Promise<Array<SearchResult>|null>} palette-shaped results, or null
|
|
58
|
-
* when the index can't be loaded (→ caller can show "unavailable").
|
|
59
|
-
*/
|
|
60
|
-
export default async function pagefindSearch(query) {
|
|
61
|
-
const q = String(query || '').trim();
|
|
62
|
-
if (!q) return [];
|
|
63
|
-
|
|
64
|
-
let pf;
|
|
65
|
-
try {
|
|
66
|
-
pf = await loadRuntime();
|
|
67
|
-
} catch {
|
|
68
|
-
return null; // index not present (e.g. not built) → unavailable
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
let response;
|
|
72
|
-
try {
|
|
73
|
-
response = await pf.search(q);
|
|
74
|
-
} catch {
|
|
75
|
-
return [];
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
const hits = await Promise.all(response.results.slice(0, 8).map((r) => r.data()));
|
|
79
|
-
const out = [];
|
|
80
|
-
const seen = new Set(); // dedupe by href
|
|
81
|
-
for (const hit of hits) {
|
|
82
|
-
const href = normalizeUrl(hit.url);
|
|
83
|
-
const title = hit.meta?.title || crumbsFromUrl(hit.url).pop() || href;
|
|
84
|
-
if (!seen.has(href)) {
|
|
85
|
-
seen.add(href);
|
|
86
|
-
out.push({
|
|
87
|
-
id: href,
|
|
88
|
-
group: 'Pages',
|
|
89
|
-
breadcrumb: crumbsFromUrl(hit.url),
|
|
90
|
-
title,
|
|
91
|
-
kind: 'page',
|
|
92
|
-
desc: stripHtml(hit.excerpt),
|
|
93
|
-
href,
|
|
94
|
-
});
|
|
95
|
-
}
|
|
96
|
-
// Heading-level matches → deep-linkable anchor rows. Skip the page's own
|
|
97
|
-
// top section (pagefind repeats it as a sub-result with the page title).
|
|
98
|
-
for (const sub of hit.sub_results || []) {
|
|
99
|
-
const subHref = normalizeUrl(sub.url);
|
|
100
|
-
if (seen.has(subHref) || !subHref.includes('#') || sub.title === title) continue;
|
|
101
|
-
seen.add(subHref);
|
|
102
|
-
out.push({
|
|
103
|
-
id: subHref,
|
|
104
|
-
group: 'Pages',
|
|
105
|
-
breadcrumb: [title],
|
|
106
|
-
title: sub.title || title,
|
|
107
|
-
kind: 'anchor',
|
|
108
|
-
desc: stripHtml(sub.excerpt),
|
|
109
|
-
href: subHref,
|
|
110
|
-
});
|
|
111
|
-
if (out.length >= 12) break;
|
|
112
|
-
}
|
|
113
|
-
if (out.length >= 12) break;
|
|
114
|
-
}
|
|
115
|
-
return out;
|
|
116
|
-
}
|
|
1
|
+
// Pagefind client — queries the static search index that `velu build` writes to
|
|
2
|
+
// /pagefind/. The index is a chunked, lazy-loaded WASM bundle: the browser only
|
|
3
|
+
// downloads the fragments it needs per query, so search scales to huge sites
|
|
4
|
+
// without shipping one giant index. Generated at build time; absent in dev
|
|
5
|
+
// (the dev preview shows search as "unavailable").
|
|
6
|
+
//
|
|
7
|
+
// The runtime is loaded via a NON-analyzable dynamic import (a Function-wrapped
|
|
8
|
+
// import) so neither Vite nor the bundler tries to resolve /pagefind/pagefind.js
|
|
9
|
+
// at build time — it only exists in the deployed output.
|
|
10
|
+
|
|
11
|
+
let _pf = null;
|
|
12
|
+
let _loading = null;
|
|
13
|
+
|
|
14
|
+
async function loadRuntime() {
|
|
15
|
+
if (_pf) return _pf;
|
|
16
|
+
if (_loading) return _loading;
|
|
17
|
+
_loading = (async () => {
|
|
18
|
+
const importer = new Function('p', 'return import(p)');
|
|
19
|
+
// BASE_URL is '/' normally, '/docs/' under subpath hosting — the index is
|
|
20
|
+
// emitted relative to the served root, so prefix the runtime URL to match.
|
|
21
|
+
const base = (import.meta.env.BASE_URL || '/').replace(/\/$/, '');
|
|
22
|
+
const mod = await importer(`${base}/pagefind/pagefind.js`);
|
|
23
|
+
if (typeof mod.init === 'function') await mod.init();
|
|
24
|
+
_pf = mod;
|
|
25
|
+
return mod;
|
|
26
|
+
})();
|
|
27
|
+
try {
|
|
28
|
+
return await _loading;
|
|
29
|
+
} catch (err) {
|
|
30
|
+
_loading = null;
|
|
31
|
+
throw err;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
const stripHtml = (s) => String(s || '').replace(/<[^>]+>/g, '').replace(/\s+/g, ' ').trim();
|
|
36
|
+
|
|
37
|
+
// Pagefind returns directory URLs (/quickstart/, /a/b/, /); normalize to the
|
|
38
|
+
// router's path form (/quickstart, /a/b, /). Preserve any #anchor.
|
|
39
|
+
function normalizeUrl(url) {
|
|
40
|
+
if (!url) return '/';
|
|
41
|
+
let [path, hash] = String(url).split('#');
|
|
42
|
+
path = path.replace(/index\.html?$/i, '').replace(/\.html?$/i, '');
|
|
43
|
+
if (path.length > 1) path = path.replace(/\/+$/, '');
|
|
44
|
+
if (!path) path = '/';
|
|
45
|
+
return hash ? `${path}#${hash}` : path;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// Breadcrumb from the URL path (everything but the leaf), title-cased.
|
|
49
|
+
function crumbsFromUrl(url) {
|
|
50
|
+
const segs = String(url).split('#')[0].split('/').filter(Boolean);
|
|
51
|
+
segs.pop();
|
|
52
|
+
return segs.map((s) => s.replace(/[-_]+/g, ' ').replace(/\b\w/g, (c) => c.toUpperCase()));
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Run a query against the static Pagefind index.
|
|
57
|
+
* @returns {Promise<Array<SearchResult>|null>} palette-shaped results, or null
|
|
58
|
+
* when the index can't be loaded (→ caller can show "unavailable").
|
|
59
|
+
*/
|
|
60
|
+
export default async function pagefindSearch(query) {
|
|
61
|
+
const q = String(query || '').trim();
|
|
62
|
+
if (!q) return [];
|
|
63
|
+
|
|
64
|
+
let pf;
|
|
65
|
+
try {
|
|
66
|
+
pf = await loadRuntime();
|
|
67
|
+
} catch {
|
|
68
|
+
return null; // index not present (e.g. not built) → unavailable
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
let response;
|
|
72
|
+
try {
|
|
73
|
+
response = await pf.search(q);
|
|
74
|
+
} catch {
|
|
75
|
+
return [];
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
const hits = await Promise.all(response.results.slice(0, 8).map((r) => r.data()));
|
|
79
|
+
const out = [];
|
|
80
|
+
const seen = new Set(); // dedupe by href
|
|
81
|
+
for (const hit of hits) {
|
|
82
|
+
const href = normalizeUrl(hit.url);
|
|
83
|
+
const title = hit.meta?.title || crumbsFromUrl(hit.url).pop() || href;
|
|
84
|
+
if (!seen.has(href)) {
|
|
85
|
+
seen.add(href);
|
|
86
|
+
out.push({
|
|
87
|
+
id: href,
|
|
88
|
+
group: 'Pages',
|
|
89
|
+
breadcrumb: crumbsFromUrl(hit.url),
|
|
90
|
+
title,
|
|
91
|
+
kind: 'page',
|
|
92
|
+
desc: stripHtml(hit.excerpt),
|
|
93
|
+
href,
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
// Heading-level matches → deep-linkable anchor rows. Skip the page's own
|
|
97
|
+
// top section (pagefind repeats it as a sub-result with the page title).
|
|
98
|
+
for (const sub of hit.sub_results || []) {
|
|
99
|
+
const subHref = normalizeUrl(sub.url);
|
|
100
|
+
if (seen.has(subHref) || !subHref.includes('#') || sub.title === title) continue;
|
|
101
|
+
seen.add(subHref);
|
|
102
|
+
out.push({
|
|
103
|
+
id: subHref,
|
|
104
|
+
group: 'Pages',
|
|
105
|
+
breadcrumb: [title],
|
|
106
|
+
title: sub.title || title,
|
|
107
|
+
kind: 'anchor',
|
|
108
|
+
desc: stripHtml(sub.excerpt),
|
|
109
|
+
href: subHref,
|
|
110
|
+
});
|
|
111
|
+
if (out.length >= 12) break;
|
|
112
|
+
}
|
|
113
|
+
if (out.length >= 12) break;
|
|
114
|
+
}
|
|
115
|
+
return out;
|
|
116
|
+
}
|