@veluai/velu 0.1.0

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.
Files changed (90) hide show
  1. package/dist/cli.js +11 -0
  2. package/package.json +52 -0
  3. package/runtime/velu-ui/base.css +311 -0
  4. package/runtime/velu-ui/components/Accordion.jsx +64 -0
  5. package/runtime/velu-ui/components/ApiClient.jsx +121 -0
  6. package/runtime/velu-ui/components/ApiField.jsx +87 -0
  7. package/runtime/velu-ui/components/ApiPath.jsx +63 -0
  8. package/runtime/velu-ui/components/ApiSidebar.jsx +122 -0
  9. package/runtime/velu-ui/components/AskBar.jsx +71 -0
  10. package/runtime/velu-ui/components/Callout.jsx +114 -0
  11. package/runtime/velu-ui/components/Card.jsx +131 -0
  12. package/runtime/velu-ui/components/Chatbot.jsx +596 -0
  13. package/runtime/velu-ui/components/CodeBlock.jsx +375 -0
  14. package/runtime/velu-ui/components/Columns.jsx +56 -0
  15. package/runtime/velu-ui/components/Field.jsx +81 -0
  16. package/runtime/velu-ui/components/Image.jsx +163 -0
  17. package/runtime/velu-ui/components/MethodBadge.jsx +31 -0
  18. package/runtime/velu-ui/components/NavSelect.jsx +108 -0
  19. package/runtime/velu-ui/components/PageFeedback.jsx +219 -0
  20. package/runtime/velu-ui/components/PageFooter.jsx +213 -0
  21. package/runtime/velu-ui/components/PageHeader.jsx +414 -0
  22. package/runtime/velu-ui/components/PageNav.jsx +77 -0
  23. package/runtime/velu-ui/components/PoweredBy.jsx +51 -0
  24. package/runtime/velu-ui/components/Prompt.jsx +115 -0
  25. package/runtime/velu-ui/components/Search.jsx +366 -0
  26. package/runtime/velu-ui/components/Sidebar.jsx +191 -0
  27. package/runtime/velu-ui/components/Steps.jsx +65 -0
  28. package/runtime/velu-ui/components/ThemeToggle.jsx +48 -0
  29. package/runtime/velu-ui/components/Toc.jsx +537 -0
  30. package/runtime/velu-ui/components/TocBar.jsx +195 -0
  31. package/runtime/velu-ui/components/Tree.jsx +87 -0
  32. package/runtime/velu-ui/components/TryItBar.jsx +90 -0
  33. package/runtime/velu-ui/components/accordion.css +92 -0
  34. package/runtime/velu-ui/components/api.css +479 -0
  35. package/runtime/velu-ui/components/ask-bar.css +94 -0
  36. package/runtime/velu-ui/components/card.css +105 -0
  37. package/runtime/velu-ui/components/chatbot.css +617 -0
  38. package/runtime/velu-ui/components/code-block.css +263 -0
  39. package/runtime/velu-ui/components/docs-layout.css +775 -0
  40. package/runtime/velu-ui/components/field.css +82 -0
  41. package/runtime/velu-ui/components/image.css +237 -0
  42. package/runtime/velu-ui/components/nav-select.css +157 -0
  43. package/runtime/velu-ui/components/page-feedback.css +241 -0
  44. package/runtime/velu-ui/components/page-footer.css +130 -0
  45. package/runtime/velu-ui/components/page-header.css +520 -0
  46. package/runtime/velu-ui/components/page-nav.css +50 -0
  47. package/runtime/velu-ui/components/powered-by.css +66 -0
  48. package/runtime/velu-ui/components/prompt.css +99 -0
  49. package/runtime/velu-ui/components/search.css +307 -0
  50. package/runtime/velu-ui/components/sidebar.css +144 -0
  51. package/runtime/velu-ui/components/steps.css +77 -0
  52. package/runtime/velu-ui/components/theme-toggle.css +70 -0
  53. package/runtime/velu-ui/components/toc-bar.css +234 -0
  54. package/runtime/velu-ui/components/tree.css +49 -0
  55. package/runtime/velu-ui/index.js +45 -0
  56. package/runtime/velu-ui/lib/copyText.js +64 -0
  57. package/runtime/velu-ui/lib/lang-icons.jsx +156 -0
  58. package/runtime/velu-ui/lib/prism-langs.js +957 -0
  59. package/runtime/velu-ui/lib/prism-loader.js +74 -0
  60. package/runtime/velu-ui/lib/resolveIcon.jsx +29 -0
  61. package/runtime/velu-ui/lib/scrollIntoNearestView.js +66 -0
  62. package/runtime/velu-ui/mdx-components.jsx +85 -0
  63. package/runtime/velu-ui/primitives/Cluster.jsx +49 -0
  64. package/runtime/velu-ui/primitives/Stack.jsx +63 -0
  65. package/runtime/velu-ui/primitives/Switcher.jsx +57 -0
  66. package/runtime/velu-ui/primitives/stack.css +3 -0
  67. package/runtime/velu-ui/primitives/switcher.css +25 -0
  68. package/runtime/velu-ui/styles.css +43 -0
  69. package/runtime/velu-ui/tokens.css +4 -0
  70. package/schema/velu.schema.json +167 -0
  71. package/src/navigation.js +434 -0
  72. package/src/runtime/App.jsx +1473 -0
  73. package/src/runtime/client-entry.jsx +22 -0
  74. package/src/runtime/server-entry.jsx +16 -0
  75. package/src/template.html +48 -0
  76. package/templates/starter/ai-tools/claude-code.mdx +26 -0
  77. package/templates/starter/ai-tools/cursor.mdx +17 -0
  78. package/templates/starter/api-reference/endpoint/create.mdx +24 -0
  79. package/templates/starter/api-reference/endpoint/get.mdx +27 -0
  80. package/templates/starter/api-reference/introduction.mdx +28 -0
  81. package/templates/starter/development.mdx +19 -0
  82. package/templates/starter/essentials/code.mdx +28 -0
  83. package/templates/starter/essentials/images.mdx +29 -0
  84. package/templates/starter/essentials/markdown.mdx +25 -0
  85. package/templates/starter/essentials/navigation.mdx +39 -0
  86. package/templates/starter/essentials/settings.mdx +30 -0
  87. package/templates/starter/favicon.svg +6 -0
  88. package/templates/starter/index.mdx +31 -0
  89. package/templates/starter/quickstart.mdx +31 -0
  90. package/templates/starter/velu.json +33 -0
@@ -0,0 +1,195 @@
1
+ import React from 'react';
2
+ import { ChevronDown } from 'lucide-react';
3
+ import scrollIntoNearestView from '../lib/scrollIntoNearestView.js';
4
+
5
+ /**
6
+ * TocBar — narrow-layout counterpart to <Toc>.
7
+ *
8
+ * Same data contract as <Toc> (`items`, `activeId`, `onSelect`), but
9
+ * renders as a single sticky bar above the article that expands into a
10
+ * vertical list on click. Used in the tablet layout where the right
11
+ * rail is hidden by a container query — the bar is the only TOC at
12
+ * narrow widths.
13
+ *
14
+ * The component is always rendered; visibility is controlled by CSS
15
+ * (`@container docs (max-width: 1024px)` in toc-bar.css). That way
16
+ * the page hierarchy/state is identical at every viewport size — no
17
+ * JS branching, no hydration mismatch.
18
+ *
19
+ * @typedef {Object} TocItem
20
+ * @property {string} id
21
+ * @property {string} label
22
+ * @property {TocItem[]} [children]
23
+ *
24
+ * @param {{ items: TocItem[], activeId?: string,
25
+ * onSelect?: (id: string) => void, className?: string }} props
26
+ */
27
+
28
+ function flatten(nodes, depth = 0, out = []) {
29
+ for (const n of nodes) {
30
+ out.push({ id: n.id, label: n.label, depth });
31
+ if (n.children) flatten(n.children, depth + 1, out);
32
+ }
33
+ return out;
34
+ }
35
+
36
+ /* Circular read-progress indicator. SVG circle whose stroke-dasharray
37
+ fills proportionally to the page's scroll progress (0 → 1). The
38
+ ring sits at the leading edge of the bar's toggle row and replaces
39
+ what was previously a static accent dot.
40
+
41
+ `progress` is computed in the parent and passed through here so
42
+ this component stays purely presentational (SSR-safe — no window
43
+ reads). */
44
+ function ProgressRing({ progress }) {
45
+ // 24×24 viewBox with a 10-radius circle ≈ 62.83 perimeter.
46
+ const r = 10;
47
+ const c = 2 * Math.PI * r;
48
+ const dash = Math.max(0, Math.min(1, progress)) * c;
49
+ return (
50
+ <svg
51
+ className="velu-toc-bar__progress"
52
+ viewBox="0 0 24 24"
53
+ aria-hidden="true"
54
+ focusable="false"
55
+ >
56
+ {/* Background ring — faint, themed. */}
57
+ <circle
58
+ cx="12"
59
+ cy="12"
60
+ r={r}
61
+ fill="none"
62
+ stroke="var(--border-color)"
63
+ strokeWidth="2"
64
+ />
65
+ {/* Filled arc — starts at 12 o'clock (rotate -90deg). */}
66
+ <circle
67
+ cx="12"
68
+ cy="12"
69
+ r={r}
70
+ fill="none"
71
+ stroke="var(--accent-color)"
72
+ strokeWidth="2"
73
+ strokeLinecap="round"
74
+ strokeDasharray={`${dash} ${c}`}
75
+ transform="rotate(-90 12 12)"
76
+ />
77
+ </svg>
78
+ );
79
+ }
80
+
81
+ export default function TocBar({
82
+ items = [],
83
+ activeId,
84
+ onSelect = () => {},
85
+ className = '',
86
+ ...rest
87
+ }) {
88
+ const [expanded, setExpanded] = React.useState(false);
89
+
90
+ // Reading progress through the page: scrollY / (scrollable-distance).
91
+ // Listens to window scroll + resize; clamped to [0, 1]. Stays at 0
92
+ // on the server (no window) — matches the SSR-rendered ring (empty
93
+ // arc) on first paint, no hydration mismatch.
94
+ const [progress, setProgress] = React.useState(0);
95
+ React.useEffect(() => {
96
+ if (typeof window === 'undefined') return;
97
+ const update = () => {
98
+ const max = Math.max(
99
+ 1,
100
+ document.documentElement.scrollHeight - window.innerHeight,
101
+ );
102
+ setProgress(Math.max(0, Math.min(1, window.scrollY / max)));
103
+ };
104
+ update();
105
+ window.addEventListener('scroll', update, { passive: true });
106
+ window.addEventListener('resize', update);
107
+ return () => {
108
+ window.removeEventListener('scroll', update);
109
+ window.removeEventListener('resize', update);
110
+ };
111
+ }, []);
112
+
113
+ const flat = React.useMemo(() => flatten(items), [items]);
114
+ // Header label tracks the active section: as the reader scrolls and
115
+ // the scroll-spy promotes the next heading, the collapsed bar
116
+ // updates to show where they are right now. Falls back to the root
117
+ // label (typically the page title) when nothing is active yet — and
118
+ // to "On this page" if the tree has no root either.
119
+ const root = items[0];
120
+ const activeLabel = React.useMemo(() => {
121
+ if (activeId == null) return null;
122
+ const hit = flat.find((f) => f.id === activeId);
123
+ return hit?.label ?? null;
124
+ }, [flat, activeId]);
125
+ const headerLabel = activeLabel ?? root?.label ?? 'On this page';
126
+
127
+ // When the user picks a row, collapse the bar so the dropdown
128
+ // doesn't cover the article. The dropdown is `position: absolute`
129
+ // overlay (see toc-bar.css), so collapsing it does NOT reflow
130
+ // the article — onSelect's scroll target stays valid whether we
131
+ // call it before or after `setExpanded(false)`.
132
+ const handleSelect = (id) => {
133
+ setExpanded(false);
134
+ onSelect(id);
135
+ };
136
+
137
+ // Auto-scroll the active row inside the expanded list, same util the
138
+ // right-rail Toc uses — keeps the active item visible if the list is
139
+ // long enough to scroll inside the bar.
140
+ const rootRef = React.useRef(null);
141
+ React.useEffect(() => {
142
+ if (!expanded || activeId == null) return;
143
+ const el = rootRef.current?.querySelector('[data-toc-bar-active="true"]');
144
+ scrollIntoNearestView(el);
145
+ }, [expanded, activeId]);
146
+
147
+ return (
148
+ <div
149
+ ref={rootRef}
150
+ className={`velu-toc-bar ${className}`.trim()}
151
+ data-expanded={expanded ? 'true' : 'false'}
152
+ {...rest}
153
+ >
154
+ <button
155
+ type="button"
156
+ className="velu-toc-bar__toggle"
157
+ onClick={() => setExpanded((v) => !v)}
158
+ aria-expanded={expanded}
159
+ >
160
+ {/* Reading-progress ring — fills as the reader scrolls. */}
161
+ <ProgressRing progress={progress} />
162
+ <span className="velu-toc-bar__title">{headerLabel}</span>
163
+ <ChevronDown
164
+ className="velu-toc-bar__chevron"
165
+ aria-hidden="true"
166
+ focusable="false"
167
+ />
168
+ </button>
169
+ {/* The list is ALWAYS in the DOM so CSS can transition between
170
+ collapsed and expanded states. Visibility is driven by the
171
+ parent's `data-expanded` attribute via CSS, not by
172
+ conditional rendering. `aria-hidden` keeps the collapsed
173
+ list out of the accessibility tree. */}
174
+ <ul className="velu-toc-bar__list" aria-hidden={!expanded}>
175
+ {flat.map((item) => {
176
+ const active = item.id === activeId;
177
+ return (
178
+ <li
179
+ key={item.id}
180
+ className={`velu-toc-bar__item${active ? ' velu-toc-bar__item--active' : ''}`}
181
+ style={{
182
+ paddingInlineStart: `calc(var(--s2) + ${item.depth} * var(--s1))`,
183
+ }}
184
+ data-toc-bar-active={active ? 'true' : undefined}
185
+ onClick={() => handleSelect(item.id)}
186
+ tabIndex={expanded ? 0 : -1}
187
+ >
188
+ {item.label}
189
+ </li>
190
+ );
191
+ })}
192
+ </ul>
193
+ </div>
194
+ );
195
+ }
@@ -0,0 +1,87 @@
1
+ import React from 'react';
2
+ import resolveIcon from '../lib/resolveIcon.jsx';
3
+
4
+ /**
5
+ * Tree + Folder + File — file-tree display with nestable folders.
6
+ *
7
+ * <Tree>
8
+ * <Folder name="app">
9
+ * <File name="layout.tsx" />
10
+ * <File name="page.tsx" />
11
+ * <Folder name="api">
12
+ * <File name="route.ts" />
13
+ * </Folder>
14
+ * </Folder>
15
+ * <File name="package.json" />
16
+ * </Tree>
17
+ *
18
+ * Each Folder may carry children (more Folders/Files); the inner
19
+ * <div className="velu-tree__nest"> draws a vertical rail on its
20
+ * inline-start edge to connect siblings.
21
+ *
22
+ * `icon` accepts a lucide id string (defaults: `folder` / `file`) or any
23
+ * React node — same `resolveIcon` convention as Sidebar / Card / etc.
24
+ */
25
+
26
+ export default function Tree({ children, className = '', ...rest }) {
27
+ return (
28
+ <div className={`velu-tree ${className}`.trim()} {...rest}>
29
+ {children}
30
+ </div>
31
+ );
32
+ }
33
+
34
+ function ItemIcon({ icon }) {
35
+ return (
36
+ <span className="velu-tree__icon" aria-hidden="true">
37
+ {typeof icon === 'string'
38
+ ? resolveIcon(icon, { size: '1em' })
39
+ : icon}
40
+ </span>
41
+ );
42
+ }
43
+
44
+ export function Folder({
45
+ name,
46
+ icon = 'folder',
47
+ defaultOpen = true,
48
+ children,
49
+ className = '',
50
+ ...rest
51
+ }) {
52
+ // Native <details>/<summary>: zero JS, SSR-safe, accessible. Click
53
+ // anywhere on the folder row toggles. CSS hides the children when
54
+ // the <details> is not [open], so the rail collapses with them.
55
+ return (
56
+ <details
57
+ className={`velu-tree__group ${className}`.trim()}
58
+ open={defaultOpen || undefined}
59
+ {...rest}
60
+ >
61
+ <summary className="velu-tree__item velu-tree__item--folder">
62
+ <ItemIcon icon={icon} />
63
+ <span className="velu-tree__label">{name}</span>
64
+ </summary>
65
+ {children != null && children !== false && (
66
+ <div className="velu-tree__nest">{children}</div>
67
+ )}
68
+ </details>
69
+ );
70
+ }
71
+
72
+ export function File({
73
+ name,
74
+ icon = 'file',
75
+ className = '',
76
+ ...rest
77
+ }) {
78
+ return (
79
+ <div
80
+ className={`velu-tree__item velu-tree__item--file ${className}`.trim()}
81
+ {...rest}
82
+ >
83
+ <ItemIcon icon={icon} />
84
+ <span className="velu-tree__label">{name}</span>
85
+ </div>
86
+ );
87
+ }
@@ -0,0 +1,90 @@
1
+ import React, { useState } from 'react';
2
+ import resolveIcon from '../lib/resolveIcon.jsx';
3
+ import Cluster from '../primitives/Cluster.jsx';
4
+ import copyText from '../lib/copyText.js';
5
+ import MethodBadge from './MethodBadge.jsx';
6
+ import ApiPath from './ApiPath.jsx';
7
+
8
+ /**
9
+ * TryItBar — compact endpoint row: method badge + path + copy icon + a
10
+ * method-colored "Try It" CTA. Mirrors Mintlify's docs "try-it" row.
11
+ *
12
+ * <TryItBar method="POST" path="/project/preview/{projectId}" />
13
+ *
14
+ * CTA is a dummy `<button>` (no fetch / playground wiring) — slot a
15
+ * handler in via the `onTry` prop when there's a real client. Copy
16
+ * writes the full "METHOD path" string to clipboard.
17
+ */
18
+
19
+ export default function TryItBar({
20
+ method = 'GET',
21
+ path = '',
22
+ cta = 'Try It',
23
+ onTry,
24
+ className = '',
25
+ ...rest
26
+ }) {
27
+ const [copied, setCopied] = useState(false);
28
+ const key = String(method).toLowerCase();
29
+
30
+ function copy() {
31
+ copyText(`${String(method).toUpperCase()} ${path}`).then(
32
+ () => {
33
+ setCopied(true);
34
+ setTimeout(() => setCopied(false), 1400);
35
+ },
36
+ () => {
37
+ /* silently no-op */
38
+ },
39
+ );
40
+ }
41
+
42
+ const cls = `velu-try-it velu-try-it--${key} ${className}`.trim();
43
+
44
+ return (
45
+ // Outer bar is a Cluster — the inner bordered row and the Try It
46
+ // button are its two children, so they wrap as a unit on narrow
47
+ // widths (Try It drops below the row).
48
+ <Cluster
49
+ space="var(--s-1)"
50
+ justify="flex-end"
51
+ align="center"
52
+ className={cls}
53
+ {...rest}
54
+ >
55
+ {/* Inner bordered group. The method pill + url segments live in
56
+ their own Cluster that wraps internally; the copy button is a
57
+ separate sibling pinned to the top-right (align-self:
58
+ flex-start) so it never drops below the wrapped path. */}
59
+ <div className="velu-try-it__row">
60
+ <Cluster
61
+ space="var(--s-1)"
62
+ align="center"
63
+ className="velu-try-it__endpoint"
64
+ >
65
+ <MethodBadge method={method} />
66
+ <ApiPath method={method} path={path} />
67
+ </Cluster>
68
+ <button
69
+ type="button"
70
+ className="velu-try-it__copy"
71
+ onClick={copy}
72
+ aria-label={copied ? 'Copied' : 'Copy endpoint'}
73
+ title={copied ? 'Copied' : 'Copy'}
74
+ >
75
+ {resolveIcon(copied ? 'check' : 'copy', { size: '1em' })}
76
+ </button>
77
+ </div>
78
+ <button
79
+ type="button"
80
+ className="velu-try-it__cta"
81
+ onClick={onTry}
82
+ >
83
+ {cta}
84
+ <span className="velu-try-it__cta-icon" aria-hidden="true">
85
+ {resolveIcon('chevron-right', { size: '1em' })}
86
+ </span>
87
+ </button>
88
+ </Cluster>
89
+ );
90
+ }
@@ -0,0 +1,92 @@
1
+ /* Accordion — all values are tokens; light/dark via [data-theme].
2
+ Selectors required (summary:hover, [open], chevron rotate, group
3
+ dividers) so this component has CSS, like sidebar.css. Namespaced. */
4
+
5
+ .velu-accordion {
6
+ border: var(--border-width) solid var(--border-color);
7
+ border-radius: var(--radius-sm);
8
+ overflow: hidden; /* clip header tint + dividers to the rounded corners */
9
+ /* `<details>` isn't in base.css's `max-width: none` override list, so
10
+ it'd otherwise clamp to --measure (66ch). Opt out so the accordion
11
+ fills the article column. Same fix is applied to the group below. */
12
+ max-inline-size: none;
13
+ inline-size: 100%;
14
+ }
15
+
16
+ .velu-accordion__summary {
17
+ display: flex;
18
+ align-items: center;
19
+ gap: var(--s-2);
20
+ /* matches Callout padding exactly: --s0 block, --s3 inline */
21
+ padding: var(--s0) var(--s3);
22
+ cursor: pointer;
23
+ list-style: none; /* removes the native disclosure triangle */
24
+ color: var(--text-color);
25
+ font-size: var(--f-body);
26
+ line-height: var(--lh-body);
27
+ /* `<summary>` isn't in base.css's `max-width: none` override list,
28
+ so without this it'd clamp to --measure (66ch) and the hover
29
+ surface would stop short of the accordion's right edge. */
30
+ max-inline-size: none;
31
+ inline-size: 100%;
32
+ box-sizing: border-box;
33
+ }
34
+ .velu-accordion__summary::-webkit-details-marker {
35
+ display: none;
36
+ }
37
+ .velu-accordion__summary:hover {
38
+ background: var(--surface-color);
39
+ }
40
+ .velu-accordion[open] > .velu-accordion__summary {
41
+ background: var(--surface-color);
42
+ }
43
+
44
+ .velu-accordion__chevron {
45
+ display: inline-flex;
46
+ flex: none;
47
+ align-items: center;
48
+ justify-content: center;
49
+ inline-size: var(--f-body);
50
+ block-size: var(--f-body);
51
+ transition: transform 0.15s ease;
52
+ }
53
+ .velu-accordion[open] > .velu-accordion__summary .velu-accordion__chevron {
54
+ transform: rotate(90deg);
55
+ }
56
+
57
+ .velu-accordion__content {
58
+ /* same inline padding as the header so body text aligns under it */
59
+ padding: var(--s0) var(--s3);
60
+ border-top: var(--border-width) solid var(--border-color); /* header / content divider */
61
+ color: var(--text-color);
62
+ font-size: var(--f-body);
63
+ line-height: var(--lh-body);
64
+ /* Same reason as `__summary` above — opt out of base.css's
65
+ --measure cap so the divider line + content area span the full
66
+ accordion width. */
67
+ max-inline-size: none;
68
+ inline-size: 100%;
69
+ box-sizing: border-box;
70
+ }
71
+
72
+ /* Group: many items in ONE bordered box; dividers between; outer radius
73
+ only (children clipped by overflow:hidden). */
74
+ .velu-accordion-group {
75
+ border: var(--border-width) solid var(--border-color);
76
+ border-radius: var(--radius-sm);
77
+ overflow: hidden;
78
+ /* Group is a <div> (already covered by base.css's override), but we
79
+ pin it explicitly here so a future markup swap can't regress. */
80
+ max-inline-size: none;
81
+ inline-size: 100%;
82
+ }
83
+ .velu-accordion--in-group {
84
+ border: 0;
85
+ border-radius: 0;
86
+ overflow: visible;
87
+ }
88
+ .velu-accordion-group
89
+ > .velu-accordion--in-group
90
+ + .velu-accordion--in-group {
91
+ border-top: var(--border-width) solid var(--border-color);
92
+ }