specra 0.1.13 → 0.2.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.
- package/LICENSE.MD +25 -4
- package/README.md +67 -58
- package/config/specra.config.schema.json +16 -0
- package/config/svelte-config.js +63 -0
- package/dist/api-parser.types.d.ts +59 -0
- package/dist/api-parser.types.js +5 -0
- package/dist/api.types.d.ts +137 -0
- package/dist/api.types.js +5 -0
- package/dist/category.d.ts +21 -0
- package/dist/category.js +48 -0
- package/dist/components/ConfigProvider.svelte +13 -0
- package/dist/components/ConfigProvider.svelte.d.ts +31 -0
- package/dist/components/docs/Accordion.svelte +18 -0
- package/dist/components/docs/Accordion.svelte.d.ts +10 -0
- package/dist/components/docs/AccordionItem.svelte +41 -0
- package/dist/components/docs/AccordionItem.svelte.d.ts +10 -0
- package/dist/components/docs/Badge.svelte +28 -0
- package/dist/components/docs/Badge.svelte.d.ts +9 -0
- package/dist/components/docs/Breadcrumb.svelte +80 -0
- package/dist/components/docs/Breadcrumb.svelte.d.ts +8 -0
- package/dist/components/docs/Callout.svelte +96 -0
- package/dist/components/docs/Callout.svelte.d.ts +10 -0
- package/dist/components/docs/Card.svelte +63 -0
- package/dist/components/docs/Card.svelte.d.ts +12 -0
- package/dist/components/docs/CardGrid.svelte +24 -0
- package/dist/components/docs/CardGrid.svelte.d.ts +8 -0
- package/dist/components/docs/CategoryIndex.svelte +110 -0
- package/dist/components/docs/CategoryIndex.svelte.d.ts +29 -0
- package/dist/components/docs/CodeBlock.svelte +172 -0
- package/dist/components/docs/CodeBlock.svelte.d.ts +8 -0
- package/dist/components/docs/Column.svelte +25 -0
- package/dist/components/docs/Column.svelte.d.ts +8 -0
- package/dist/components/docs/Columns.svelte +38 -0
- package/dist/components/docs/Columns.svelte.d.ts +13 -0
- package/dist/components/docs/DevModeBadge.svelte +15 -0
- package/dist/components/docs/DevModeBadge.svelte.d.ts +18 -0
- package/dist/components/docs/DocBadge.svelte +28 -0
- package/dist/components/docs/DocBadge.svelte.d.ts +9 -0
- package/dist/components/docs/DocLayout.svelte +107 -0
- package/dist/components/docs/DocLayout.svelte.d.ts +32 -0
- package/dist/components/docs/DocLoading.svelte +53 -0
- package/dist/components/docs/DocLoading.svelte.d.ts +18 -0
- package/dist/components/docs/DocMetadata.svelte +106 -0
- package/dist/components/docs/DocMetadata.svelte.d.ts +18 -0
- package/dist/components/docs/DocNavigation.svelte +56 -0
- package/dist/components/docs/DocNavigation.svelte.d.ts +12 -0
- package/dist/components/docs/DocTags.svelte +22 -0
- package/dist/components/docs/DocTags.svelte.d.ts +6 -0
- package/dist/components/docs/DraftBadge.svelte +10 -0
- package/dist/components/docs/DraftBadge.svelte.d.ts +18 -0
- package/dist/components/docs/Footer.svelte +72 -0
- package/dist/components/docs/Footer.svelte.d.ts +7 -0
- package/dist/components/docs/Frame.svelte +27 -0
- package/dist/components/docs/Frame.svelte.d.ts +9 -0
- package/dist/components/docs/Header.svelte +123 -0
- package/dist/components/docs/Header.svelte.d.ts +9 -0
- package/dist/components/docs/HeaderWithMenu.svelte +34 -0
- package/dist/components/docs/HeaderWithMenu.svelte.d.ts +17 -0
- package/dist/components/docs/HotReloadIndicator.svelte +44 -0
- package/dist/components/docs/HotReloadIndicator.svelte.d.ts +3 -0
- package/dist/components/docs/Icon.svelte +103 -0
- package/dist/components/docs/Icon.svelte.d.ts +11 -0
- package/dist/components/docs/Image.svelte +88 -0
- package/dist/components/docs/Image.svelte.d.ts +11 -0
- package/dist/components/docs/ImageCard.svelte +91 -0
- package/dist/components/docs/ImageCard.svelte.d.ts +12 -0
- package/dist/components/docs/ImageCardGrid.svelte +25 -0
- package/dist/components/docs/ImageCardGrid.svelte.d.ts +8 -0
- package/dist/components/docs/LayoutProviders.svelte +57 -0
- package/dist/components/docs/LayoutProviders.svelte.d.ts +9 -0
- package/dist/components/docs/Logo.svelte +25 -0
- package/dist/components/docs/Logo.svelte.d.ts +11 -0
- package/dist/components/docs/Math.svelte +54 -0
- package/dist/components/docs/Math.svelte.d.ts +7 -0
- package/dist/components/docs/MdxContent.svelte +41 -0
- package/dist/components/docs/MdxHotReload.svelte +78 -0
- package/dist/components/docs/MdxHotReload.svelte.d.ts +9 -0
- package/dist/components/docs/MdxLayout.svelte +16 -0
- package/dist/components/docs/MdxLayout.svelte.d.ts +6 -0
- package/dist/components/docs/Mermaid.svelte +88 -0
- package/dist/components/docs/Mermaid.svelte.d.ts +7 -0
- package/dist/components/docs/MobileDocLayout.svelte +211 -0
- package/dist/components/docs/MobileDocLayout.svelte.d.ts +35 -0
- package/dist/components/docs/MobileSidebar.svelte +122 -0
- package/dist/components/docs/MobileSidebar.svelte.d.ts +31 -0
- package/dist/components/docs/MobileSidebarWrapper.svelte +122 -0
- package/dist/components/docs/MobileSidebarWrapper.svelte.d.ts +32 -0
- package/dist/components/docs/NotFoundContent.svelte +40 -0
- package/dist/components/docs/NotFoundContent.svelte.d.ts +6 -0
- package/dist/components/docs/SearchHighlight.svelte +116 -0
- package/dist/components/docs/SearchHighlight.svelte.d.ts +3 -0
- package/dist/components/docs/SearchModal.svelte +239 -0
- package/dist/components/docs/SearchModal.svelte.d.ts +9 -0
- package/dist/components/docs/Sidebar.svelte +69 -0
- package/dist/components/docs/Sidebar.svelte.d.ts +31 -0
- package/dist/components/docs/SidebarMenuItems.svelte +344 -0
- package/dist/components/docs/SidebarMenuItems.svelte.d.ts +33 -0
- package/dist/components/docs/SidebarSkeleton.svelte +50 -0
- package/dist/components/docs/SidebarSkeleton.svelte.d.ts +18 -0
- package/dist/components/docs/SiteBanner.svelte +92 -0
- package/dist/components/docs/SiteBanner.svelte.d.ts +7 -0
- package/dist/components/docs/Step.svelte +44 -0
- package/dist/components/docs/Step.svelte.d.ts +8 -0
- package/dist/components/docs/Steps.svelte +15 -0
- package/dist/components/docs/Steps.svelte.d.ts +7 -0
- package/dist/components/docs/Tab.svelte +40 -0
- package/dist/components/docs/Tab.svelte.d.ts +8 -0
- package/dist/components/docs/TabGroups.svelte +183 -0
- package/dist/components/docs/TabGroups.svelte.d.ts +25 -0
- package/dist/components/docs/TableOfContents.svelte +100 -0
- package/dist/components/docs/TableOfContents.svelte.d.ts +9 -0
- package/dist/components/docs/Tabs.svelte +69 -0
- package/dist/components/docs/Tabs.svelte.d.ts +8 -0
- package/dist/components/docs/ThemeToggle.svelte +16 -0
- package/dist/components/docs/ThemeToggle.svelte.d.ts +18 -0
- package/dist/components/docs/Tooltip.svelte +44 -0
- package/dist/components/docs/Tooltip.svelte.d.ts +10 -0
- package/dist/components/docs/VersionSwitcher.svelte +95 -0
- package/dist/components/docs/VersionSwitcher.svelte.d.ts +7 -0
- package/dist/components/docs/Video.svelte +84 -0
- package/dist/components/docs/Video.svelte.d.ts +12 -0
- package/dist/components/docs/api/ApiEndpoint.svelte +61 -0
- package/dist/components/docs/api/ApiEndpoint.svelte.d.ts +11 -0
- package/dist/components/docs/api/ApiParams.svelte +80 -0
- package/dist/components/docs/api/ApiParams.svelte.d.ts +14 -0
- package/dist/components/docs/api/ApiPlayground.svelte +259 -0
- package/dist/components/docs/api/ApiPlayground.svelte.d.ts +16 -0
- package/dist/components/docs/api/ApiReference.svelte +278 -0
- package/dist/components/docs/api/ApiReference.svelte.d.ts +23 -0
- package/dist/components/docs/api/ApiResponse.svelte +66 -0
- package/dist/components/docs/api/ApiResponse.svelte.d.ts +9 -0
- package/dist/components/docs/api/index.d.ts +5 -0
- package/dist/components/docs/api/index.js +5 -0
- package/dist/components/docs/componentTextProps.d.ts +3 -0
- package/dist/components/docs/componentTextProps.js +61 -0
- package/dist/components/docs/index.d.ts +54 -0
- package/dist/components/docs/index.js +56 -0
- package/dist/components/global/VersionNotFound.svelte +48 -0
- package/dist/components/global/VersionNotFound.svelte.d.ts +7 -0
- package/dist/components/global/index.d.ts +1 -0
- package/dist/components/global/index.js +1 -0
- package/dist/components/index.d.ts +6 -822
- package/dist/components/index.js +11 -3854
- package/dist/components/ui/Badge.svelte +48 -0
- package/dist/components/ui/Badge.svelte.d.ts +15 -0
- package/dist/components/ui/Button.svelte +58 -0
- package/dist/components/ui/Button.svelte.d.ts +17 -0
- package/dist/components/ui/Dialog.svelte +16 -0
- package/dist/components/ui/Dialog.svelte.d.ts +9 -0
- package/dist/components/ui/DialogClose.svelte +16 -0
- package/dist/components/ui/DialogClose.svelte.d.ts +9 -0
- package/dist/components/ui/DialogContent.svelte +43 -0
- package/dist/components/ui/DialogContent.svelte.d.ts +10 -0
- package/dist/components/ui/DialogDescription.svelte +21 -0
- package/dist/components/ui/DialogDescription.svelte.d.ts +9 -0
- package/dist/components/ui/DialogFooter.svelte +20 -0
- package/dist/components/ui/DialogFooter.svelte.d.ts +9 -0
- package/dist/components/ui/DialogHeader.svelte +20 -0
- package/dist/components/ui/DialogHeader.svelte.d.ts +9 -0
- package/dist/components/ui/DialogTitle.svelte +21 -0
- package/dist/components/ui/DialogTitle.svelte.d.ts +9 -0
- package/dist/components/ui/Input.svelte +23 -0
- package/dist/components/ui/Input.svelte.d.ts +8 -0
- package/dist/components/ui/Textarea.svelte +19 -0
- package/dist/components/ui/Textarea.svelte.d.ts +7 -0
- package/dist/components/ui/index.d.ts +11 -0
- package/dist/components/ui/index.js +11 -0
- package/dist/config.d.ts +8 -0
- package/dist/config.js +9 -0
- package/dist/config.schema.json +471 -0
- package/dist/config.server.d.ts +46 -0
- package/dist/config.server.js +149 -0
- package/dist/{mdx-ColN3Cyg.d.mts → config.types.d.ts} +22 -75
- package/dist/config.types.js +39 -0
- package/dist/dev-utils.d.ts +29 -0
- package/dist/dev-utils.js +63 -0
- package/dist/index.d.ts +19 -4
- package/dist/index.js +25 -4861
- package/dist/mdx-cache.d.ts +41 -0
- package/dist/mdx-cache.js +160 -0
- package/dist/mdx-components.js +50 -1931
- package/dist/mdx-security.d.ts +76 -0
- package/dist/mdx-security.js +217 -0
- package/dist/mdx.d.ts +73 -0
- package/dist/mdx.js +1099 -0
- package/dist/middleware/index.d.ts +1 -0
- package/dist/middleware/index.js +2 -0
- package/dist/middleware/security.d.ts +22 -47
- package/dist/middleware/security.js +111 -137
- package/dist/parsers/base-parser.d.ts +14 -0
- package/dist/parsers/base-parser.js +1 -0
- package/dist/parsers/index.d.ts +16 -0
- package/dist/parsers/index.js +51 -0
- package/dist/parsers/openapi-parser.d.ts +18 -0
- package/dist/parsers/openapi-parser.js +209 -0
- package/dist/parsers/postman-parser.d.ts +20 -0
- package/dist/parsers/postman-parser.js +260 -0
- package/dist/parsers/specra-parser.d.ts +10 -0
- package/dist/parsers/specra-parser.js +18 -0
- package/dist/redirects.d.ts +12 -0
- package/dist/redirects.js +30 -0
- package/dist/remark-code-meta.d.ts +6 -0
- package/dist/remark-code-meta.js +21 -0
- package/dist/sidebar-utils.d.ts +59 -0
- package/dist/sidebar-utils.js +144 -0
- package/dist/stores/config.d.ts +20 -0
- package/dist/stores/config.js +45 -0
- package/dist/stores/index.d.ts +4 -0
- package/dist/stores/index.js +4 -0
- package/dist/stores/sidebar.d.ts +7 -0
- package/dist/stores/sidebar.js +12 -0
- package/dist/stores/tabs.d.ts +6 -0
- package/dist/stores/tabs.js +41 -0
- package/dist/stores/theme.d.ts +7 -0
- package/dist/stores/theme.js +75 -0
- package/dist/{styles.css → styles/globals.css} +136 -6
- package/dist/toc.d.ts +9 -0
- package/dist/toc.js +15 -0
- package/dist/utils.d.ts +13 -0
- package/dist/utils.js +30 -0
- package/package.json +47 -90
- package/dist/app/api/mdx-watch/route.d.mts +0 -10
- package/dist/app/api/mdx-watch/route.d.ts +0 -10
- package/dist/app/api/mdx-watch/route.js +0 -118
- package/dist/app/api/mdx-watch/route.js.map +0 -1
- package/dist/app/api/mdx-watch/route.mjs +0 -91
- package/dist/app/api/mdx-watch/route.mjs.map +0 -1
- package/dist/chunk-6S3EJVEO.mjs +0 -259
- package/dist/chunk-6S3EJVEO.mjs.map +0 -1
- package/dist/chunk-BE7EROIW.mjs +0 -212
- package/dist/chunk-BE7EROIW.mjs.map +0 -1
- package/dist/chunk-CWHRZHZO.mjs +0 -168
- package/dist/chunk-CWHRZHZO.mjs.map +0 -1
- package/dist/chunk-D5VDVYFY.mjs +0 -1325
- package/dist/chunk-D5VDVYFY.mjs.map +0 -1
- package/dist/chunk-WMCO2UX5.mjs +0 -585
- package/dist/chunk-WMCO2UX5.mjs.map +0 -1
- package/dist/chunk-XEMGCPZZ.mjs +0 -475
- package/dist/chunk-XEMGCPZZ.mjs.map +0 -1
- package/dist/components/index.d.mts +0 -822
- package/dist/components/index.js.map +0 -1
- package/dist/components/index.mjs +0 -3741
- package/dist/components/index.mjs.map +0 -1
- package/dist/index.d.mts +0 -4
- package/dist/index.js.map +0 -1
- package/dist/index.mjs +0 -1897
- package/dist/index.mjs.map +0 -1
- package/dist/layouts/index.d.mts +0 -34
- package/dist/layouts/index.d.ts +0 -34
- package/dist/layouts/index.js +0 -453
- package/dist/layouts/index.js.map +0 -1
- package/dist/layouts/index.mjs +0 -173
- package/dist/layouts/index.mjs.map +0 -1
- package/dist/lib/index.d.mts +0 -583
- package/dist/lib/index.d.ts +0 -583
- package/dist/lib/index.js +0 -1595
- package/dist/lib/index.js.map +0 -1
- package/dist/lib/index.mjs +0 -111
- package/dist/lib/index.mjs.map +0 -1
- package/dist/mdx-ColN3Cyg.d.ts +0 -352
- package/dist/mdx-components.d.mts +0 -86
- package/dist/mdx-components.d.ts +0 -86
- package/dist/mdx-components.js.map +0 -1
- package/dist/mdx-components.mjs +0 -206
- package/dist/mdx-components.mjs.map +0 -1
- package/dist/middleware/security.d.mts +0 -82
- package/dist/middleware/security.js.map +0 -1
- package/dist/middleware/security.mjs +0 -84
- package/dist/middleware/security.mjs.map +0 -1
- package/dist/styles.css.map +0 -1
- package/dist/styles.d.mts +0 -2
- package/dist/styles.d.ts +0 -2
- package/dist/styles.js +0 -2
- package/dist/styles.js.map +0 -1
- package/dist/styles.mjs +0 -1
- package/dist/styles.mjs.map +0 -1
|
@@ -1,822 +0,0 @@
|
|
|
1
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
-
import * as React$1 from 'react';
|
|
3
|
-
import React__default, { ReactNode } from 'react';
|
|
4
|
-
import * as class_variance_authority_types from 'class-variance-authority/types';
|
|
5
|
-
import { VariantProps } from 'class-variance-authority';
|
|
6
|
-
import * as DialogPrimitive from '@radix-ui/react-dialog';
|
|
7
|
-
|
|
8
|
-
interface AccordionItemProps {
|
|
9
|
-
title: string | React$1.ReactNode;
|
|
10
|
-
children: React$1.ReactNode;
|
|
11
|
-
defaultOpen?: boolean;
|
|
12
|
-
value?: string;
|
|
13
|
-
}
|
|
14
|
-
declare function AccordionItem({ title, children, defaultOpen }: AccordionItemProps): react_jsx_runtime.JSX.Element;
|
|
15
|
-
interface AccordionProps {
|
|
16
|
-
children: React$1.ReactNode;
|
|
17
|
-
type?: "single" | "multiple";
|
|
18
|
-
collapsible?: boolean;
|
|
19
|
-
className?: string;
|
|
20
|
-
}
|
|
21
|
-
declare function Accordion({ children, type, className }: AccordionProps): react_jsx_runtime.JSX.Element;
|
|
22
|
-
|
|
23
|
-
interface BadgeProps {
|
|
24
|
-
children: React.ReactNode;
|
|
25
|
-
variant?: "default" | "success" | "warning" | "error" | "info";
|
|
26
|
-
}
|
|
27
|
-
declare function Badge$1({ children, variant }: BadgeProps): react_jsx_runtime.JSX.Element;
|
|
28
|
-
|
|
29
|
-
interface BreadcrumbProps {
|
|
30
|
-
version: string;
|
|
31
|
-
slug: string;
|
|
32
|
-
title: string;
|
|
33
|
-
}
|
|
34
|
-
declare function Breadcrumb({ version, slug, title }: BreadcrumbProps): react_jsx_runtime.JSX.Element;
|
|
35
|
-
|
|
36
|
-
interface CalloutProps {
|
|
37
|
-
children: ReactNode;
|
|
38
|
-
type?: "info" | "warning" | "success" | "error" | "tip" | "note" | "danger";
|
|
39
|
-
title?: string;
|
|
40
|
-
}
|
|
41
|
-
declare function Callout({ children, type, title }: CalloutProps): react_jsx_runtime.JSX.Element;
|
|
42
|
-
|
|
43
|
-
interface CardProps {
|
|
44
|
-
title: string;
|
|
45
|
-
description?: string;
|
|
46
|
-
href?: string;
|
|
47
|
-
icon?: string | React.ReactNode;
|
|
48
|
-
children?: React.ReactNode;
|
|
49
|
-
external?: boolean;
|
|
50
|
-
}
|
|
51
|
-
declare function Card({ title, description, href, icon, children, external }: CardProps): react_jsx_runtime.JSX.Element;
|
|
52
|
-
interface CardGridProps {
|
|
53
|
-
children: React.ReactNode;
|
|
54
|
-
cols?: 1 | 2 | 3;
|
|
55
|
-
}
|
|
56
|
-
declare function CardGrid({ children, cols }: CardGridProps): react_jsx_runtime.JSX.Element;
|
|
57
|
-
|
|
58
|
-
interface CodeBlockProps {
|
|
59
|
-
code: string;
|
|
60
|
-
language: string;
|
|
61
|
-
filename?: string;
|
|
62
|
-
}
|
|
63
|
-
declare function CodeBlock({ code, language, filename }: CodeBlockProps): react_jsx_runtime.JSX.Element;
|
|
64
|
-
|
|
65
|
-
interface ColumnsProps {
|
|
66
|
-
children: React.ReactNode;
|
|
67
|
-
cols?: {
|
|
68
|
-
sm?: 1 | 2 | 3 | 4;
|
|
69
|
-
md?: 1 | 2 | 3 | 4;
|
|
70
|
-
lg?: 1 | 2 | 3 | 4;
|
|
71
|
-
xl?: 1 | 2 | 3 | 4;
|
|
72
|
-
};
|
|
73
|
-
}
|
|
74
|
-
declare function Columns({ children, cols }: ColumnsProps): react_jsx_runtime.JSX.Element;
|
|
75
|
-
interface ColumnProps {
|
|
76
|
-
children: React.ReactNode;
|
|
77
|
-
span?: 1 | 2 | 3 | 4;
|
|
78
|
-
}
|
|
79
|
-
declare function Column({ children, span }: ColumnProps): react_jsx_runtime.JSX.Element;
|
|
80
|
-
|
|
81
|
-
declare const COMPONENT_TEXT_PROPS: Record<string, string[]>;
|
|
82
|
-
declare function extractComponentPropsText(mdx: string): string;
|
|
83
|
-
declare function extractSearchText(mdx: string): string;
|
|
84
|
-
|
|
85
|
-
declare function DevModeBadge(): react_jsx_runtime.JSX.Element | null;
|
|
86
|
-
|
|
87
|
-
/**
|
|
88
|
-
* Configuration schema for Specra documentation system
|
|
89
|
-
*/
|
|
90
|
-
/**
|
|
91
|
-
* Site metadata and branding
|
|
92
|
-
*/
|
|
93
|
-
interface SiteConfig {
|
|
94
|
-
/** The title of the documentation site */
|
|
95
|
-
title: string;
|
|
96
|
-
/** Short description of the documentation */
|
|
97
|
-
description?: string;
|
|
98
|
-
/** URL where the documentation is hosted */
|
|
99
|
-
url?: string;
|
|
100
|
-
/** Base URL path for the documentation (e.g., '/docs') */
|
|
101
|
-
baseUrl?: string;
|
|
102
|
-
/** Path to the site logo - can be a string or an object with light/dark variants */
|
|
103
|
-
logo?: string | {
|
|
104
|
-
light: string;
|
|
105
|
-
dark: string;
|
|
106
|
-
};
|
|
107
|
-
/** Path to the favicon */
|
|
108
|
-
favicon?: string;
|
|
109
|
-
/** Default language for the documentation */
|
|
110
|
-
language?: string;
|
|
111
|
-
/** Organization or author name */
|
|
112
|
-
organizationName?: string;
|
|
113
|
-
/** Project name */
|
|
114
|
-
projectName?: string;
|
|
115
|
-
/** Active/default version for the documentation */
|
|
116
|
-
activeVersion?: string;
|
|
117
|
-
/** Whether to hide the site title in the header */
|
|
118
|
-
hideTitle?: boolean;
|
|
119
|
-
/** Whether to hide the site logo in the header */
|
|
120
|
-
hideLogo?: boolean;
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* Theme and appearance settings
|
|
124
|
-
*/
|
|
125
|
-
interface ThemeConfig {
|
|
126
|
-
/** Primary color for the theme */
|
|
127
|
-
primaryColor?: string;
|
|
128
|
-
/** Default theme mode */
|
|
129
|
-
defaultMode?: "light" | "dark" | "system";
|
|
130
|
-
/** Whether to respect system preferences */
|
|
131
|
-
respectPrefersColorScheme?: boolean;
|
|
132
|
-
/** Custom CSS file path */
|
|
133
|
-
customCss?: string;
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* Tab group for organizing documentation
|
|
137
|
-
*/
|
|
138
|
-
interface TabGroup {
|
|
139
|
-
/** Unique identifier for the tab group */
|
|
140
|
-
id: string;
|
|
141
|
-
/** Display label for the tab */
|
|
142
|
-
label: string;
|
|
143
|
-
/** Optional icon name (lucide-react icon) */
|
|
144
|
-
icon?: string;
|
|
145
|
-
}
|
|
146
|
-
/**
|
|
147
|
-
* Navigation and sidebar configuration
|
|
148
|
-
*/
|
|
149
|
-
interface NavigationConfig {
|
|
150
|
-
/** Whether to show the sidebar by default */
|
|
151
|
-
showSidebar?: boolean;
|
|
152
|
-
/** Whether the sidebar is collapsible */
|
|
153
|
-
collapsibleSidebar?: boolean;
|
|
154
|
-
/** Whether to show breadcrumbs */
|
|
155
|
-
showBreadcrumbs?: boolean;
|
|
156
|
-
/** Whether to show table of contents */
|
|
157
|
-
showTableOfContents?: boolean;
|
|
158
|
-
/** Position of table of contents */
|
|
159
|
-
tocPosition?: "left" | "right";
|
|
160
|
-
/** Maximum depth for table of contents */
|
|
161
|
-
tocMaxDepth?: number;
|
|
162
|
-
/** Tab groups for organizing documentation sections */
|
|
163
|
-
tabGroups?: TabGroup[];
|
|
164
|
-
}
|
|
165
|
-
/**
|
|
166
|
-
* Social and external links
|
|
167
|
-
*/
|
|
168
|
-
interface SocialLinks {
|
|
169
|
-
/** GitHub repository URL */
|
|
170
|
-
github?: string;
|
|
171
|
-
/** Twitter/X handle or URL */
|
|
172
|
-
twitter?: string;
|
|
173
|
-
/** Discord invite URL */
|
|
174
|
-
discord?: string;
|
|
175
|
-
/** LinkedIn profile or company page */
|
|
176
|
-
linkedin?: string;
|
|
177
|
-
/** YouTube channel URL */
|
|
178
|
-
youtube?: string;
|
|
179
|
-
/** Custom social links */
|
|
180
|
-
custom?: Array<{
|
|
181
|
-
label: string;
|
|
182
|
-
url: string;
|
|
183
|
-
icon?: string;
|
|
184
|
-
}>;
|
|
185
|
-
}
|
|
186
|
-
/**
|
|
187
|
-
* Search configuration
|
|
188
|
-
*/
|
|
189
|
-
interface SearchConfig {
|
|
190
|
-
/** Enable/disable search functionality */
|
|
191
|
-
enabled?: boolean;
|
|
192
|
-
/** Placeholder text for search input */
|
|
193
|
-
placeholder?: string;
|
|
194
|
-
/** Search provider type */
|
|
195
|
-
provider?: "meilisearch" | "algolia" | "local";
|
|
196
|
-
/** Meilisearch configuration */
|
|
197
|
-
meilisearch?: {
|
|
198
|
-
/** Meilisearch server URL */
|
|
199
|
-
host: string;
|
|
200
|
-
/** API key for Meilisearch */
|
|
201
|
-
apiKey?: string;
|
|
202
|
-
/** Index name */
|
|
203
|
-
indexName: string;
|
|
204
|
-
};
|
|
205
|
-
}
|
|
206
|
-
/**
|
|
207
|
-
* Analytics configuration
|
|
208
|
-
*/
|
|
209
|
-
interface AnalyticsConfig {
|
|
210
|
-
/** Google Analytics tracking ID */
|
|
211
|
-
googleAnalytics?: string;
|
|
212
|
-
/** Google Tag Manager ID */
|
|
213
|
-
googleTagManager?: string;
|
|
214
|
-
/** Plausible Analytics domain */
|
|
215
|
-
plausible?: string;
|
|
216
|
-
/** Custom analytics scripts */
|
|
217
|
-
custom?: Array<{
|
|
218
|
-
src: string;
|
|
219
|
-
async?: boolean;
|
|
220
|
-
defer?: boolean;
|
|
221
|
-
}>;
|
|
222
|
-
}
|
|
223
|
-
/**
|
|
224
|
-
* Footer branding configuration
|
|
225
|
-
*/
|
|
226
|
-
interface FooterBranding {
|
|
227
|
-
/** Whether to show the branding */
|
|
228
|
-
showBranding?: boolean;
|
|
229
|
-
/** Logo for the branding - can be a string or an object with light/dark variants */
|
|
230
|
-
logo?: string | {
|
|
231
|
-
light: string;
|
|
232
|
-
dark: string;
|
|
233
|
-
};
|
|
234
|
-
/** Title text for the branding */
|
|
235
|
-
title?: string;
|
|
236
|
-
/** URL to link to when branding is clicked */
|
|
237
|
-
url?: string;
|
|
238
|
-
}
|
|
239
|
-
/**
|
|
240
|
-
* Footer configuration
|
|
241
|
-
*/
|
|
242
|
-
interface FooterConfig {
|
|
243
|
-
/** Copyright text */
|
|
244
|
-
copyright?: string;
|
|
245
|
-
/** Footer links organized by columns */
|
|
246
|
-
links?: Array<{
|
|
247
|
-
title: string;
|
|
248
|
-
items: Array<{
|
|
249
|
-
label: string;
|
|
250
|
-
href: string;
|
|
251
|
-
}>;
|
|
252
|
-
}>;
|
|
253
|
-
/** Custom footer content */
|
|
254
|
-
customContent?: string;
|
|
255
|
-
/** Branding configuration for "Powered by" section */
|
|
256
|
-
branding?: FooterBranding;
|
|
257
|
-
}
|
|
258
|
-
/**
|
|
259
|
-
* Documentation features
|
|
260
|
-
*/
|
|
261
|
-
interface FeaturesConfig {
|
|
262
|
-
/**
|
|
263
|
-
* Enable/disable edit this page links.
|
|
264
|
-
* Provide a URL template (e.g., "https://github.com/user/repo/edit/main/docs") or false to disable
|
|
265
|
-
*/
|
|
266
|
-
editUrl?: string | boolean;
|
|
267
|
-
/** Show last updated timestamp */
|
|
268
|
-
showLastUpdated?: boolean;
|
|
269
|
-
/** Show reading time estimate */
|
|
270
|
-
showReadingTime?: boolean;
|
|
271
|
-
/** Show author information */
|
|
272
|
-
showAuthors?: boolean;
|
|
273
|
-
/** Show tags */
|
|
274
|
-
showTags?: boolean;
|
|
275
|
-
/** Enable version dropdown */
|
|
276
|
-
versioning?: boolean;
|
|
277
|
-
/**
|
|
278
|
-
* Internationalization (i18n) configuration
|
|
279
|
-
* Set to true to enable with defaults, or provide configuration object
|
|
280
|
-
*/
|
|
281
|
-
i18n?: boolean | I18nConfig;
|
|
282
|
-
}
|
|
283
|
-
/**
|
|
284
|
-
* Internationalization configuration
|
|
285
|
-
*/
|
|
286
|
-
interface I18nConfig {
|
|
287
|
-
/** The default locale (e.g. 'en') - used when no locale is present in URL */
|
|
288
|
-
defaultLocale: string;
|
|
289
|
-
/** List of supported locales (e.g. ['en', 'fr', 'es']) */
|
|
290
|
-
locales: string[];
|
|
291
|
-
/** Map of locale codes to display names (e.g. { en: "English", fr: "Français" }) */
|
|
292
|
-
localeNames?: Record<string, string>;
|
|
293
|
-
/** Whether to use locale subpaths for default locale (default: false) */
|
|
294
|
-
prefixDefault?: boolean;
|
|
295
|
-
}
|
|
296
|
-
/**
|
|
297
|
-
* Site-wide banner configuration
|
|
298
|
-
*/
|
|
299
|
-
interface BannerConfig {
|
|
300
|
-
/** Whether the banner is enabled */
|
|
301
|
-
enabled?: boolean;
|
|
302
|
-
/** Banner message */
|
|
303
|
-
message?: string;
|
|
304
|
-
/** Banner type */
|
|
305
|
-
type?: "info" | "warning" | "success" | "error";
|
|
306
|
-
/** Whether the banner can be dismissed */
|
|
307
|
-
dismissible?: boolean;
|
|
308
|
-
}
|
|
309
|
-
/**
|
|
310
|
-
* Environment variables that can be used in documentation
|
|
311
|
-
* These will be replaced at build time or runtime
|
|
312
|
-
*/
|
|
313
|
-
interface EnvironmentVariables {
|
|
314
|
-
/** API base URL */
|
|
315
|
-
API_BASE_URL?: string;
|
|
316
|
-
/** API version */
|
|
317
|
-
API_VERSION?: string;
|
|
318
|
-
/** CDN URL */
|
|
319
|
-
CDN_URL?: string;
|
|
320
|
-
/** Custom environment variables */
|
|
321
|
-
[key: string]: string | undefined;
|
|
322
|
-
}
|
|
323
|
-
/**
|
|
324
|
-
* Deployment configuration for different hosting scenarios
|
|
325
|
-
*/
|
|
326
|
-
interface DeploymentConfig {
|
|
327
|
-
/**
|
|
328
|
-
* Deployment target
|
|
329
|
-
* - 'vercel': For Vercel or similar Node.js hosting (uses 'standalone' output)
|
|
330
|
-
* - 'github-pages': For GitHub Pages static hosting (uses 'export' output)
|
|
331
|
-
* - 'static': For any static hosting like Netlify, Cloudflare Pages, etc.
|
|
332
|
-
* - 'custom-domain-static': For static hosting with custom domain (no basePath needed)
|
|
333
|
-
*/
|
|
334
|
-
target?: "vercel" | "github-pages" | "static" | "custom-domain-static";
|
|
335
|
-
/**
|
|
336
|
-
* Base path for assets when deploying to GitHub Pages without custom domain
|
|
337
|
-
* This should be your repository name (e.g., 'my-repo')
|
|
338
|
-
* Only used when target is 'github-pages' and no custom domain is configured
|
|
339
|
-
*/
|
|
340
|
-
basePath?: string;
|
|
341
|
-
/**
|
|
342
|
-
* Whether a custom domain is configured
|
|
343
|
-
* When true, basePath will be ignored even for GitHub Pages
|
|
344
|
-
*/
|
|
345
|
-
customDomain?: boolean;
|
|
346
|
-
}
|
|
347
|
-
/**
|
|
348
|
-
* Main configuration interface
|
|
349
|
-
*/
|
|
350
|
-
interface SpecraConfig {
|
|
351
|
-
/** JSON Schema reference (for IDE support) */
|
|
352
|
-
$schema?: string;
|
|
353
|
-
/** Site metadata and branding */
|
|
354
|
-
site: SiteConfig;
|
|
355
|
-
/** Theme and appearance settings */
|
|
356
|
-
theme?: ThemeConfig;
|
|
357
|
-
/** Navigation and sidebar configuration */
|
|
358
|
-
navigation?: NavigationConfig;
|
|
359
|
-
/** Social and external links */
|
|
360
|
-
social?: SocialLinks;
|
|
361
|
-
/** Search configuration */
|
|
362
|
-
search?: SearchConfig;
|
|
363
|
-
/** Analytics configuration */
|
|
364
|
-
analytics?: AnalyticsConfig;
|
|
365
|
-
/** Footer configuration */
|
|
366
|
-
footer?: FooterConfig;
|
|
367
|
-
/** Site-wide banner */
|
|
368
|
-
banner?: BannerConfig;
|
|
369
|
-
/** Documentation features */
|
|
370
|
-
features?: FeaturesConfig;
|
|
371
|
-
/** Environment variables for use in docs */
|
|
372
|
-
env?: EnvironmentVariables;
|
|
373
|
-
/** Deployment configuration */
|
|
374
|
-
deployment?: DeploymentConfig;
|
|
375
|
-
}
|
|
376
|
-
|
|
377
|
-
interface DocMeta {
|
|
378
|
-
title: string;
|
|
379
|
-
description?: string;
|
|
380
|
-
slug?: string;
|
|
381
|
-
section?: string;
|
|
382
|
-
group?: string;
|
|
383
|
-
sidebar?: string;
|
|
384
|
-
order?: number;
|
|
385
|
-
sidebar_position?: number;
|
|
386
|
-
content?: string;
|
|
387
|
-
last_updated?: string;
|
|
388
|
-
draft?: boolean;
|
|
389
|
-
authors?: Array<{
|
|
390
|
-
id: string;
|
|
391
|
-
name?: string;
|
|
392
|
-
}>;
|
|
393
|
-
tags?: string[];
|
|
394
|
-
redirect_from?: string[];
|
|
395
|
-
reading_time?: number;
|
|
396
|
-
word_count?: number;
|
|
397
|
-
icon?: string;
|
|
398
|
-
tab_group?: string;
|
|
399
|
-
locale?: string;
|
|
400
|
-
}
|
|
401
|
-
interface Doc {
|
|
402
|
-
slug: string;
|
|
403
|
-
filePath: string;
|
|
404
|
-
title: string;
|
|
405
|
-
meta: DocMeta;
|
|
406
|
-
content: string;
|
|
407
|
-
categoryLabel?: string;
|
|
408
|
-
categoryPosition?: number;
|
|
409
|
-
categoryCollapsible?: boolean;
|
|
410
|
-
categoryCollapsed?: boolean;
|
|
411
|
-
categoryIcon?: string;
|
|
412
|
-
categoryTabGroup?: string;
|
|
413
|
-
locale?: string;
|
|
414
|
-
}
|
|
415
|
-
|
|
416
|
-
interface DocLayoutWrapperProps {
|
|
417
|
-
header: ReactNode;
|
|
418
|
-
docs: Doc[];
|
|
419
|
-
version: string;
|
|
420
|
-
children: ReactNode;
|
|
421
|
-
toc: ReactNode;
|
|
422
|
-
config: SpecraConfig;
|
|
423
|
-
currentPageTabGroup?: string;
|
|
424
|
-
}
|
|
425
|
-
declare function DocLayoutWrapper({ header, docs, version, children, toc, config }: DocLayoutWrapperProps): react_jsx_runtime.JSX.Element;
|
|
426
|
-
|
|
427
|
-
declare function DocLoading(): react_jsx_runtime.JSX.Element;
|
|
428
|
-
|
|
429
|
-
interface DocMetadataProps {
|
|
430
|
-
meta: DocMeta;
|
|
431
|
-
config: SpecraConfig;
|
|
432
|
-
}
|
|
433
|
-
declare function DocMetadata({ meta, config }: DocMetadataProps): react_jsx_runtime.JSX.Element | null;
|
|
434
|
-
|
|
435
|
-
interface DocNavigationProps {
|
|
436
|
-
previousDoc?: {
|
|
437
|
-
title: string;
|
|
438
|
-
slug: string;
|
|
439
|
-
};
|
|
440
|
-
nextDoc?: {
|
|
441
|
-
title: string;
|
|
442
|
-
slug: string;
|
|
443
|
-
};
|
|
444
|
-
version: string;
|
|
445
|
-
}
|
|
446
|
-
declare function DocNavigation({ previousDoc, nextDoc, version }: DocNavigationProps): react_jsx_runtime.JSX.Element | null;
|
|
447
|
-
|
|
448
|
-
interface DocTagsProps {
|
|
449
|
-
tags: string[];
|
|
450
|
-
}
|
|
451
|
-
declare function DocTags({ tags }: DocTagsProps): react_jsx_runtime.JSX.Element | null;
|
|
452
|
-
|
|
453
|
-
declare function DraftBadge(): react_jsx_runtime.JSX.Element;
|
|
454
|
-
|
|
455
|
-
declare function Footer({ config }: {
|
|
456
|
-
config: SpecraConfig;
|
|
457
|
-
}): react_jsx_runtime.JSX.Element | null;
|
|
458
|
-
|
|
459
|
-
interface FrameProps {
|
|
460
|
-
src: string;
|
|
461
|
-
title?: string;
|
|
462
|
-
height?: number | string;
|
|
463
|
-
width?: string;
|
|
464
|
-
}
|
|
465
|
-
declare function Frame({ src, title, height, width }: FrameProps): react_jsx_runtime.JSX.Element;
|
|
466
|
-
|
|
467
|
-
interface HeaderProps {
|
|
468
|
-
currentVersion: string;
|
|
469
|
-
versions: string[];
|
|
470
|
-
onMenuClick?: () => void;
|
|
471
|
-
config?: SpecraConfig;
|
|
472
|
-
}
|
|
473
|
-
declare function Header({ currentVersion, versions, onMenuClick, config: configProp }: HeaderProps): react_jsx_runtime.JSX.Element;
|
|
474
|
-
|
|
475
|
-
declare function HotReloadIndicator(): react_jsx_runtime.JSX.Element | null;
|
|
476
|
-
|
|
477
|
-
interface IconProps {
|
|
478
|
-
icon: string | React.ReactNode;
|
|
479
|
-
iconType?: "regular" | "solid" | "light" | "thin" | "sharp-solid" | "duotone" | "brands";
|
|
480
|
-
color?: string;
|
|
481
|
-
size?: number;
|
|
482
|
-
className?: string;
|
|
483
|
-
}
|
|
484
|
-
declare function Icon({ icon, iconType, color, size, className }: IconProps): react_jsx_runtime.JSX.Element;
|
|
485
|
-
|
|
486
|
-
interface ImageCardProps {
|
|
487
|
-
src: string;
|
|
488
|
-
alt: string;
|
|
489
|
-
title?: string;
|
|
490
|
-
description?: string;
|
|
491
|
-
href?: string;
|
|
492
|
-
external?: boolean;
|
|
493
|
-
aspectRatio?: "square" | "video" | "portrait";
|
|
494
|
-
}
|
|
495
|
-
declare function ImageCard({ src, alt, title, description, href, external, aspectRatio, }: ImageCardProps): react_jsx_runtime.JSX.Element;
|
|
496
|
-
interface ImageCardGridProps {
|
|
497
|
-
children: React.ReactNode;
|
|
498
|
-
cols?: 1 | 2 | 3 | 4;
|
|
499
|
-
}
|
|
500
|
-
declare function ImageCardGrid({ children, cols }: ImageCardGridProps): react_jsx_runtime.JSX.Element;
|
|
501
|
-
|
|
502
|
-
interface ImageProps {
|
|
503
|
-
src: string;
|
|
504
|
-
alt: string;
|
|
505
|
-
caption?: string;
|
|
506
|
-
width?: number;
|
|
507
|
-
height?: number;
|
|
508
|
-
zoom?: boolean;
|
|
509
|
-
}
|
|
510
|
-
declare function Image({ src, alt, caption, width, height, zoom }: ImageProps): react_jsx_runtime.JSX.Element;
|
|
511
|
-
|
|
512
|
-
interface LogoProps {
|
|
513
|
-
logo?: string | {
|
|
514
|
-
light: string;
|
|
515
|
-
dark: string;
|
|
516
|
-
};
|
|
517
|
-
alt?: string;
|
|
518
|
-
className?: string;
|
|
519
|
-
}
|
|
520
|
-
declare function Logo({ logo, alt, className }: LogoProps): react_jsx_runtime.JSX.Element | null;
|
|
521
|
-
|
|
522
|
-
declare function LanguageSwitcher(): react_jsx_runtime.JSX.Element | null;
|
|
523
|
-
|
|
524
|
-
interface MathProps {
|
|
525
|
-
children: string;
|
|
526
|
-
block?: boolean;
|
|
527
|
-
}
|
|
528
|
-
declare function Math({ children, block }: MathProps): react_jsx_runtime.JSX.Element;
|
|
529
|
-
|
|
530
|
-
declare function MdxHotReload(): null;
|
|
531
|
-
|
|
532
|
-
interface MermaidProps {
|
|
533
|
-
chart: string;
|
|
534
|
-
caption?: string;
|
|
535
|
-
}
|
|
536
|
-
declare function Mermaid({ chart, caption }: MermaidProps): react_jsx_runtime.JSX.Element;
|
|
537
|
-
|
|
538
|
-
interface MobileDocLayoutProps {
|
|
539
|
-
header: ReactNode;
|
|
540
|
-
docs: Doc[];
|
|
541
|
-
version: string;
|
|
542
|
-
children: ReactNode;
|
|
543
|
-
toc: ReactNode;
|
|
544
|
-
config: SpecraConfig;
|
|
545
|
-
activeTabGroup?: string;
|
|
546
|
-
onTabChange?: (tabId: string) => void;
|
|
547
|
-
}
|
|
548
|
-
declare function MobileDocLayout({ header, docs, version, children, toc, config, activeTabGroup, onTabChange }: MobileDocLayoutProps): react_jsx_runtime.JSX.Element;
|
|
549
|
-
|
|
550
|
-
interface NotFoundContentProps {
|
|
551
|
-
version: string;
|
|
552
|
-
}
|
|
553
|
-
declare function NotFoundContent({ version }: NotFoundContentProps): react_jsx_runtime.JSX.Element;
|
|
554
|
-
|
|
555
|
-
declare function SearchHighlight(): null;
|
|
556
|
-
|
|
557
|
-
interface SearchModalProps {
|
|
558
|
-
isOpen: boolean;
|
|
559
|
-
onClose: () => void;
|
|
560
|
-
config: SpecraConfig;
|
|
561
|
-
}
|
|
562
|
-
declare function SearchModal({ isOpen, onClose, config }: SearchModalProps): react_jsx_runtime.JSX.Element;
|
|
563
|
-
|
|
564
|
-
declare function SidebarSkeleton(): react_jsx_runtime.JSX.Element;
|
|
565
|
-
|
|
566
|
-
interface DocItem {
|
|
567
|
-
title: string;
|
|
568
|
-
slug: string;
|
|
569
|
-
filePath: string;
|
|
570
|
-
section?: string;
|
|
571
|
-
group?: string;
|
|
572
|
-
sidebar?: string;
|
|
573
|
-
sidebar_position?: number;
|
|
574
|
-
categoryLabel?: string;
|
|
575
|
-
categoryPosition?: number;
|
|
576
|
-
categoryCollapsible?: boolean;
|
|
577
|
-
categoryCollapsed?: boolean;
|
|
578
|
-
categoryIcon?: string;
|
|
579
|
-
categoryTabGroup?: string;
|
|
580
|
-
meta?: {
|
|
581
|
-
icon?: string;
|
|
582
|
-
tab_group?: string;
|
|
583
|
-
[key: string]: any;
|
|
584
|
-
};
|
|
585
|
-
}
|
|
586
|
-
interface SidebarProps {
|
|
587
|
-
docs: DocItem[];
|
|
588
|
-
version: string;
|
|
589
|
-
onLinkClick?: () => void;
|
|
590
|
-
config: SpecraConfig;
|
|
591
|
-
activeTabGroup?: string;
|
|
592
|
-
}
|
|
593
|
-
declare function Sidebar({ docs, version, onLinkClick, config, activeTabGroup }: SidebarProps): react_jsx_runtime.JSX.Element | null;
|
|
594
|
-
|
|
595
|
-
interface SiteBannerProps {
|
|
596
|
-
config: SpecraConfig;
|
|
597
|
-
}
|
|
598
|
-
declare function SiteBanner({ config }: SiteBannerProps): react_jsx_runtime.JSX.Element | null;
|
|
599
|
-
|
|
600
|
-
interface StepsProps {
|
|
601
|
-
children: React.ReactNode;
|
|
602
|
-
}
|
|
603
|
-
interface StepProps {
|
|
604
|
-
title: string;
|
|
605
|
-
children: React.ReactNode;
|
|
606
|
-
}
|
|
607
|
-
declare function Steps({ children }: StepsProps): react_jsx_runtime.JSX.Element;
|
|
608
|
-
declare function Step({ title, children }: StepProps): react_jsx_runtime.JSX.Element;
|
|
609
|
-
|
|
610
|
-
interface TabContextType {
|
|
611
|
-
activeTabGroup: string;
|
|
612
|
-
setActiveTabGroup: (tabId: string) => void;
|
|
613
|
-
}
|
|
614
|
-
declare function TabProvider({ children, defaultTab }: {
|
|
615
|
-
children: React$1.ReactNode;
|
|
616
|
-
defaultTab: string;
|
|
617
|
-
}): react_jsx_runtime.JSX.Element;
|
|
618
|
-
declare function useTabContext(): TabContextType;
|
|
619
|
-
|
|
620
|
-
interface TabGroupsProps {
|
|
621
|
-
tabGroups: TabGroup[];
|
|
622
|
-
activeTabId?: string;
|
|
623
|
-
onTabChange?: (tabId: string) => void;
|
|
624
|
-
mobileOnly?: boolean;
|
|
625
|
-
docs?: Array<{
|
|
626
|
-
slug: string;
|
|
627
|
-
meta?: {
|
|
628
|
-
tab_group?: string;
|
|
629
|
-
};
|
|
630
|
-
categoryTabGroup?: string;
|
|
631
|
-
}>;
|
|
632
|
-
version?: string;
|
|
633
|
-
}
|
|
634
|
-
declare function TabGroups({ tabGroups, activeTabId, onTabChange, mobileOnly, docs, version }: TabGroupsProps): react_jsx_runtime.JSX.Element | null;
|
|
635
|
-
|
|
636
|
-
interface TOCItem {
|
|
637
|
-
id: string;
|
|
638
|
-
title: string;
|
|
639
|
-
level: number;
|
|
640
|
-
}
|
|
641
|
-
interface TableOfContentsProps {
|
|
642
|
-
items: TOCItem[];
|
|
643
|
-
config: SpecraConfig;
|
|
644
|
-
}
|
|
645
|
-
declare function TableOfContents({ items, config }: TableOfContentsProps): react_jsx_runtime.JSX.Element | null;
|
|
646
|
-
|
|
647
|
-
interface TabProps {
|
|
648
|
-
label: string;
|
|
649
|
-
children: React__default.ReactNode;
|
|
650
|
-
}
|
|
651
|
-
interface TabsProps {
|
|
652
|
-
children: React__default.ReactElement<TabProps> | React__default.ReactElement<TabProps>[];
|
|
653
|
-
defaultValue?: string;
|
|
654
|
-
}
|
|
655
|
-
declare function Tab({ children }: TabProps): react_jsx_runtime.JSX.Element;
|
|
656
|
-
declare function Tabs({ children, defaultValue }: TabsProps): react_jsx_runtime.JSX.Element;
|
|
657
|
-
|
|
658
|
-
declare function ThemeToggle(): react_jsx_runtime.JSX.Element;
|
|
659
|
-
|
|
660
|
-
interface TooltipProps {
|
|
661
|
-
children: React.ReactNode;
|
|
662
|
-
content: string;
|
|
663
|
-
position?: "top" | "bottom" | "left" | "right";
|
|
664
|
-
}
|
|
665
|
-
declare function Tooltip({ children, content, position }: TooltipProps): react_jsx_runtime.JSX.Element;
|
|
666
|
-
|
|
667
|
-
interface VersionSwitcherProps {
|
|
668
|
-
currentVersion: string;
|
|
669
|
-
versions: string[];
|
|
670
|
-
}
|
|
671
|
-
declare function VersionSwitcher({ currentVersion, versions }: VersionSwitcherProps): react_jsx_runtime.JSX.Element;
|
|
672
|
-
|
|
673
|
-
interface VideoProps {
|
|
674
|
-
src: string;
|
|
675
|
-
caption?: string;
|
|
676
|
-
autoplay?: boolean;
|
|
677
|
-
loop?: boolean;
|
|
678
|
-
muted?: boolean;
|
|
679
|
-
controls?: boolean;
|
|
680
|
-
poster?: string;
|
|
681
|
-
}
|
|
682
|
-
declare function Video({ src, caption, autoplay, loop, muted, controls, poster, }: VideoProps): react_jsx_runtime.JSX.Element;
|
|
683
|
-
|
|
684
|
-
interface ConfigProviderProps {
|
|
685
|
-
config: SpecraConfig;
|
|
686
|
-
children: React$1.ReactNode;
|
|
687
|
-
}
|
|
688
|
-
/**
|
|
689
|
-
* Provider component that makes Specra config available to all client components
|
|
690
|
-
* Usage: Wrap your app with this provider in your root layout
|
|
691
|
-
*/
|
|
692
|
-
declare function ConfigProvider({ config, children }: ConfigProviderProps): react_jsx_runtime.JSX.Element;
|
|
693
|
-
/**
|
|
694
|
-
* Hook to access Specra configuration in any client component
|
|
695
|
-
* @returns The current Specra configuration
|
|
696
|
-
* @example
|
|
697
|
-
* ```tsx
|
|
698
|
-
* function MyComponent() {
|
|
699
|
-
* const config = useConfig()
|
|
700
|
-
* return <div>{config.site.title}</div>
|
|
701
|
-
* }
|
|
702
|
-
* ```
|
|
703
|
-
*/
|
|
704
|
-
declare function useConfig(): SpecraConfig;
|
|
705
|
-
/**
|
|
706
|
-
* Hook to access a specific configuration value by path
|
|
707
|
-
* @param path - Dot-separated path to the config value (e.g., "site.title")
|
|
708
|
-
* @returns The configuration value at the specified path
|
|
709
|
-
* @example
|
|
710
|
-
* ```tsx
|
|
711
|
-
* function MyComponent() {
|
|
712
|
-
* const title = useConfigValue<string>("site.title")
|
|
713
|
-
* const showSidebar = useConfigValue<boolean>("navigation.showSidebar")
|
|
714
|
-
* return <div>{title}</div>
|
|
715
|
-
* }
|
|
716
|
-
* ```
|
|
717
|
-
*/
|
|
718
|
-
declare function useConfigValue<T = any>(path: string): T | undefined;
|
|
719
|
-
|
|
720
|
-
interface ApiEndpointProps {
|
|
721
|
-
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
722
|
-
path: string;
|
|
723
|
-
summary?: string;
|
|
724
|
-
children?: ReactNode;
|
|
725
|
-
defaultOpen?: boolean;
|
|
726
|
-
}
|
|
727
|
-
declare function ApiEndpoint({ method, path, summary, children, defaultOpen }: ApiEndpointProps): react_jsx_runtime.JSX.Element;
|
|
728
|
-
|
|
729
|
-
interface ApiParam {
|
|
730
|
-
name: string;
|
|
731
|
-
type: string;
|
|
732
|
-
required?: boolean;
|
|
733
|
-
description?: string;
|
|
734
|
-
default?: string;
|
|
735
|
-
}
|
|
736
|
-
interface ApiParamsProps {
|
|
737
|
-
title?: string;
|
|
738
|
-
params: ApiParam[];
|
|
739
|
-
}
|
|
740
|
-
declare function ApiParams({ title, params }: ApiParamsProps): react_jsx_runtime.JSX.Element | null;
|
|
741
|
-
|
|
742
|
-
interface ApiResponseProps {
|
|
743
|
-
status: number;
|
|
744
|
-
description?: string;
|
|
745
|
-
example?: any;
|
|
746
|
-
schema?: any;
|
|
747
|
-
}
|
|
748
|
-
declare function ApiResponse({ status, description, example, schema }: ApiResponseProps): react_jsx_runtime.JSX.Element;
|
|
749
|
-
|
|
750
|
-
interface PathParam {
|
|
751
|
-
name: string;
|
|
752
|
-
type: string;
|
|
753
|
-
example?: any;
|
|
754
|
-
}
|
|
755
|
-
interface ApiPlaygroundProps {
|
|
756
|
-
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
757
|
-
path: string;
|
|
758
|
-
baseUrl?: string;
|
|
759
|
-
headers?: Record<string, string>;
|
|
760
|
-
defaultBody?: string;
|
|
761
|
-
pathParams?: PathParam[];
|
|
762
|
-
}
|
|
763
|
-
declare function ApiPlayground({ method, path, baseUrl, headers, defaultBody, pathParams }: ApiPlaygroundProps): react_jsx_runtime.JSX.Element;
|
|
764
|
-
|
|
765
|
-
type ParserType = "auto" | "specra" | "openapi" | "postman";
|
|
766
|
-
|
|
767
|
-
interface ApiReferenceProps {
|
|
768
|
-
/**
|
|
769
|
-
* Path to the API spec JSON file (relative to /public)
|
|
770
|
-
* Example: "/api-specs/my-api.json"
|
|
771
|
-
*/
|
|
772
|
-
spec: string;
|
|
773
|
-
/**
|
|
774
|
-
* Parser type - auto-detect by default
|
|
775
|
-
* - "auto": Auto-detect format (Specra, OpenAPI, or Postman)
|
|
776
|
-
* - "specra": Native Specra format
|
|
777
|
-
* - "openapi": OpenAPI 3.x / Swagger
|
|
778
|
-
* - "postman": Postman Collection v2.x
|
|
779
|
-
*/
|
|
780
|
-
parser?: ParserType;
|
|
781
|
-
/**
|
|
782
|
-
* Show API playground for testing
|
|
783
|
-
*/
|
|
784
|
-
showPlayground?: boolean;
|
|
785
|
-
}
|
|
786
|
-
declare function ApiReference({ spec, parser, showPlayground }: ApiReferenceProps): react_jsx_runtime.JSX.Element | null;
|
|
787
|
-
|
|
788
|
-
declare const badgeVariants: (props?: ({
|
|
789
|
-
variant?: "default" | "destructive" | "outline" | "secondary" | null | undefined;
|
|
790
|
-
} & class_variance_authority_types.ClassProp) | undefined) => string;
|
|
791
|
-
declare function Badge({ className, variant, asChild, ...props }: React$1.ComponentProps<"span"> & VariantProps<typeof badgeVariants> & {
|
|
792
|
-
asChild?: boolean;
|
|
793
|
-
}): react_jsx_runtime.JSX.Element;
|
|
794
|
-
|
|
795
|
-
declare const buttonVariants: (props?: ({
|
|
796
|
-
variant?: "link" | "default" | "destructive" | "outline" | "secondary" | "ghost" | null | undefined;
|
|
797
|
-
size?: "default" | "icon" | "sm" | "lg" | "icon-sm" | "icon-lg" | null | undefined;
|
|
798
|
-
} & class_variance_authority_types.ClassProp) | undefined) => string;
|
|
799
|
-
declare function Button({ className, variant, size, asChild, ...props }: React$1.ComponentProps<'button'> & VariantProps<typeof buttonVariants> & {
|
|
800
|
-
asChild?: boolean;
|
|
801
|
-
}): react_jsx_runtime.JSX.Element;
|
|
802
|
-
|
|
803
|
-
declare function Dialog({ ...props }: React$1.ComponentProps<typeof DialogPrimitive.Root>): react_jsx_runtime.JSX.Element;
|
|
804
|
-
declare function DialogTrigger({ ...props }: React$1.ComponentProps<typeof DialogPrimitive.Trigger>): react_jsx_runtime.JSX.Element;
|
|
805
|
-
declare function DialogPortal({ ...props }: React$1.ComponentProps<typeof DialogPrimitive.Portal>): react_jsx_runtime.JSX.Element;
|
|
806
|
-
declare function DialogClose({ ...props }: React$1.ComponentProps<typeof DialogPrimitive.Close>): react_jsx_runtime.JSX.Element;
|
|
807
|
-
declare function DialogOverlay({ className, ...props }: React$1.ComponentProps<typeof DialogPrimitive.Overlay>): react_jsx_runtime.JSX.Element;
|
|
808
|
-
declare function DialogContent({ className, children, showCloseButton, ...props }: React$1.ComponentProps<typeof DialogPrimitive.Content> & {
|
|
809
|
-
showCloseButton?: boolean;
|
|
810
|
-
}): react_jsx_runtime.JSX.Element;
|
|
811
|
-
declare function DialogHeader({ className, ...props }: React$1.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
|
|
812
|
-
declare function DialogFooter({ className, ...props }: React$1.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
|
|
813
|
-
declare function DialogTitle({ className, ...props }: React$1.ComponentProps<typeof DialogPrimitive.Title>): react_jsx_runtime.JSX.Element;
|
|
814
|
-
declare function DialogDescription({ className, ...props }: React$1.ComponentProps<typeof DialogPrimitive.Description>): react_jsx_runtime.JSX.Element;
|
|
815
|
-
|
|
816
|
-
declare function Input({ className, type, ...props }: React$1.ComponentProps<"input">): react_jsx_runtime.JSX.Element;
|
|
817
|
-
|
|
818
|
-
declare function Textarea({ className, ...props }: React$1.ComponentProps<"textarea">): react_jsx_runtime.JSX.Element;
|
|
819
|
-
|
|
820
|
-
declare function VersionNotFound(): react_jsx_runtime.JSX.Element;
|
|
821
|
-
|
|
822
|
-
export { Accordion, AccordionItem, type AccordionItemProps, type AccordionProps, ApiEndpoint, ApiParams, ApiPlayground, ApiReference, ApiResponse, ApiResponse as ApiResponseDisplay, Badge, Breadcrumb, Button, COMPONENT_TEXT_PROPS, Callout, Card, CardGrid, CodeBlock, type CodeBlockProps, Column, Columns, ConfigProvider, DevModeBadge, Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, Badge$1 as DocBadge, DocLayoutWrapper, DocLoading, DocMetadata, DocNavigation, DocTags, DraftBadge, Footer, Frame, Header, HotReloadIndicator, Icon, type IconProps, Image, ImageCard, ImageCardGrid, type ImageProps, Input, LanguageSwitcher, Logo, Math, type MathProps, MdxHotReload, Mermaid, type MermaidProps, MobileDocLayout, NotFoundContent, SearchHighlight, SearchModal, Sidebar, SidebarSkeleton, SiteBanner, Step, Steps, Tab, TabGroups, type TabProps, TabProvider, TableOfContents, Tabs, type TabsProps, Textarea, ThemeToggle, Tooltip, VersionNotFound, VersionSwitcher, Video, badgeVariants, buttonVariants, extractComponentPropsText, extractSearchText, useConfig, useConfigValue, useTabContext };
|