@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,147 +1,147 @@
|
|
|
1
|
-
import React, { useState, useEffect } from 'react';
|
|
2
|
-
import { resolveLang } from './prism-loader.js';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Language → icon mapping.
|
|
6
|
-
*
|
|
7
|
-
* Brand icons (JS / Python / Ruby / etc.) come from
|
|
8
|
-
* @icons-pack/react-simple-icons. We load each one with an explicit
|
|
9
|
-
* dynamic `import()` (static specifier, so Vite code-splits one chunk per
|
|
10
|
-
* icon) — the browser then fetches ONLY the languages a page actually
|
|
11
|
-
* renders, never the full set and never the package's ~3000-icon barrel
|
|
12
|
-
* (importing that barrel makes Vite transform all 3000 modules on the
|
|
13
|
-
* first dev load, which dominated cold start).
|
|
14
|
-
*
|
|
15
|
-
* Because the import is dynamic, a brand icon isn't available during SSR;
|
|
16
|
-
* `BrandIcon` renders a sized placeholder until the module resolves on the
|
|
17
|
-
* client. The placeholder is identical on the server and the first client
|
|
18
|
-
* render, so hydration never mismatches. Langs without a brand icon fall
|
|
19
|
-
* back to a semantic lucide id (string) handled by `resolveIcon`.
|
|
20
|
-
*/
|
|
21
|
-
|
|
22
|
-
// canonical lang → loader (() => import of that icon's module).
|
|
23
|
-
const BRAND_LOADERS = {
|
|
24
|
-
javascript: () => import('@icons-pack/react-simple-icons/icons/SiJavascript.mjs'),
|
|
25
|
-
typescript: () => import('@icons-pack/react-simple-icons/icons/SiTypescript.mjs'),
|
|
26
|
-
jsx: () => import('@icons-pack/react-simple-icons/icons/SiReact.mjs'),
|
|
27
|
-
tsx: () => import('@icons-pack/react-simple-icons/icons/SiReact.mjs'),
|
|
28
|
-
python: () => import('@icons-pack/react-simple-icons/icons/SiPython.mjs'),
|
|
29
|
-
ruby: () => import('@icons-pack/react-simple-icons/icons/SiRuby.mjs'),
|
|
30
|
-
go: () => import('@icons-pack/react-simple-icons/icons/SiGo.mjs'),
|
|
31
|
-
rust: () => import('@icons-pack/react-simple-icons/icons/SiRust.mjs'),
|
|
32
|
-
java: () => import('@icons-pack/react-simple-icons/icons/SiOpenjdk.mjs'),
|
|
33
|
-
csharp: () => import('@icons-pack/react-simple-icons/icons/SiSharp.mjs'),
|
|
34
|
-
c: () => import('@icons-pack/react-simple-icons/icons/SiC.mjs'),
|
|
35
|
-
cpp: () => import('@icons-pack/react-simple-icons/icons/SiCplusplus.mjs'),
|
|
36
|
-
php: () => import('@icons-pack/react-simple-icons/icons/SiPhp.mjs'),
|
|
37
|
-
swift: () => import('@icons-pack/react-simple-icons/icons/SiSwift.mjs'),
|
|
38
|
-
kotlin: () => import('@icons-pack/react-simple-icons/icons/SiKotlin.mjs'),
|
|
39
|
-
scala: () => import('@icons-pack/react-simple-icons/icons/SiScala.mjs'),
|
|
40
|
-
dart: () => import('@icons-pack/react-simple-icons/icons/SiDart.mjs'),
|
|
41
|
-
r: () => import('@icons-pack/react-simple-icons/icons/SiR.mjs'),
|
|
42
|
-
haskell: () => import('@icons-pack/react-simple-icons/icons/SiHaskell.mjs'),
|
|
43
|
-
elixir: () => import('@icons-pack/react-simple-icons/icons/SiElixir.mjs'),
|
|
44
|
-
erlang: () => import('@icons-pack/react-simple-icons/icons/SiErlang.mjs'),
|
|
45
|
-
lua: () => import('@icons-pack/react-simple-icons/icons/SiLua.mjs'),
|
|
46
|
-
perl: () => import('@icons-pack/react-simple-icons/icons/SiPerl.mjs'),
|
|
47
|
-
julia: () => import('@icons-pack/react-simple-icons/icons/SiJulia.mjs'),
|
|
48
|
-
ocaml: () => import('@icons-pack/react-simple-icons/icons/SiOcaml.mjs'),
|
|
49
|
-
fsharp: () => import('@icons-pack/react-simple-icons/icons/SiFsharp.mjs'),
|
|
50
|
-
nim: () => import('@icons-pack/react-simple-icons/icons/SiNim.mjs'),
|
|
51
|
-
zig: () => import('@icons-pack/react-simple-icons/icons/SiZig.mjs'),
|
|
52
|
-
clojure: () => import('@icons-pack/react-simple-icons/icons/SiClojure.mjs'),
|
|
53
|
-
coffeescript: () => import('@icons-pack/react-simple-icons/icons/SiCoffeescript.mjs'),
|
|
54
|
-
html: () => import('@icons-pack/react-simple-icons/icons/SiHtml5.mjs'),
|
|
55
|
-
css: () => import('@icons-pack/react-simple-icons/icons/SiCss.mjs'),
|
|
56
|
-
vue: () => import('@icons-pack/react-simple-icons/icons/SiVuedotjs.mjs'),
|
|
57
|
-
svelte: () => import('@icons-pack/react-simple-icons/icons/SiSvelte.mjs'),
|
|
58
|
-
solid: () => import('@icons-pack/react-simple-icons/icons/SiSolid.mjs'),
|
|
59
|
-
json: () => import('@icons-pack/react-simple-icons/icons/SiJson.mjs'),
|
|
60
|
-
yaml: () => import('@icons-pack/react-simple-icons/icons/SiYaml.mjs'),
|
|
61
|
-
toml: () => import('@icons-pack/react-simple-icons/icons/SiToml.mjs'),
|
|
62
|
-
graphql: () => import('@icons-pack/react-simple-icons/icons/SiGraphql.mjs'),
|
|
63
|
-
markdown: () => import('@icons-pack/react-simple-icons/icons/SiMarkdown.mjs'),
|
|
64
|
-
mdx: () => import('@icons-pack/react-simple-icons/icons/SiMarkdown.mjs'),
|
|
65
|
-
latex: () => import('@icons-pack/react-simple-icons/icons/SiLatex.mjs'),
|
|
66
|
-
asciidoc: () => import('@icons-pack/react-simple-icons/icons/SiAsciidoctor.mjs'),
|
|
67
|
-
bash: () => import('@icons-pack/react-simple-icons/icons/SiGnubash.mjs'),
|
|
68
|
-
shell: () => import('@icons-pack/react-simple-icons/icons/SiGnubash.mjs'),
|
|
69
|
-
sh: () => import('@icons-pack/react-simple-icons/icons/SiGnubash.mjs'),
|
|
70
|
-
fish: () => import('@icons-pack/react-simple-icons/icons/SiFishshell.mjs'),
|
|
71
|
-
nodejs: () => import('@icons-pack/react-simple-icons/icons/SiNodedotjs.mjs'),
|
|
72
|
-
mysql: () => import('@icons-pack/react-simple-icons/icons/SiMysql.mjs'),
|
|
73
|
-
postgresql: () => import('@icons-pack/react-simple-icons/icons/SiPostgresql.mjs'),
|
|
74
|
-
plsql: () => import('@icons-pack/react-simple-icons/icons/SiPostgresql.mjs'),
|
|
75
|
-
sqlite: () => import('@icons-pack/react-simple-icons/icons/SiSqlite.mjs'),
|
|
76
|
-
mongodb: () => import('@icons-pack/react-simple-icons/icons/SiMongodb.mjs'),
|
|
77
|
-
redis: () => import('@icons-pack/react-simple-icons/icons/SiRedis.mjs'),
|
|
78
|
-
docker: () => import('@icons-pack/react-simple-icons/icons/SiDocker.mjs'),
|
|
79
|
-
dockerfile: () => import('@icons-pack/react-simple-icons/icons/SiDocker.mjs'),
|
|
80
|
-
kubernetes: () => import('@icons-pack/react-simple-icons/icons/SiKubernetes.mjs'),
|
|
81
|
-
nginx: () => import('@icons-pack/react-simple-icons/icons/SiNginx.mjs'),
|
|
82
|
-
apacheconf: () => import('@icons-pack/react-simple-icons/icons/SiApache.mjs'),
|
|
83
|
-
};
|
|
84
|
-
|
|
85
|
-
// Generic lucide fallback for langs without a brand icon. Returns a
|
|
86
|
-
// lucide id string — `resolveIcon` turns it into the icon component.
|
|
87
|
-
const LUCIDE = {
|
|
88
|
-
sql: 'database',
|
|
89
|
-
xml: 'code-xml',
|
|
90
|
-
diff: 'git-compare-arrows',
|
|
91
|
-
ini: 'braces',
|
|
92
|
-
properties: 'braces',
|
|
93
|
-
powershell: 'terminal',
|
|
94
|
-
batch: 'terminal',
|
|
95
|
-
zsh: 'terminal',
|
|
96
|
-
text: 'file-code',
|
|
97
|
-
plaintext: 'file-code',
|
|
98
|
-
};
|
|
99
|
-
|
|
100
|
-
// Module-level cache so an icon that's been loaded once renders
|
|
101
|
-
// synchronously everywhere after (no repeat import, no flash).
|
|
102
|
-
const iconCache = new Map();
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* Renders a brand icon loaded lazily by `key`. SSR + the first client
|
|
106
|
-
* render emit a sized placeholder (identical → hydration-safe); after
|
|
107
|
-
* mount the icon's module is imported and swapped in.
|
|
108
|
-
*/
|
|
109
|
-
function BrandIcon({ iconKey, ...props }) {
|
|
110
|
-
const [Icon, setIcon] = useState(() => iconCache.get(iconKey) || null);
|
|
111
|
-
|
|
112
|
-
useEffect(() => {
|
|
113
|
-
if (iconCache.has(iconKey)) {
|
|
114
|
-
setIcon(() => iconCache.get(iconKey));
|
|
115
|
-
return;
|
|
116
|
-
}
|
|
117
|
-
const load = BRAND_LOADERS[iconKey];
|
|
118
|
-
if (!load) return;
|
|
119
|
-
let alive = true;
|
|
120
|
-
load().then((mod) => {
|
|
121
|
-
iconCache.set(iconKey, mod.default);
|
|
122
|
-
if (alive) setIcon(() => mod.default);
|
|
123
|
-
});
|
|
124
|
-
return () => {
|
|
125
|
-
alive = false;
|
|
126
|
-
};
|
|
127
|
-
}, [iconKey]);
|
|
128
|
-
|
|
129
|
-
if (!Icon) {
|
|
130
|
-
// Reserve the icon's box so swapping it in causes no layout shift.
|
|
131
|
-
return (
|
|
132
|
-
<span
|
|
133
|
-
aria-hidden="true"
|
|
134
|
-
style={{ display: 'inline-block', width: '1em', height: '1em' }}
|
|
135
|
-
/>
|
|
136
|
-
);
|
|
137
|
-
}
|
|
138
|
-
return <Icon {...props} />;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
export function iconForLang(lang) {
|
|
142
|
-
if (!lang) return 'file-code';
|
|
143
|
-
const id = resolveLang(lang) || lang;
|
|
144
|
-
const key = BRAND_LOADERS[id] ? id : BRAND_LOADERS[lang] ? lang : null;
|
|
145
|
-
if (key) return <BrandIcon iconKey={key} size="1em" />;
|
|
146
|
-
return LUCIDE[id] || LUCIDE[lang] || 'file-code';
|
|
147
|
-
}
|
|
1
|
+
import React, { useState, useEffect } from 'react';
|
|
2
|
+
import { resolveLang } from './prism-loader.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Language → icon mapping.
|
|
6
|
+
*
|
|
7
|
+
* Brand icons (JS / Python / Ruby / etc.) come from
|
|
8
|
+
* @icons-pack/react-simple-icons. We load each one with an explicit
|
|
9
|
+
* dynamic `import()` (static specifier, so Vite code-splits one chunk per
|
|
10
|
+
* icon) — the browser then fetches ONLY the languages a page actually
|
|
11
|
+
* renders, never the full set and never the package's ~3000-icon barrel
|
|
12
|
+
* (importing that barrel makes Vite transform all 3000 modules on the
|
|
13
|
+
* first dev load, which dominated cold start).
|
|
14
|
+
*
|
|
15
|
+
* Because the import is dynamic, a brand icon isn't available during SSR;
|
|
16
|
+
* `BrandIcon` renders a sized placeholder until the module resolves on the
|
|
17
|
+
* client. The placeholder is identical on the server and the first client
|
|
18
|
+
* render, so hydration never mismatches. Langs without a brand icon fall
|
|
19
|
+
* back to a semantic lucide id (string) handled by `resolveIcon`.
|
|
20
|
+
*/
|
|
21
|
+
|
|
22
|
+
// canonical lang → loader (() => import of that icon's module).
|
|
23
|
+
const BRAND_LOADERS = {
|
|
24
|
+
javascript: () => import('@icons-pack/react-simple-icons/icons/SiJavascript.mjs'),
|
|
25
|
+
typescript: () => import('@icons-pack/react-simple-icons/icons/SiTypescript.mjs'),
|
|
26
|
+
jsx: () => import('@icons-pack/react-simple-icons/icons/SiReact.mjs'),
|
|
27
|
+
tsx: () => import('@icons-pack/react-simple-icons/icons/SiReact.mjs'),
|
|
28
|
+
python: () => import('@icons-pack/react-simple-icons/icons/SiPython.mjs'),
|
|
29
|
+
ruby: () => import('@icons-pack/react-simple-icons/icons/SiRuby.mjs'),
|
|
30
|
+
go: () => import('@icons-pack/react-simple-icons/icons/SiGo.mjs'),
|
|
31
|
+
rust: () => import('@icons-pack/react-simple-icons/icons/SiRust.mjs'),
|
|
32
|
+
java: () => import('@icons-pack/react-simple-icons/icons/SiOpenjdk.mjs'),
|
|
33
|
+
csharp: () => import('@icons-pack/react-simple-icons/icons/SiSharp.mjs'),
|
|
34
|
+
c: () => import('@icons-pack/react-simple-icons/icons/SiC.mjs'),
|
|
35
|
+
cpp: () => import('@icons-pack/react-simple-icons/icons/SiCplusplus.mjs'),
|
|
36
|
+
php: () => import('@icons-pack/react-simple-icons/icons/SiPhp.mjs'),
|
|
37
|
+
swift: () => import('@icons-pack/react-simple-icons/icons/SiSwift.mjs'),
|
|
38
|
+
kotlin: () => import('@icons-pack/react-simple-icons/icons/SiKotlin.mjs'),
|
|
39
|
+
scala: () => import('@icons-pack/react-simple-icons/icons/SiScala.mjs'),
|
|
40
|
+
dart: () => import('@icons-pack/react-simple-icons/icons/SiDart.mjs'),
|
|
41
|
+
r: () => import('@icons-pack/react-simple-icons/icons/SiR.mjs'),
|
|
42
|
+
haskell: () => import('@icons-pack/react-simple-icons/icons/SiHaskell.mjs'),
|
|
43
|
+
elixir: () => import('@icons-pack/react-simple-icons/icons/SiElixir.mjs'),
|
|
44
|
+
erlang: () => import('@icons-pack/react-simple-icons/icons/SiErlang.mjs'),
|
|
45
|
+
lua: () => import('@icons-pack/react-simple-icons/icons/SiLua.mjs'),
|
|
46
|
+
perl: () => import('@icons-pack/react-simple-icons/icons/SiPerl.mjs'),
|
|
47
|
+
julia: () => import('@icons-pack/react-simple-icons/icons/SiJulia.mjs'),
|
|
48
|
+
ocaml: () => import('@icons-pack/react-simple-icons/icons/SiOcaml.mjs'),
|
|
49
|
+
fsharp: () => import('@icons-pack/react-simple-icons/icons/SiFsharp.mjs'),
|
|
50
|
+
nim: () => import('@icons-pack/react-simple-icons/icons/SiNim.mjs'),
|
|
51
|
+
zig: () => import('@icons-pack/react-simple-icons/icons/SiZig.mjs'),
|
|
52
|
+
clojure: () => import('@icons-pack/react-simple-icons/icons/SiClojure.mjs'),
|
|
53
|
+
coffeescript: () => import('@icons-pack/react-simple-icons/icons/SiCoffeescript.mjs'),
|
|
54
|
+
html: () => import('@icons-pack/react-simple-icons/icons/SiHtml5.mjs'),
|
|
55
|
+
css: () => import('@icons-pack/react-simple-icons/icons/SiCss.mjs'),
|
|
56
|
+
vue: () => import('@icons-pack/react-simple-icons/icons/SiVuedotjs.mjs'),
|
|
57
|
+
svelte: () => import('@icons-pack/react-simple-icons/icons/SiSvelte.mjs'),
|
|
58
|
+
solid: () => import('@icons-pack/react-simple-icons/icons/SiSolid.mjs'),
|
|
59
|
+
json: () => import('@icons-pack/react-simple-icons/icons/SiJson.mjs'),
|
|
60
|
+
yaml: () => import('@icons-pack/react-simple-icons/icons/SiYaml.mjs'),
|
|
61
|
+
toml: () => import('@icons-pack/react-simple-icons/icons/SiToml.mjs'),
|
|
62
|
+
graphql: () => import('@icons-pack/react-simple-icons/icons/SiGraphql.mjs'),
|
|
63
|
+
markdown: () => import('@icons-pack/react-simple-icons/icons/SiMarkdown.mjs'),
|
|
64
|
+
mdx: () => import('@icons-pack/react-simple-icons/icons/SiMarkdown.mjs'),
|
|
65
|
+
latex: () => import('@icons-pack/react-simple-icons/icons/SiLatex.mjs'),
|
|
66
|
+
asciidoc: () => import('@icons-pack/react-simple-icons/icons/SiAsciidoctor.mjs'),
|
|
67
|
+
bash: () => import('@icons-pack/react-simple-icons/icons/SiGnubash.mjs'),
|
|
68
|
+
shell: () => import('@icons-pack/react-simple-icons/icons/SiGnubash.mjs'),
|
|
69
|
+
sh: () => import('@icons-pack/react-simple-icons/icons/SiGnubash.mjs'),
|
|
70
|
+
fish: () => import('@icons-pack/react-simple-icons/icons/SiFishshell.mjs'),
|
|
71
|
+
nodejs: () => import('@icons-pack/react-simple-icons/icons/SiNodedotjs.mjs'),
|
|
72
|
+
mysql: () => import('@icons-pack/react-simple-icons/icons/SiMysql.mjs'),
|
|
73
|
+
postgresql: () => import('@icons-pack/react-simple-icons/icons/SiPostgresql.mjs'),
|
|
74
|
+
plsql: () => import('@icons-pack/react-simple-icons/icons/SiPostgresql.mjs'),
|
|
75
|
+
sqlite: () => import('@icons-pack/react-simple-icons/icons/SiSqlite.mjs'),
|
|
76
|
+
mongodb: () => import('@icons-pack/react-simple-icons/icons/SiMongodb.mjs'),
|
|
77
|
+
redis: () => import('@icons-pack/react-simple-icons/icons/SiRedis.mjs'),
|
|
78
|
+
docker: () => import('@icons-pack/react-simple-icons/icons/SiDocker.mjs'),
|
|
79
|
+
dockerfile: () => import('@icons-pack/react-simple-icons/icons/SiDocker.mjs'),
|
|
80
|
+
kubernetes: () => import('@icons-pack/react-simple-icons/icons/SiKubernetes.mjs'),
|
|
81
|
+
nginx: () => import('@icons-pack/react-simple-icons/icons/SiNginx.mjs'),
|
|
82
|
+
apacheconf: () => import('@icons-pack/react-simple-icons/icons/SiApache.mjs'),
|
|
83
|
+
};
|
|
84
|
+
|
|
85
|
+
// Generic lucide fallback for langs without a brand icon. Returns a
|
|
86
|
+
// lucide id string — `resolveIcon` turns it into the icon component.
|
|
87
|
+
const LUCIDE = {
|
|
88
|
+
sql: 'database',
|
|
89
|
+
xml: 'code-xml',
|
|
90
|
+
diff: 'git-compare-arrows',
|
|
91
|
+
ini: 'braces',
|
|
92
|
+
properties: 'braces',
|
|
93
|
+
powershell: 'terminal',
|
|
94
|
+
batch: 'terminal',
|
|
95
|
+
zsh: 'terminal',
|
|
96
|
+
text: 'file-code',
|
|
97
|
+
plaintext: 'file-code',
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
// Module-level cache so an icon that's been loaded once renders
|
|
101
|
+
// synchronously everywhere after (no repeat import, no flash).
|
|
102
|
+
const iconCache = new Map();
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Renders a brand icon loaded lazily by `key`. SSR + the first client
|
|
106
|
+
* render emit a sized placeholder (identical → hydration-safe); after
|
|
107
|
+
* mount the icon's module is imported and swapped in.
|
|
108
|
+
*/
|
|
109
|
+
function BrandIcon({ iconKey, ...props }) {
|
|
110
|
+
const [Icon, setIcon] = useState(() => iconCache.get(iconKey) || null);
|
|
111
|
+
|
|
112
|
+
useEffect(() => {
|
|
113
|
+
if (iconCache.has(iconKey)) {
|
|
114
|
+
setIcon(() => iconCache.get(iconKey));
|
|
115
|
+
return;
|
|
116
|
+
}
|
|
117
|
+
const load = BRAND_LOADERS[iconKey];
|
|
118
|
+
if (!load) return;
|
|
119
|
+
let alive = true;
|
|
120
|
+
load().then((mod) => {
|
|
121
|
+
iconCache.set(iconKey, mod.default);
|
|
122
|
+
if (alive) setIcon(() => mod.default);
|
|
123
|
+
});
|
|
124
|
+
return () => {
|
|
125
|
+
alive = false;
|
|
126
|
+
};
|
|
127
|
+
}, [iconKey]);
|
|
128
|
+
|
|
129
|
+
if (!Icon) {
|
|
130
|
+
// Reserve the icon's box so swapping it in causes no layout shift.
|
|
131
|
+
return (
|
|
132
|
+
<span
|
|
133
|
+
aria-hidden="true"
|
|
134
|
+
style={{ display: 'inline-block', width: '1em', height: '1em' }}
|
|
135
|
+
/>
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
return <Icon {...props} />;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
export function iconForLang(lang) {
|
|
142
|
+
if (!lang) return 'file-code';
|
|
143
|
+
const id = resolveLang(lang) || lang;
|
|
144
|
+
const key = BRAND_LOADERS[id] ? id : BRAND_LOADERS[lang] ? lang : null;
|
|
145
|
+
if (key) return <BrandIcon iconKey={key} size="1em" />;
|
|
146
|
+
return LUCIDE[id] || LUCIDE[lang] || 'file-code';
|
|
147
|
+
}
|
|
@@ -1,72 +1,72 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* page-feedback — runtime client for the "Was this page helpful?" widget on a
|
|
3
|
-
* published docs site. POSTs to the backend's PUBLIC feedback API:
|
|
4
|
-
*
|
|
5
|
-
* POST /api/v1/public/feedback ({ page_url, helpful, reason_text, details })
|
|
6
|
-
*
|
|
7
|
-
* Same contract as docs-assistant: the tenant is resolved from the
|
|
8
|
-
* `X-Velu-Site-Host` header (falls back to Origin), and the httponly visitor
|
|
9
|
-
* cookie rides along via `credentials: 'include'` (so the API must be same-site
|
|
10
|
-
* with the docs — true for *.getvelu.com subdomains).
|
|
11
|
-
*
|
|
12
|
-
* `createPageFeedback({ apiBase, host })` returns `{ submit }`, shaped to wire
|
|
13
|
-
* straight into <PageFeedback onVote onSubmit>. Returns null without an apiBase
|
|
14
|
-
* (dev preview / unconfigured site) so the widget stays purely visual.
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
const trimSlash = (s) => String(s || '').replace(/\/+$/, '');
|
|
18
|
-
|
|
19
|
-
function siteHost(explicit) {
|
|
20
|
-
if (explicit) return explicit;
|
|
21
|
-
return typeof window !== 'undefined' ? window.location.host : '';
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
// The page the feedback is about. Drop hash + query here; the backend
|
|
25
|
-
// normalizes again server-side so per-page aggregation stays clean.
|
|
26
|
-
function currentPageUrl() {
|
|
27
|
-
if (typeof window === 'undefined') return '';
|
|
28
|
-
const { origin, pathname } = window.location;
|
|
29
|
-
return origin + pathname;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
export function createPageFeedback({ apiBase, host } = {}) {
|
|
33
|
-
const base = trimSlash(apiBase);
|
|
34
|
-
if (!base) return null;
|
|
35
|
-
const url = `${base}/api/v1/public/feedback`;
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* Send one feedback submission.
|
|
39
|
-
* - helpful: boolean (Yes / No)
|
|
40
|
-
* - reason: short label from the "No" form (optional)
|
|
41
|
-
* - detail: free-text elaboration (optional)
|
|
42
|
-
* Best-effort: a failed request never disrupts the reader.
|
|
43
|
-
*/
|
|
44
|
-
async function submit({ helpful, reason, detail } = {}) {
|
|
45
|
-
const body = {
|
|
46
|
-
page_url: currentPageUrl(),
|
|
47
|
-
helpful: !!helpful,
|
|
48
|
-
// reason_text is required by the API (min length 1); fall back to a
|
|
49
|
-
// sensible default when the reader didn't pick a reason (e.g. on "Yes").
|
|
50
|
-
reason_text:
|
|
51
|
-
(reason && String(reason).trim()) || (helpful ? 'Helpful' : 'Not helpful'),
|
|
52
|
-
details: detail ? String(detail) : null,
|
|
53
|
-
};
|
|
54
|
-
try {
|
|
55
|
-
await fetch(url, {
|
|
56
|
-
method: 'POST',
|
|
57
|
-
credentials: 'include',
|
|
58
|
-
headers: {
|
|
59
|
-
'Content-Type': 'application/json',
|
|
60
|
-
'X-Velu-Site-Host': siteHost(host),
|
|
61
|
-
},
|
|
62
|
-
body: JSON.stringify(body),
|
|
63
|
-
});
|
|
64
|
-
} catch {
|
|
65
|
-
/* feedback is best-effort — swallow network errors */
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
return { submit };
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
export default createPageFeedback;
|
|
1
|
+
/**
|
|
2
|
+
* page-feedback — runtime client for the "Was this page helpful?" widget on a
|
|
3
|
+
* published docs site. POSTs to the backend's PUBLIC feedback API:
|
|
4
|
+
*
|
|
5
|
+
* POST /api/v1/public/feedback ({ page_url, helpful, reason_text, details })
|
|
6
|
+
*
|
|
7
|
+
* Same contract as docs-assistant: the tenant is resolved from the
|
|
8
|
+
* `X-Velu-Site-Host` header (falls back to Origin), and the httponly visitor
|
|
9
|
+
* cookie rides along via `credentials: 'include'` (so the API must be same-site
|
|
10
|
+
* with the docs — true for *.getvelu.com subdomains).
|
|
11
|
+
*
|
|
12
|
+
* `createPageFeedback({ apiBase, host })` returns `{ submit }`, shaped to wire
|
|
13
|
+
* straight into <PageFeedback onVote onSubmit>. Returns null without an apiBase
|
|
14
|
+
* (dev preview / unconfigured site) so the widget stays purely visual.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
const trimSlash = (s) => String(s || '').replace(/\/+$/, '');
|
|
18
|
+
|
|
19
|
+
function siteHost(explicit) {
|
|
20
|
+
if (explicit) return explicit;
|
|
21
|
+
return typeof window !== 'undefined' ? window.location.host : '';
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
// The page the feedback is about. Drop hash + query here; the backend
|
|
25
|
+
// normalizes again server-side so per-page aggregation stays clean.
|
|
26
|
+
function currentPageUrl() {
|
|
27
|
+
if (typeof window === 'undefined') return '';
|
|
28
|
+
const { origin, pathname } = window.location;
|
|
29
|
+
return origin + pathname;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export function createPageFeedback({ apiBase, host } = {}) {
|
|
33
|
+
const base = trimSlash(apiBase);
|
|
34
|
+
if (!base) return null;
|
|
35
|
+
const url = `${base}/api/v1/public/feedback`;
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Send one feedback submission.
|
|
39
|
+
* - helpful: boolean (Yes / No)
|
|
40
|
+
* - reason: short label from the "No" form (optional)
|
|
41
|
+
* - detail: free-text elaboration (optional)
|
|
42
|
+
* Best-effort: a failed request never disrupts the reader.
|
|
43
|
+
*/
|
|
44
|
+
async function submit({ helpful, reason, detail } = {}) {
|
|
45
|
+
const body = {
|
|
46
|
+
page_url: currentPageUrl(),
|
|
47
|
+
helpful: !!helpful,
|
|
48
|
+
// reason_text is required by the API (min length 1); fall back to a
|
|
49
|
+
// sensible default when the reader didn't pick a reason (e.g. on "Yes").
|
|
50
|
+
reason_text:
|
|
51
|
+
(reason && String(reason).trim()) || (helpful ? 'Helpful' : 'Not helpful'),
|
|
52
|
+
details: detail ? String(detail) : null,
|
|
53
|
+
};
|
|
54
|
+
try {
|
|
55
|
+
await fetch(url, {
|
|
56
|
+
method: 'POST',
|
|
57
|
+
credentials: 'include',
|
|
58
|
+
headers: {
|
|
59
|
+
'Content-Type': 'application/json',
|
|
60
|
+
'X-Velu-Site-Host': siteHost(host),
|
|
61
|
+
},
|
|
62
|
+
body: JSON.stringify(body),
|
|
63
|
+
});
|
|
64
|
+
} catch {
|
|
65
|
+
/* feedback is best-effort — swallow network errors */
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return { submit };
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export default createPageFeedback;
|