@veluai/velu 0.2.13 → 0.2.15
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 +37 -37
- 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 +122 -122
- 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/Chatbot.jsx +885 -885
- 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 +298 -273
- 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 +254 -254
- 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/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 +94 -94
- package/runtime/velu-ui/components/card.css +105 -105
- package/runtime/velu-ui/components/chatbot.css +622 -622
- package/runtime/velu-ui/components/code-block.css +263 -263
- package/runtime/velu-ui/components/context-menu.css +173 -173
- 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 +241 -241
- 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/index.js +54 -54
- package/runtime/velu-ui/lib/api-send.js +92 -92
- 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 +250 -250
- package/runtime/velu-ui/lib/lang-icons.jsx +147 -147
- package/runtime/velu-ui/lib/pagefind.js +113 -113
- 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 +105 -105
- 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 +46 -46
- package/runtime/velu-ui/tokens.css +4 -4
- package/schema/velu.schema.json +423 -423
- package/src/lib/extract-mdx-error.js +170 -170
- package/src/lib/issues.js +159 -159
- package/src/lib/known-components.js +34 -34
- package/src/navigation.js +443 -443
- package/src/runtime/App.jsx +1669 -1668
- package/src/runtime/ErrorBoundary.jsx +54 -54
- package/src/runtime/client-entry.jsx +22 -22
- package/src/runtime/server-entry.jsx +16 -16
- 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 +41 -41
|
@@ -1,87 +1,87 @@
|
|
|
1
|
-
import React, { useId } from 'react';
|
|
2
|
-
import Cluster from '../primitives/Cluster.jsx';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* ApiField — an input-bearing field for the ApiClient playground.
|
|
6
|
-
*
|
|
7
|
-
* Distinct from <Field> (which is doc-only — it documents a parameter
|
|
8
|
-
* but has no control). ApiField renders a real <input> the user types
|
|
9
|
-
* a value into when trying an endpoint.
|
|
10
|
-
*
|
|
11
|
-
* <ApiSection title="Path">
|
|
12
|
-
* <ApiField name="projectId" type="string" required>
|
|
13
|
-
* Your project ID. Copy it from the API keys page.
|
|
14
|
-
* </ApiField>
|
|
15
|
-
* </ApiSection>
|
|
16
|
-
*
|
|
17
|
-
* Layout — a flex-wrap pair:
|
|
18
|
-
* [ name + type + required ] [ prefix? input ]
|
|
19
|
-
* [ description … ]
|
|
20
|
-
* The info column (label + description) and the control column wrap
|
|
21
|
-
* onto separate lines on narrow widths; no media queries.
|
|
22
|
-
*
|
|
23
|
-
* - `name` parameter identifier (mono, accent)
|
|
24
|
-
* - `type` schema type → grey chip ("string", "boolean", …)
|
|
25
|
-
* - `required` boolean → red "required" pill
|
|
26
|
-
* - `default` pre-fills the input's value
|
|
27
|
-
* - `prefix` static text shown inside the input before the field
|
|
28
|
-
* (e.g. "Bearer" for an Authorization header)
|
|
29
|
-
* - `placeholder` input placeholder (defaults to `enter <name>`)
|
|
30
|
-
* - `value`/`onChange` optional controlled-input wiring; uncontrolled
|
|
31
|
-
* otherwise
|
|
32
|
-
* - `children` description block
|
|
33
|
-
*/
|
|
34
|
-
|
|
35
|
-
export default function ApiField({
|
|
36
|
-
name,
|
|
37
|
-
type,
|
|
38
|
-
required = false,
|
|
39
|
-
default: defaultValue,
|
|
40
|
-
prefix,
|
|
41
|
-
placeholder,
|
|
42
|
-
value,
|
|
43
|
-
onChange,
|
|
44
|
-
children,
|
|
45
|
-
className = '',
|
|
46
|
-
...rest
|
|
47
|
-
}) {
|
|
48
|
-
const inputId = useId();
|
|
49
|
-
const controlled = value !== undefined;
|
|
50
|
-
return (
|
|
51
|
-
<div className={`velu-api-field ${className}`.trim()} {...rest}>
|
|
52
|
-
<div className="velu-api-field__info">
|
|
53
|
-
<Cluster space="var(--s-1)" align="baseline">
|
|
54
|
-
<label className="velu-api-field__name" htmlFor={inputId}>
|
|
55
|
-
{name}
|
|
56
|
-
</label>
|
|
57
|
-
{type != null && (
|
|
58
|
-
<span className="velu-api-field__chip">{type}</span>
|
|
59
|
-
)}
|
|
60
|
-
{required && (
|
|
61
|
-
<span className="velu-api-field__required">required</span>
|
|
62
|
-
)}
|
|
63
|
-
</Cluster>
|
|
64
|
-
{children != null && children !== false && (
|
|
65
|
-
<div className="velu-api-field__desc">{children}</div>
|
|
66
|
-
)}
|
|
67
|
-
</div>
|
|
68
|
-
<div className="velu-api-field__control">
|
|
69
|
-
{prefix != null && (
|
|
70
|
-
<span className="velu-api-field__prefix">{prefix}</span>
|
|
71
|
-
)}
|
|
72
|
-
<input
|
|
73
|
-
id={inputId}
|
|
74
|
-
className="velu-api-field__input"
|
|
75
|
-
type="text"
|
|
76
|
-
placeholder={placeholder ?? `enter ${name}`}
|
|
77
|
-
{...(controlled
|
|
78
|
-
? { value, onChange }
|
|
79
|
-
: {
|
|
80
|
-
defaultValue:
|
|
81
|
-
defaultValue != null ? String(defaultValue) : undefined,
|
|
82
|
-
})}
|
|
83
|
-
/>
|
|
84
|
-
</div>
|
|
85
|
-
</div>
|
|
86
|
-
);
|
|
87
|
-
}
|
|
1
|
+
import React, { useId } from 'react';
|
|
2
|
+
import Cluster from '../primitives/Cluster.jsx';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* ApiField — an input-bearing field for the ApiClient playground.
|
|
6
|
+
*
|
|
7
|
+
* Distinct from <Field> (which is doc-only — it documents a parameter
|
|
8
|
+
* but has no control). ApiField renders a real <input> the user types
|
|
9
|
+
* a value into when trying an endpoint.
|
|
10
|
+
*
|
|
11
|
+
* <ApiSection title="Path">
|
|
12
|
+
* <ApiField name="projectId" type="string" required>
|
|
13
|
+
* Your project ID. Copy it from the API keys page.
|
|
14
|
+
* </ApiField>
|
|
15
|
+
* </ApiSection>
|
|
16
|
+
*
|
|
17
|
+
* Layout — a flex-wrap pair:
|
|
18
|
+
* [ name + type + required ] [ prefix? input ]
|
|
19
|
+
* [ description … ]
|
|
20
|
+
* The info column (label + description) and the control column wrap
|
|
21
|
+
* onto separate lines on narrow widths; no media queries.
|
|
22
|
+
*
|
|
23
|
+
* - `name` parameter identifier (mono, accent)
|
|
24
|
+
* - `type` schema type → grey chip ("string", "boolean", …)
|
|
25
|
+
* - `required` boolean → red "required" pill
|
|
26
|
+
* - `default` pre-fills the input's value
|
|
27
|
+
* - `prefix` static text shown inside the input before the field
|
|
28
|
+
* (e.g. "Bearer" for an Authorization header)
|
|
29
|
+
* - `placeholder` input placeholder (defaults to `enter <name>`)
|
|
30
|
+
* - `value`/`onChange` optional controlled-input wiring; uncontrolled
|
|
31
|
+
* otherwise
|
|
32
|
+
* - `children` description block
|
|
33
|
+
*/
|
|
34
|
+
|
|
35
|
+
export default function ApiField({
|
|
36
|
+
name,
|
|
37
|
+
type,
|
|
38
|
+
required = false,
|
|
39
|
+
default: defaultValue,
|
|
40
|
+
prefix,
|
|
41
|
+
placeholder,
|
|
42
|
+
value,
|
|
43
|
+
onChange,
|
|
44
|
+
children,
|
|
45
|
+
className = '',
|
|
46
|
+
...rest
|
|
47
|
+
}) {
|
|
48
|
+
const inputId = useId();
|
|
49
|
+
const controlled = value !== undefined;
|
|
50
|
+
return (
|
|
51
|
+
<div className={`velu-api-field ${className}`.trim()} {...rest}>
|
|
52
|
+
<div className="velu-api-field__info">
|
|
53
|
+
<Cluster space="var(--s-1)" align="baseline">
|
|
54
|
+
<label className="velu-api-field__name" htmlFor={inputId}>
|
|
55
|
+
{name}
|
|
56
|
+
</label>
|
|
57
|
+
{type != null && (
|
|
58
|
+
<span className="velu-api-field__chip">{type}</span>
|
|
59
|
+
)}
|
|
60
|
+
{required && (
|
|
61
|
+
<span className="velu-api-field__required">required</span>
|
|
62
|
+
)}
|
|
63
|
+
</Cluster>
|
|
64
|
+
{children != null && children !== false && (
|
|
65
|
+
<div className="velu-api-field__desc">{children}</div>
|
|
66
|
+
)}
|
|
67
|
+
</div>
|
|
68
|
+
<div className="velu-api-field__control">
|
|
69
|
+
{prefix != null && (
|
|
70
|
+
<span className="velu-api-field__prefix">{prefix}</span>
|
|
71
|
+
)}
|
|
72
|
+
<input
|
|
73
|
+
id={inputId}
|
|
74
|
+
className="velu-api-field__input"
|
|
75
|
+
type="text"
|
|
76
|
+
placeholder={placeholder ?? `enter ${name}`}
|
|
77
|
+
{...(controlled
|
|
78
|
+
? { value, onChange }
|
|
79
|
+
: {
|
|
80
|
+
defaultValue:
|
|
81
|
+
defaultValue != null ? String(defaultValue) : undefined,
|
|
82
|
+
})}
|
|
83
|
+
/>
|
|
84
|
+
</div>
|
|
85
|
+
</div>
|
|
86
|
+
);
|
|
87
|
+
}
|
|
@@ -1,63 +1,63 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
import Cluster from '../primitives/Cluster.jsx';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* ApiPath — monospace URL path renderer. The path is split into two
|
|
6
|
-
* kinds of segments and laid out via <Cluster>:
|
|
7
|
-
*
|
|
8
|
-
* - hardcoded segment the static chunks ("/project/preview/")
|
|
9
|
-
* - dynamic segment the {param} placeholders (rendered as
|
|
10
|
-
* method-tinted pills)
|
|
11
|
-
*
|
|
12
|
-
* <ApiPath method="POST" path="/project/preview/{projectId}" />
|
|
13
|
-
* → [ "/project/preview/" ] [ {projectId} ]
|
|
14
|
-
*
|
|
15
|
-
* Hardcoded chunks stay intact (never break mid-text), so narrow widths
|
|
16
|
-
* wrap between segments rather than mid-word. Dynamic pills wrap to a
|
|
17
|
-
* new line as a unit.
|
|
18
|
-
*/
|
|
19
|
-
|
|
20
|
-
const METHODS = ['get', 'post', 'put', 'patch', 'delete'];
|
|
21
|
-
|
|
22
|
-
export default function ApiPath({
|
|
23
|
-
method = 'GET',
|
|
24
|
-
path = '',
|
|
25
|
-
className = '',
|
|
26
|
-
...rest
|
|
27
|
-
}) {
|
|
28
|
-
const key = String(method).toLowerCase();
|
|
29
|
-
const safe = METHODS.includes(key) ? key : 'get';
|
|
30
|
-
|
|
31
|
-
// Split only on {param} groups — keep the hardcoded text between
|
|
32
|
-
// params as single segments so narrow-width wrapping breaks at the
|
|
33
|
-
// segment boundary, never mid-word.
|
|
34
|
-
const tokens = String(path).split(/(\{[^}]+\})/).filter(Boolean);
|
|
35
|
-
|
|
36
|
-
return (
|
|
37
|
-
<Cluster
|
|
38
|
-
as="span"
|
|
39
|
-
space="var(--s-2)"
|
|
40
|
-
align="center"
|
|
41
|
-
className={`velu-api-path ${className}`.trim()}
|
|
42
|
-
{...rest}
|
|
43
|
-
>
|
|
44
|
-
{tokens.map((tok, i) => {
|
|
45
|
-
if (tok.startsWith('{') && tok.endsWith('}')) {
|
|
46
|
-
return (
|
|
47
|
-
<span
|
|
48
|
-
key={i}
|
|
49
|
-
className={`velu-api-path__param velu-api-path__param--${safe}`}
|
|
50
|
-
>
|
|
51
|
-
{tok}
|
|
52
|
-
</span>
|
|
53
|
-
);
|
|
54
|
-
}
|
|
55
|
-
return (
|
|
56
|
-
<span key={i} className="velu-api-path__segment">
|
|
57
|
-
{tok}
|
|
58
|
-
</span>
|
|
59
|
-
);
|
|
60
|
-
})}
|
|
61
|
-
</Cluster>
|
|
62
|
-
);
|
|
63
|
-
}
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import Cluster from '../primitives/Cluster.jsx';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* ApiPath — monospace URL path renderer. The path is split into two
|
|
6
|
+
* kinds of segments and laid out via <Cluster>:
|
|
7
|
+
*
|
|
8
|
+
* - hardcoded segment the static chunks ("/project/preview/")
|
|
9
|
+
* - dynamic segment the {param} placeholders (rendered as
|
|
10
|
+
* method-tinted pills)
|
|
11
|
+
*
|
|
12
|
+
* <ApiPath method="POST" path="/project/preview/{projectId}" />
|
|
13
|
+
* → [ "/project/preview/" ] [ {projectId} ]
|
|
14
|
+
*
|
|
15
|
+
* Hardcoded chunks stay intact (never break mid-text), so narrow widths
|
|
16
|
+
* wrap between segments rather than mid-word. Dynamic pills wrap to a
|
|
17
|
+
* new line as a unit.
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
const METHODS = ['get', 'post', 'put', 'patch', 'delete'];
|
|
21
|
+
|
|
22
|
+
export default function ApiPath({
|
|
23
|
+
method = 'GET',
|
|
24
|
+
path = '',
|
|
25
|
+
className = '',
|
|
26
|
+
...rest
|
|
27
|
+
}) {
|
|
28
|
+
const key = String(method).toLowerCase();
|
|
29
|
+
const safe = METHODS.includes(key) ? key : 'get';
|
|
30
|
+
|
|
31
|
+
// Split only on {param} groups — keep the hardcoded text between
|
|
32
|
+
// params as single segments so narrow-width wrapping breaks at the
|
|
33
|
+
// segment boundary, never mid-word.
|
|
34
|
+
const tokens = String(path).split(/(\{[^}]+\})/).filter(Boolean);
|
|
35
|
+
|
|
36
|
+
return (
|
|
37
|
+
<Cluster
|
|
38
|
+
as="span"
|
|
39
|
+
space="var(--s-2)"
|
|
40
|
+
align="center"
|
|
41
|
+
className={`velu-api-path ${className}`.trim()}
|
|
42
|
+
{...rest}
|
|
43
|
+
>
|
|
44
|
+
{tokens.map((tok, i) => {
|
|
45
|
+
if (tok.startsWith('{') && tok.endsWith('}')) {
|
|
46
|
+
return (
|
|
47
|
+
<span
|
|
48
|
+
key={i}
|
|
49
|
+
className={`velu-api-path__param velu-api-path__param--${safe}`}
|
|
50
|
+
>
|
|
51
|
+
{tok}
|
|
52
|
+
</span>
|
|
53
|
+
);
|
|
54
|
+
}
|
|
55
|
+
return (
|
|
56
|
+
<span key={i} className="velu-api-path__segment">
|
|
57
|
+
{tok}
|
|
58
|
+
</span>
|
|
59
|
+
);
|
|
60
|
+
})}
|
|
61
|
+
</Cluster>
|
|
62
|
+
);
|
|
63
|
+
}
|