@stainless-api/docs-ui 0.1.0-beta.86 → 0.1.0-beta.87
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/dist/components/index.d.ts +2 -2
- package/dist/components/sdk.d.ts +1 -1
- package/dist/components/snippets.d.ts +1 -1
- package/dist/contexts/component-types.d.ts +1 -1
- package/dist/contexts/component.d.ts +1 -1
- package/dist/contexts/docs.d.ts +1 -1
- package/dist/contexts/index.d.ts +5 -5
- package/dist/contexts/index.js +3 -2
- package/dist/contexts/markdown.d.ts +2 -2
- package/dist/contexts/markdown.js +28 -13
- package/dist/contexts/navigation.d.ts +1 -1
- package/dist/contexts/use-components.d.ts +1 -1
- package/dist/docs-BomxNGuD.d.ts +62 -0
- package/dist/{index-HcWFtzlc.d.ts → index-gGDaf6FK.d.ts} +2 -2
- package/dist/index-uRQlPa4x.d.ts +464 -0
- package/dist/index.d.ts +2 -2
- package/dist/languages/cli.d.ts +1 -1
- package/dist/languages/csharp.d.ts +1 -1
- package/dist/languages/go.d.ts +1 -1
- package/dist/languages/http.d.ts +1 -1
- package/dist/languages/index.d.ts +1 -1
- package/dist/languages/java.d.ts +1 -1
- package/dist/languages/php.d.ts +1 -1
- package/dist/languages/python.d.ts +1 -1
- package/dist/languages/ruby.d.ts +1 -1
- package/dist/languages/terraform.d.ts +1 -1
- package/dist/languages/typescript.d.ts +1 -1
- package/dist/markdown/printer.d.ts +1 -1
- package/dist/markdown/utils.d.ts +2 -2
- package/dist/markdown-Cwdboi_V.d.ts +33 -0
- package/dist/navigation-22WDJvRF.d.ts +29 -0
- package/dist/routing-C_fawH40.d.ts +61 -0
- package/dist/routing.d.ts +1 -1
- package/dist/sdk-Cx2Z7bDk.d.ts +128 -0
- package/dist/spec.d.ts +3 -3
- package/dist/styles/main.css +16 -5
- package/dist/styles.css +16 -5
- package/package.json +4 -4
- package/dist/markdown-ClGRntP5.d.ts +0 -22
|
@@ -2,8 +2,8 @@ import { a as Join, c as ListViewProps, d as ToggleButtonProps, f as Tooltip, i
|
|
|
2
2
|
import { n as generateApiBreadcrumbs, t as SDKBreadcrumbs } from "../breadcrumbs-DC2_z7nh.js";
|
|
3
3
|
import { a as MethodHeaderProps, c as MethodProps, i as MethodHeader, l as MethodRoute, n as MethodDescription, o as MethodInfo, r as MethodDescriptionProps, s as MethodInfoProps, t as Method, u as MethodRouteProps } from "../method-CNRMOUfn.js";
|
|
4
4
|
import { a as PropertyTitle, c as PropertyToggleProps, i as PropertyProps, n as PropertyDescription, o as PropertyTitleProps, r as PropertyDescriptionProps, s as PropertyToggle, t as Property } from "../properties-CVwrzWVa.js";
|
|
5
|
-
import { A as useStreamingResponse, C as SDKRequestTitleProps, D as useDeclarationParents, E as TransformRequestSnippetFn, O as usePropertyModel, S as SDKRequestTitle, T as SDKSnippetLanguagesType, _ as SDKMethodNotImplemented, a as ReferenceNestingContextType, b as SDKModelProps, c as SDKConstraintsProps, d as SDKIcon, f as SDKLanguageBlock, g as SDKMethodInfoContent, h as SDKMethodInfo, i as ReferenceNestingContext, k as useReferenceNesting, l as SDKDeclaration, m as SDKMethodHeader, n as PropertyModelContext, o as SDKChildren, p as SDKMethod, r as PropertyModelContextType, s as SDKConstraints, t as DeclarationParentsContextType, u as SDKExample, v as SDKMethodProps, w as SDKSnippetLanguages, x as SDKReference, y as SDKModel } from "../sdk-
|
|
6
|
-
import { a as SnippetButtons, c as SnippetContainer, d as SnippetProps, f as SnippetRequestContainer, i as Snippet, l as SnippetContainerProps, m as SnippetResponse, n as MultiSnippets, o as SnippetCode, p as SnippetRequestContainerProps, r as MultiSnippetsProps, s as SnippetCodeProps, u as SnippetFooter } from "../index-
|
|
5
|
+
import { A as useStreamingResponse, C as SDKRequestTitleProps, D as useDeclarationParents, E as TransformRequestSnippetFn, O as usePropertyModel, S as SDKRequestTitle, T as SDKSnippetLanguagesType, _ as SDKMethodNotImplemented, a as ReferenceNestingContextType, b as SDKModelProps, c as SDKConstraintsProps, d as SDKIcon, f as SDKLanguageBlock, g as SDKMethodInfoContent, h as SDKMethodInfo, i as ReferenceNestingContext, k as useReferenceNesting, l as SDKDeclaration, m as SDKMethodHeader, n as PropertyModelContext, o as SDKChildren, p as SDKMethod, r as PropertyModelContextType, s as SDKConstraints, t as DeclarationParentsContextType, u as SDKExample, v as SDKMethodProps, w as SDKSnippetLanguages, x as SDKReference, y as SDKModel } from "../sdk-Cx2Z7bDk.js";
|
|
6
|
+
import { a as SnippetButtons, c as SnippetContainer, d as SnippetProps, f as SnippetRequestContainer, i as Snippet, l as SnippetContainerProps, m as SnippetResponse, n as MultiSnippets, o as SnippetCode, p as SnippetRequestContainerProps, r as MultiSnippetsProps, s as SnippetCodeProps, u as SnippetFooter } from "../index-uRQlPa4x.js";
|
|
7
7
|
import { a as SDKResource, c as SDKRoot, i as SDKOverviewProps, l as SDKRootProps, n as SDKMethodSummaryProps, o as SDKResourceHeader, r as SDKOverview, s as SDKResourceProps, t as SDKMethodSummary } from "../overview-CDvh184n.js";
|
|
8
8
|
import { n as SDKSidebarProps, t as SDKSidebar } from "../sdk-sidebar-BpDlOMat.js";
|
|
9
9
|
import { a as StlSidebarProps, i as StlSidebarLink, n as StlSidebarEntry, o as StlSidebarTarget, r as StlSidebarGroup, t as StlSidebar } from "../stl-sidebar-CKrR5ZGs.js";
|
package/dist/components/sdk.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { A as useStreamingResponse, C as SDKRequestTitleProps, D as useDeclarationParents, E as TransformRequestSnippetFn, O as usePropertyModel, S as SDKRequestTitle, T as SDKSnippetLanguagesType, _ as SDKMethodNotImplemented, a as ReferenceNestingContextType, b as SDKModelProps, c as SDKConstraintsProps, d as SDKIcon, f as SDKLanguageBlock, g as SDKMethodInfoContent, h as SDKMethodInfo, i as ReferenceNestingContext, k as useReferenceNesting, l as SDKDeclaration, m as SDKMethodHeader, n as PropertyModelContext, o as SDKChildren, p as SDKMethod, r as PropertyModelContextType, s as SDKConstraints, t as DeclarationParentsContextType, u as SDKExample, v as SDKMethodProps, w as SDKSnippetLanguages, x as SDKReference, y as SDKModel } from "../sdk-
|
|
1
|
+
import { A as useStreamingResponse, C as SDKRequestTitleProps, D as useDeclarationParents, E as TransformRequestSnippetFn, O as usePropertyModel, S as SDKRequestTitle, T as SDKSnippetLanguagesType, _ as SDKMethodNotImplemented, a as ReferenceNestingContextType, b as SDKModelProps, c as SDKConstraintsProps, d as SDKIcon, f as SDKLanguageBlock, g as SDKMethodInfoContent, h as SDKMethodInfo, i as ReferenceNestingContext, k as useReferenceNesting, l as SDKDeclaration, m as SDKMethodHeader, n as PropertyModelContext, o as SDKChildren, p as SDKMethod, r as PropertyModelContextType, s as SDKConstraints, t as DeclarationParentsContextType, u as SDKExample, v as SDKMethodProps, w as SDKSnippetLanguages, x as SDKReference, y as SDKModel } from "../sdk-Cx2Z7bDk.js";
|
|
2
2
|
export { DeclarationParentsContextType, PropertyModelContext, PropertyModelContextType, ReferenceNestingContext, ReferenceNestingContextType, SDKChildren, SDKConstraints, SDKConstraintsProps, SDKDeclaration, SDKExample, SDKIcon, SDKLanguageBlock, SDKMethod, SDKMethodHeader, SDKMethodInfo, SDKMethodInfoContent, SDKMethodNotImplemented, SDKMethodProps, SDKModel, SDKModelProps, SDKReference, SDKRequestTitle, SDKRequestTitleProps, SDKSnippetLanguages, SDKSnippetLanguagesType, TransformRequestSnippetFn, useDeclarationParents, usePropertyModel, useReferenceNesting, useStreamingResponse };
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as SnippetButtons, c as SnippetContainer, d as SnippetProps, f as SnippetRequestContainer, i as Snippet, l as SnippetContainerProps, m as SnippetResponse, n as MultiSnippets, o as SnippetCode, p as SnippetRequestContainerProps, r as MultiSnippetsProps, s as SnippetCodeProps, u as SnippetFooter } from "../index-
|
|
1
|
+
import { a as SnippetButtons, c as SnippetContainer, d as SnippetProps, f as SnippetRequestContainer, i as Snippet, l as SnippetContainerProps, m as SnippetResponse, n as MultiSnippets, o as SnippetCode, p as SnippetRequestContainerProps, r as MultiSnippetsProps, s as SnippetCodeProps, u as SnippetFooter } from "../index-uRQlPa4x.js";
|
|
2
2
|
export { MultiSnippets, MultiSnippetsProps, Snippet, SnippetButtons, SnippetCode, SnippetCodeProps, SnippetContainer, SnippetContainerProps, SnippetFooter, SnippetProps, SnippetRequestContainer, SnippetRequestContainerProps, SnippetResponse };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { t as index_d_exports, y as index_d_exports$1 } from "../index-
|
|
1
|
+
import { t as index_d_exports, y as index_d_exports$1 } from "../index-uRQlPa4x.js";
|
|
2
2
|
//#region src/contexts/component-types.d.ts
|
|
3
3
|
type AppComponents = typeof index_d_exports;
|
|
4
4
|
type AppLanguage = typeof index_d_exports$1;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { t as index_d_exports, y as index_d_exports$1 } from "../index-
|
|
1
|
+
import { t as index_d_exports, y as index_d_exports$1 } from "../index-uRQlPa4x.js";
|
|
2
2
|
import { n as ComponentsContextType } from "../component-generics-q-ujwX4P.js";
|
|
3
3
|
import React from "react";
|
|
4
4
|
import * as react_jsx_runtime0 from "react/jsx-runtime";
|
package/dist/contexts/docs.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { _ as useSnippetResponse, a as DocsProviderProps, c as useContentPanelLayout, d as useIgnoredResources, f as useLanguage, g as useSnippetIds, h as useSnippet, i as DocsProvider, l as useDeclaration, m as useSettings, n as Declaration, o as PropertySettingsType, p as useResource, r as DocsContextType, s as useAvailableLanguages, t as ContentPanelLayout, u as useDocs, v as useSnippets, y as useSpec } from "../docs-
|
|
1
|
+
import { _ as useSnippetResponse, a as DocsProviderProps, c as useContentPanelLayout, d as useIgnoredResources, f as useLanguage, g as useSnippetIds, h as useSnippet, i as DocsProvider, l as useDeclaration, m as useSettings, n as Declaration, o as PropertySettingsType, p as useResource, r as DocsContextType, s as useAvailableLanguages, t as ContentPanelLayout, u as useDocs, v as useSnippets, y as useSpec } from "../docs-BomxNGuD.js";
|
|
2
2
|
export { ContentPanelLayout, Declaration, DocsContextType, DocsProvider, DocsProviderProps, PropertySettingsType, useAvailableLanguages, useContentPanelLayout, useDeclaration, useDocs, useIgnoredResources, useLanguage, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec };
|
package/dist/contexts/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { g as useLanguageComponents } from "../index-
|
|
2
|
-
import { a as useNavigation, i as NavigationProviderProps, n as NavigationHandler, r as NavigationProvider, t as NavigationContextType } from "../navigation-
|
|
3
|
-
import { a as
|
|
1
|
+
import { g as useLanguageComponents } from "../index-uRQlPa4x.js";
|
|
2
|
+
import { a as useNavigation, i as NavigationProviderProps, n as NavigationHandler, r as NavigationProvider, t as NavigationContextType } from "../navigation-22WDJvRF.js";
|
|
3
|
+
import { a as SuspensefulMarkdownProvider, c as useRenderMarkdown, i as MarkdownProviderProps, n as MarkdownContextValue, o as useHighlight, r as MarkdownProvider, s as useMarkdownContext, t as MarkdownContext } from "../markdown-Cwdboi_V.js";
|
|
4
4
|
import { a as useComponents, i as useComponentContext, n as ComponentsContextType, r as customizeComponents, t as ComponentProvider } from "../component-generics-q-ujwX4P.js";
|
|
5
|
-
import { _ as useSnippetResponse, a as DocsProviderProps, c as useContentPanelLayout, d as useIgnoredResources, f as useLanguage, g as useSnippetIds, h as useSnippet, i as DocsProvider, l as useDeclaration, m as useSettings, n as Declaration, o as PropertySettingsType, p as useResource, r as DocsContextType, s as useAvailableLanguages, t as ContentPanelLayout, u as useDocs, v as useSnippets, y as useSpec } from "../docs-
|
|
6
|
-
export { ComponentProvider, ComponentsContextType, ContentPanelLayout, Declaration, DocsContextType, DocsProvider, DocsProviderProps, MarkdownContext, MarkdownProvider, MarkdownProviderProps, NavigationContextType, NavigationHandler, NavigationProvider, NavigationProviderProps, PropertySettingsType, customizeComponents, useAvailableLanguages, useComponentContext, useComponents, useContentPanelLayout, useDeclaration, useDocs, useHighlight, useIgnoredResources, useLanguage, useLanguageComponents, useMarkdownContext, useNavigation, useRenderMarkdown, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec };
|
|
5
|
+
import { _ as useSnippetResponse, a as DocsProviderProps, c as useContentPanelLayout, d as useIgnoredResources, f as useLanguage, g as useSnippetIds, h as useSnippet, i as DocsProvider, l as useDeclaration, m as useSettings, n as Declaration, o as PropertySettingsType, p as useResource, r as DocsContextType, s as useAvailableLanguages, t as ContentPanelLayout, u as useDocs, v as useSnippets, y as useSpec } from "../docs-BomxNGuD.js";
|
|
6
|
+
export { ComponentProvider, ComponentsContextType, ContentPanelLayout, Declaration, DocsContextType, DocsProvider, DocsProviderProps, MarkdownContext, MarkdownContextValue, MarkdownProvider, MarkdownProviderProps, NavigationContextType, NavigationHandler, NavigationProvider, NavigationProviderProps, PropertySettingsType, SuspensefulMarkdownProvider, customizeComponents, useAvailableLanguages, useComponentContext, useComponents, useContentPanelLayout, useDeclaration, useDocs, useHighlight, useIgnoredResources, useLanguage, useLanguageComponents, useMarkdownContext, useNavigation, useRenderMarkdown, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec };
|
package/dist/contexts/index.js
CHANGED
|
@@ -2,7 +2,7 @@ import { t as __exportAll } from "../chunk-pbuEa-1d.js";
|
|
|
2
2
|
import { DocsProvider, useAvailableLanguages, useContentPanelLayout, useDeclaration, useDocs, useIgnoredResources, useLanguage, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec } from "./docs.js";
|
|
3
3
|
import { i as useComponents, n as customizeComponents, r as useComponentContext, t as ComponentProvider } from "../component-generics-DYxBWv1v.js";
|
|
4
4
|
import { NavigationProvider, useNavigation } from "./navigation.js";
|
|
5
|
-
import { MarkdownContext, MarkdownProvider, useHighlight, useMarkdownContext, useRenderMarkdown } from "./markdown.js";
|
|
5
|
+
import { MarkdownContext, MarkdownProvider, SuspensefulMarkdownProvider, useHighlight, useMarkdownContext, useRenderMarkdown } from "./markdown.js";
|
|
6
6
|
//#region src/contexts/index.tsx
|
|
7
7
|
var contexts_exports = /* @__PURE__ */ __exportAll({
|
|
8
8
|
ComponentProvider: () => ComponentProvider,
|
|
@@ -10,6 +10,7 @@ var contexts_exports = /* @__PURE__ */ __exportAll({
|
|
|
10
10
|
MarkdownContext: () => MarkdownContext,
|
|
11
11
|
MarkdownProvider: () => MarkdownProvider,
|
|
12
12
|
NavigationProvider: () => NavigationProvider,
|
|
13
|
+
SuspensefulMarkdownProvider: () => SuspensefulMarkdownProvider,
|
|
13
14
|
customizeComponents: () => customizeComponents,
|
|
14
15
|
useAvailableLanguages: () => useAvailableLanguages,
|
|
15
16
|
useComponentContext: () => useComponentContext,
|
|
@@ -39,4 +40,4 @@ function useLanguageComponents() {
|
|
|
39
40
|
return definition;
|
|
40
41
|
}
|
|
41
42
|
//#endregion
|
|
42
|
-
export { ComponentProvider, DocsProvider, MarkdownContext, MarkdownProvider, NavigationProvider, customizeComponents, contexts_exports as t, useAvailableLanguages, useComponentContext, useComponents, useContentPanelLayout, useDeclaration, useDocs, useHighlight, useIgnoredResources, useLanguage, useLanguageComponents, useMarkdownContext, useNavigation, useRenderMarkdown, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec };
|
|
43
|
+
export { ComponentProvider, DocsProvider, MarkdownContext, MarkdownProvider, NavigationProvider, SuspensefulMarkdownProvider, customizeComponents, contexts_exports as t, useAvailableLanguages, useComponentContext, useComponents, useContentPanelLayout, useDeclaration, useDocs, useHighlight, useIgnoredResources, useLanguage, useLanguageComponents, useMarkdownContext, useNavigation, useRenderMarkdown, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec };
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as
|
|
2
|
-
export { MarkdownContext, MarkdownProvider, MarkdownProviderProps, useHighlight, useMarkdownContext, useRenderMarkdown };
|
|
1
|
+
import { a as SuspensefulMarkdownProvider, c as useRenderMarkdown, i as MarkdownProviderProps, n as MarkdownContextValue, o as useHighlight, r as MarkdownProvider, s as useMarkdownContext, t as MarkdownContext } from "../markdown-Cwdboi_V.js";
|
|
2
|
+
export { MarkdownContext, MarkdownContextValue, MarkdownProvider, MarkdownProviderProps, SuspensefulMarkdownProvider, useHighlight, useMarkdownContext, useRenderMarkdown };
|
|
@@ -1,33 +1,33 @@
|
|
|
1
1
|
import { useLanguage } from "./docs.js";
|
|
2
|
-
import
|
|
3
|
-
import { jsx } from "react/jsx-runtime";
|
|
2
|
+
import { Suspense, createContext, use, useMemo } from "react";
|
|
3
|
+
import { Fragment as Fragment$1, jsx } from "react/jsx-runtime";
|
|
4
4
|
//#region src/contexts/markdown.tsx
|
|
5
5
|
const HighlightLanguageMappings = {
|
|
6
6
|
node: "typescript",
|
|
7
7
|
http: "bash",
|
|
8
8
|
cli: "bash"
|
|
9
9
|
};
|
|
10
|
-
const MarkdownContext =
|
|
10
|
+
const MarkdownContext = createContext({
|
|
11
11
|
highlight: (content) => content,
|
|
12
12
|
render: (content) => content
|
|
13
13
|
});
|
|
14
|
-
const useMarkdownContext = () =>
|
|
14
|
+
const useMarkdownContext = () => use(MarkdownContext);
|
|
15
15
|
function useRenderMarkdown(content) {
|
|
16
|
-
const { render } =
|
|
17
|
-
return
|
|
16
|
+
const { render } = use(MarkdownContext);
|
|
17
|
+
return useMemo(() => {
|
|
18
18
|
if (!content) return void 0;
|
|
19
19
|
const rendered = render(content);
|
|
20
|
-
return typeof rendered === "string" ? rendered :
|
|
20
|
+
return typeof rendered === "string" ? rendered : use(rendered);
|
|
21
21
|
}, [content, render]);
|
|
22
22
|
}
|
|
23
23
|
function useHighlight(content, language) {
|
|
24
|
-
const { highlight } =
|
|
24
|
+
const { highlight } = use(MarkdownContext);
|
|
25
25
|
const defaultLanguage = useLanguage();
|
|
26
26
|
const lang = language ?? defaultLanguage;
|
|
27
|
-
return
|
|
27
|
+
return useMemo(() => {
|
|
28
28
|
if (lang === "none") return content;
|
|
29
29
|
const rendered = highlight(content, HighlightLanguageMappings[lang] ?? lang);
|
|
30
|
-
return typeof rendered === "string" ? rendered :
|
|
30
|
+
return typeof rendered === "string" ? rendered : use(rendered);
|
|
31
31
|
}, [
|
|
32
32
|
content,
|
|
33
33
|
highlight,
|
|
@@ -36,12 +36,27 @@ function useHighlight(content, language) {
|
|
|
36
36
|
}
|
|
37
37
|
function MarkdownProvider({ render, highlight, children }) {
|
|
38
38
|
return /* @__PURE__ */ jsx(MarkdownContext, {
|
|
39
|
-
value: {
|
|
39
|
+
value: useMemo(() => ({
|
|
40
40
|
render,
|
|
41
41
|
highlight
|
|
42
|
-
},
|
|
42
|
+
}), [render, highlight]),
|
|
43
43
|
children
|
|
44
44
|
});
|
|
45
45
|
}
|
|
46
|
+
function SuspensefulMarkdownProviderInner({ value, children }) {
|
|
47
|
+
return /* @__PURE__ */ jsx(MarkdownContext, {
|
|
48
|
+
value: use(value),
|
|
49
|
+
children
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
function SuspensefulMarkdownProvider({ value, children }) {
|
|
53
|
+
return /* @__PURE__ */ jsx(Suspense, {
|
|
54
|
+
fallback: /* @__PURE__ */ jsx(Fragment$1, { children }),
|
|
55
|
+
children: /* @__PURE__ */ jsx(SuspensefulMarkdownProviderInner, {
|
|
56
|
+
value,
|
|
57
|
+
children
|
|
58
|
+
})
|
|
59
|
+
});
|
|
60
|
+
}
|
|
46
61
|
//#endregion
|
|
47
|
-
export { MarkdownContext, MarkdownProvider, useHighlight, useMarkdownContext, useRenderMarkdown };
|
|
62
|
+
export { MarkdownContext, MarkdownProvider, SuspensefulMarkdownProvider, useHighlight, useMarkdownContext, useRenderMarkdown };
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as useNavigation, i as NavigationProviderProps, n as NavigationHandler, r as NavigationProvider, t as NavigationContextType } from "../navigation-
|
|
1
|
+
import { a as useNavigation, i as NavigationProviderProps, n as NavigationHandler, r as NavigationProvider, t as NavigationContextType } from "../navigation-22WDJvRF.js";
|
|
2
2
|
export { NavigationContextType, NavigationHandler, NavigationProvider, NavigationProviderProps, useNavigation };
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { h as Resource, u as LanguageDeclNodes, v as Spec, y as SpecLanguage } from "./index-DFr9Mesr.js";
|
|
2
|
+
import * as React$1 from "react";
|
|
3
|
+
import * as react_jsx_runtime0 from "react/jsx-runtime";
|
|
4
|
+
|
|
5
|
+
//#region src/contexts/docs.d.ts
|
|
6
|
+
type ContentPanelLayout = 'double-pane' | 'single-pane';
|
|
7
|
+
type PropertySettingsType = {
|
|
8
|
+
types?: 'simple' | 'rich';
|
|
9
|
+
includeModelProperties?: boolean | 'method-page';
|
|
10
|
+
collapseDescription?: boolean | 'show-first-line';
|
|
11
|
+
showTitle?: boolean;
|
|
12
|
+
expandDepth?: number;
|
|
13
|
+
};
|
|
14
|
+
type DocsContextType = {
|
|
15
|
+
language: SpecLanguage;
|
|
16
|
+
spec: Spec | null;
|
|
17
|
+
settings?: {
|
|
18
|
+
properties?: PropertySettingsType;
|
|
19
|
+
contentPanelLayout?: ContentPanelLayout;
|
|
20
|
+
virtualExpanders?: boolean;
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
declare function useDocs(): DocsContextType;
|
|
24
|
+
declare function useSpec(): Spec | null;
|
|
25
|
+
declare function useSettings(): {
|
|
26
|
+
properties?: PropertySettingsType;
|
|
27
|
+
contentPanelLayout?: ContentPanelLayout;
|
|
28
|
+
virtualExpanders?: boolean;
|
|
29
|
+
} | undefined;
|
|
30
|
+
declare function useSnippets(stainlessPath: string, language?: SpecLanguage): {
|
|
31
|
+
[key: `custom:${string}`]: {
|
|
32
|
+
content: string;
|
|
33
|
+
};
|
|
34
|
+
default: {
|
|
35
|
+
content: string;
|
|
36
|
+
};
|
|
37
|
+
} | undefined;
|
|
38
|
+
declare function useSnippetIds(stainlessPath: string, language?: SpecLanguage): SnippetId[] | undefined;
|
|
39
|
+
type SnippetId = keyof NonNullable<ReturnType<typeof useSnippets>>;
|
|
40
|
+
declare function useSnippet(stainlessPath: string, language?: SpecLanguage, snippetId?: SnippetId): string | undefined;
|
|
41
|
+
declare function useSnippetResponse(stainlessPath: string, snippetId?: SnippetId): {
|
|
42
|
+
status?: string;
|
|
43
|
+
content: string;
|
|
44
|
+
}[] | undefined;
|
|
45
|
+
type Declaration = LanguageDeclNodes[SpecLanguage];
|
|
46
|
+
declare function useDeclaration<Required extends boolean>(stainlessPath: string, required: Required, language?: SpecLanguage): (Required extends true ? never : undefined) | Declaration;
|
|
47
|
+
declare function useAvailableLanguages(stainlessPath: string): SpecLanguage[];
|
|
48
|
+
declare function useIgnoredResources(): string[];
|
|
49
|
+
declare function useResource(name: string): Resource | undefined;
|
|
50
|
+
declare function useLanguage(): "cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript";
|
|
51
|
+
declare function useContentPanelLayout(): ContentPanelLayout;
|
|
52
|
+
type DocsProviderProps = DocsContextType & {
|
|
53
|
+
children: React$1.ReactNode;
|
|
54
|
+
};
|
|
55
|
+
declare function DocsProvider({
|
|
56
|
+
spec,
|
|
57
|
+
language,
|
|
58
|
+
settings,
|
|
59
|
+
children
|
|
60
|
+
}: DocsProviderProps): react_jsx_runtime0.JSX.Element;
|
|
61
|
+
//#endregion
|
|
62
|
+
export { useSnippetResponse as _, DocsProviderProps as a, useContentPanelLayout as c, useIgnoredResources as d, useLanguage as f, useSnippetIds as g, useSnippet as h, DocsProvider as i, useDeclaration as l, useSettings as m, Declaration as n, PropertySettingsType as o, useResource as p, DocsContextType as r, useAvailableLanguages as s, ContentPanelLayout as t, useDocs as u, useSnippets as v, useSpec as y };
|
|
@@ -5,7 +5,7 @@ import { a as MethodHeaderProps, c as MethodProps, i as MethodHeader, l as Metho
|
|
|
5
5
|
import { a as PropertyTitle, c as PropertyToggleProps, i as PropertyProps$10, n as PropertyDescription, o as PropertyTitleProps, r as PropertyDescriptionProps, s as PropertyToggle, t as Property$10 } from "./properties-CVwrzWVa.js";
|
|
6
6
|
import { A as useStreamingResponse, C as SDKRequestTitleProps, D as useDeclarationParents, E as TransformRequestSnippetFn, O as usePropertyModel, S as SDKRequestTitle, T as SDKSnippetLanguagesType, _ as SDKMethodNotImplemented, a as ReferenceNestingContextType, b as SDKModelProps, c as SDKConstraintsProps, d as SDKIcon, f as SDKLanguageBlock, g as SDKMethodInfoContent, h as SDKMethodInfo, i as ReferenceNestingContext, k as useReferenceNesting, l as SDKDeclaration, m as SDKMethodHeader, n as PropertyModelContext, o as SDKChildren, p as SDKMethod, r as PropertyModelContextType, s as SDKConstraints, t as DeclarationParentsContextType, u as SDKExample, v as SDKMethodProps, w as SDKSnippetLanguages, x as SDKReference, y as SDKModel } from "./sdk-BkW3MDco.js";
|
|
7
7
|
import { a as useNavigation, i as NavigationProviderProps, n as NavigationHandler, r as NavigationProvider, t as NavigationContextType } from "./navigation-C9ckAfpV.js";
|
|
8
|
-
import { a as
|
|
8
|
+
import { a as SuspensefulMarkdownProvider, c as useRenderMarkdown, i as MarkdownProviderProps, n as MarkdownContextValue, o as useHighlight, r as MarkdownProvider, s as useMarkdownContext, t as MarkdownContext } from "./markdown-Cwdboi_V.js";
|
|
9
9
|
import { a as useComponents, i as useComponentContext, n as ComponentsContextType, r as customizeComponents, t as ComponentProvider } from "./component-generics-q-ujwX4P.js";
|
|
10
10
|
import { _ as useSnippetResponse, a as DocsProviderProps, c as useContentPanelLayout, d as useIgnoredResources, f as useLanguage, g as useSnippetIds, h as useSnippet, i as DocsProvider, l as useDeclaration, m as useSettings, n as Declaration$10, o as PropertySettingsType, p as useResource, r as DocsContextType, s as useAvailableLanguages, t as ContentPanelLayout, u as useDocs, v as useSnippets, y as useSpec } from "./docs-DSjdvCh5.js";
|
|
11
11
|
import { a as SDKResource, c as SDKRoot, i as SDKOverviewProps, l as SDKRootProps, n as SDKMethodSummaryProps, o as SDKResourceHeader, r as SDKOverview, s as SDKResourceProps, t as SDKMethodSummary } from "./overview-CDvh184n.js";
|
|
@@ -391,7 +391,7 @@ interface LanguageComponentDefinition {
|
|
|
391
391
|
}) => ReactNode;
|
|
392
392
|
}
|
|
393
393
|
declare namespace index_d_exports$1 {
|
|
394
|
-
export { ComponentProvider, ComponentsContextType, ContentPanelLayout, Declaration$10 as Declaration, DocsContextType, DocsProvider, DocsProviderProps, MarkdownContext, MarkdownProvider, MarkdownProviderProps, NavigationContextType, NavigationHandler, NavigationProvider, NavigationProviderProps, PropertySettingsType, customizeComponents, useAvailableLanguages, useComponentContext, useComponents, useContentPanelLayout, useDeclaration, useDocs, useHighlight, useIgnoredResources, useLanguage, useLanguageComponents, useMarkdownContext, useNavigation, useRenderMarkdown, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec };
|
|
394
|
+
export { ComponentProvider, ComponentsContextType, ContentPanelLayout, Declaration$10 as Declaration, DocsContextType, DocsProvider, DocsProviderProps, MarkdownContext, MarkdownContextValue, MarkdownProvider, MarkdownProviderProps, NavigationContextType, NavigationHandler, NavigationProvider, NavigationProviderProps, PropertySettingsType, SuspensefulMarkdownProvider, customizeComponents, useAvailableLanguages, useComponentContext, useComponents, useContentPanelLayout, useDeclaration, useDocs, useHighlight, useIgnoredResources, useLanguage, useLanguageComponents, useMarkdownContext, useNavigation, useRenderMarkdown, useResource, useSettings, useSnippet, useSnippetIds, useSnippetResponse, useSnippets, useSpec };
|
|
395
395
|
}
|
|
396
396
|
declare function useLanguageComponents(): LanguageComponentDefinition;
|
|
397
397
|
//#endregion
|