@stainless-api/docs-ui 0.1.0-beta.70 → 0.1.0-beta.72
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/{breadcrumbs-Cvm5Ifm7.d.ts → breadcrumbs-46Qjx1Pd.d.ts} +3 -3
- package/dist/{breadcrumbs-BhYwbXkc.d.ts → breadcrumbs-BZ4wBC9-.d.ts} +3 -3
- package/dist/{breadcrumbs-DA4WgDhR.js → breadcrumbs-BiBfNqBI.js} +2 -2
- package/dist/{cli-F3kMmeoJ.js → cli-hduQ5XS1.js} +3 -3
- package/dist/{component-P9sn5yyG.js → component-BU8BTbqz.js} +2 -2
- package/dist/{component-generics-zU0Pqx8m.d.ts → component-generics-Bw4ZOyEG.d.ts} +2 -2
- package/dist/{component-generics-ByGsYTc8.d.ts → component-generics-D-WarFUb.d.ts} +2 -2
- package/dist/components/MaskedInput.d.ts +3 -3
- package/dist/components/MaskedInput.js +1 -1
- package/dist/components/breadcrumbs.d.ts +1 -1
- package/dist/components/breadcrumbs.js +5 -5
- package/dist/components/icons.d.ts +12 -12
- package/dist/components/index.d.ts +14 -11
- package/dist/components/index.js +14 -14
- package/dist/components/method.d.ts +1 -1
- package/dist/components/method.js +5 -5
- package/dist/components/overview.d.ts +1 -1
- package/dist/components/overview.js +6 -6
- package/dist/components/primitives.d.ts +1 -1
- package/dist/components/primitives.js +4 -4
- package/dist/components/properties.d.ts +1 -1
- package/dist/components/properties.js +4 -4
- package/dist/components/sdk-sidebar.d.ts +1 -1
- package/dist/components/sdk-sidebar.js +5 -5
- package/dist/components/sdk.d.ts +1 -1
- package/dist/components/sdk.js +4 -4
- package/dist/components/snippets.d.ts +14 -3
- package/dist/components/snippets.js +5 -5
- package/dist/components/stl-sidebar.d.ts +1 -1
- package/dist/components/stl-sidebar.js +1 -1
- package/dist/{components-w1JmIrB0.js → components-9NMl1791.js} +10 -9
- package/dist/contexts/component-generics.d.ts +1 -1
- package/dist/contexts/component-types.d.ts +13 -11
- package/dist/contexts/component.d.ts +15 -14
- package/dist/contexts/component.js +24 -24
- package/dist/contexts/docs.d.ts +2 -2
- package/dist/contexts/docs.js +2 -2
- package/dist/contexts/index.d.ts +14 -23
- package/dist/contexts/index.js +4 -4
- package/dist/contexts/markdown.d.ts +1 -1
- package/dist/contexts/markdown.js +2 -2
- package/dist/contexts/navigation.d.ts +1 -1
- package/dist/contexts/use-components.d.ts +13 -10
- package/dist/{contexts-CVj20VV4.js → contexts-_NNW5yqC.js} +5 -2
- package/dist/{csharp-D6_jlynY.js → csharp-sn5CJu9t.js} +2 -2
- package/dist/{docs-g4IPmtZr.d.ts → docs-Cu9Yl6-y.d.ts} +24 -6
- package/dist/docs-YgoQ3bzY.js +81 -0
- package/dist/{docs-z3fl2eW-.d.ts → docs-xb5wYGjM.d.ts} +25 -7
- package/dist/{go-COaHV3Hc.js → go-BoaAVmP0.js} +2 -2
- package/dist/{http-fOPCX17A.js → http-B3qTyMc3.js} +5 -5
- package/dist/index-BOmn7DHa.d.ts +428 -0
- package/dist/index-BvcPmB0r.d.ts +428 -0
- package/dist/{index-CwjGm9zX.d.ts → index-W4Td2Hl7.d.ts} +46 -31
- package/dist/index.d.ts +14 -17
- package/dist/index.js +24 -24
- package/dist/{java-CxGSJVvv.js → java-BiLRuLuD.js} +3 -3
- package/dist/languages/cli.d.ts +13 -11
- package/dist/languages/cli.js +15 -15
- package/dist/languages/csharp.d.ts +13 -11
- package/dist/languages/csharp.js +4 -4
- package/dist/languages/go.d.ts +13 -11
- package/dist/languages/go.js +4 -4
- package/dist/languages/http.d.ts +13 -11
- package/dist/languages/http.js +14 -14
- package/dist/languages/index.d.ts +13 -11
- package/dist/languages/index.js +23 -23
- package/dist/languages/java.d.ts +13 -11
- package/dist/languages/java.js +4 -4
- package/dist/languages/python.d.ts +13 -11
- package/dist/languages/python.js +4 -4
- package/dist/languages/ruby.d.ts +13 -11
- package/dist/languages/ruby.js +4 -4
- package/dist/languages/terraform.d.ts +13 -11
- package/dist/languages/terraform.js +4 -4
- package/dist/languages/typescript.d.ts +13 -11
- package/dist/languages/typescript.js +4 -4
- package/dist/languages-vUhD5Hu_.js +30 -0
- package/dist/markdown/index.d.ts +2 -2
- package/dist/markdown/index.js +24 -24
- package/dist/markdown/printer.d.ts +2 -2
- package/dist/markdown/printer.js +25 -25
- package/dist/markdown/utils.d.ts +4 -4
- package/dist/markdown/utils.js +3 -3
- package/dist/{markdown-Cibv9fDR.d.ts → markdown-BszOPZhh.d.ts} +2 -2
- package/dist/{markdown-CTKHMLVr.js → markdown-Cq3XEhrR.js} +1 -1
- package/dist/{markdown-Cdh0TSHp.d.ts → markdown-plMAoN22.d.ts} +2 -2
- package/dist/{method-630cPKDl.d.ts → method-C4PgTWAu.d.ts} +6 -6
- package/dist/{method-BzkPRXGL.d.ts → method-D6R_farj.d.ts} +6 -6
- package/dist/{method-BPDUyBlD.js → method-DjzVBzZe.js} +2 -2
- package/dist/{navigation-BW-SBvb4.d.ts → navigation-HiZWRl34.d.ts} +3 -3
- package/dist/{navigation-DWYqC_HX.d.ts → navigation-MrP4Ubbg.d.ts} +3 -3
- package/dist/{overview-Cui1XtuC.d.ts → overview-CTeKhpQq.d.ts} +7 -7
- package/dist/{overview-RXc9iPzz.d.ts → overview-Yf1PTJNi.d.ts} +7 -7
- package/dist/{overview-DFwfIK6k.js → overview-ocTARt-j.js} +5 -5
- package/dist/{primitives-DJEqe_r1.js → primitives-CNG-fEhQ.js} +3 -3
- package/dist/{primitives-DhGxFYx6.d.ts → primitives-K7NijV36.d.ts} +11 -11
- package/dist/{primitives-MsH-h0bU.d.ts → primitives-WGxdBJDS.d.ts} +11 -11
- package/dist/{properties-C9W4QJ_F.d.ts → properties-Bu4nW9JD.d.ts} +5 -5
- package/dist/{properties-BnbBKd5a.js → properties-DQU0NBzb.js} +11 -5
- package/dist/{python-DsTuWCKE.js → python-nqOBH7GS.js} +2 -2
- package/dist/{routing-Cm_9XJiQ.d.ts → routing-pAL4V4hv.d.ts} +1 -1
- package/dist/routing.d.ts +1 -1
- package/dist/{ruby-BncKp6hd.js → ruby-BBc8HdIt.js} +3 -3
- package/dist/{sdk-Bw99eXxA.js → sdk-BSdgEEJw.js} +13 -7
- package/dist/{sdk-GMOw94wL.d.ts → sdk-BVCk1ox2.d.ts} +17 -17
- package/dist/{sdk-BvZeXpsj.d.ts → sdk-Dm0S-XQE.d.ts} +17 -17
- package/dist/{sdk-sidebar-VNY2-O1Y.d.ts → sdk-sidebar-B1ehT_xI.d.ts} +3 -3
- package/dist/{sdk-sidebar-V_MTkVw8.js → sdk-sidebar-BDn8S1xS.js} +1 -1
- package/dist/{sdk-sidebar-NCBSWuUW.d.ts → sdk-sidebar-Dqeu7C1-.d.ts} +3 -3
- package/dist/snippets-CLpNVNlA.js +181 -0
- package/dist/spec.d.ts +2 -2
- package/dist/spec.js +1 -1
- package/dist/{stl-sidebar-CXzs_shz.d.ts → stl-sidebar-BTTErIJs.d.ts} +2 -2
- package/dist/{stl-sidebar-DSkUHwcU.d.ts → stl-sidebar-C7GNALtk.d.ts} +2 -2
- package/dist/{stl-sidebar-WtimNrk1.js → stl-sidebar-DC5UOJiT.js} +1 -1
- package/dist/{style-HpXpcJ9v.js → style-DJIYkFhO.js} +6 -0
- package/dist/style.d.ts +6 -0
- package/dist/style.js +1 -1
- package/dist/styles/main.css +59 -14
- package/dist/styles.css +59 -14
- package/dist/{terraform-B95X4rNK.js → terraform-DVx2ea2h.js} +3 -3
- package/dist/{typescript-n46M9OtL.js → typescript-Cmk-jBBw.js} +3 -3
- package/dist/utils.d.ts +1 -1
- package/package.json +2 -2
- package/dist/docs-BmOB2f-I.js +0 -61
- package/dist/index-B8Zys1C2.d.ts +0 -347
- package/dist/index-C5Zmb2CI.d.ts +0 -16
- package/dist/index-D7PkxNgB.d.ts +0 -16
- package/dist/index-DIaM6Ync.d.ts +0 -347
- package/dist/languages-B6eap2M6.js +0 -30
- package/dist/routing-utiR5mY3.d.ts +0 -61
- package/dist/snippets-BehbU3rt.js +0 -164
- package/dist/snippets-Bj7Ey56K.d.ts +0 -53
- package/dist/snippets-CQQSDvg2.d.ts +0 -53
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as react0 from "react";
|
|
2
2
|
import { ReactNode } from "react";
|
|
3
|
-
import * as
|
|
3
|
+
import * as react_jsx_runtime23 from "react/jsx-runtime";
|
|
4
4
|
|
|
5
5
|
//#region src/components/primitives.d.ts
|
|
6
6
|
type JoinProps = {
|
|
@@ -12,7 +12,7 @@ declare function Join({
|
|
|
12
12
|
items,
|
|
13
13
|
limit,
|
|
14
14
|
children
|
|
15
|
-
}: JoinProps):
|
|
15
|
+
}: JoinProps): react_jsx_runtime23.JSX.Element[];
|
|
16
16
|
type ExpanderProps = {
|
|
17
17
|
id?: string;
|
|
18
18
|
open?: boolean;
|
|
@@ -28,19 +28,19 @@ declare function Expander({
|
|
|
28
28
|
virtual,
|
|
29
29
|
muted,
|
|
30
30
|
children
|
|
31
|
-
}: ExpanderProps):
|
|
31
|
+
}: ExpanderProps): react_jsx_runtime23.JSX.Element;
|
|
32
32
|
declare function VirtualExpander({
|
|
33
33
|
id,
|
|
34
34
|
open: isOpen,
|
|
35
35
|
muted,
|
|
36
36
|
summary,
|
|
37
37
|
children
|
|
38
|
-
}: Omit<ExpanderProps, 'virtual'>):
|
|
38
|
+
}: Omit<ExpanderProps, 'virtual'>): react_jsx_runtime23.JSX.Element;
|
|
39
39
|
declare function Markdown({
|
|
40
40
|
content
|
|
41
41
|
}: {
|
|
42
42
|
content: string;
|
|
43
|
-
}): "" |
|
|
43
|
+
}): "" | react_jsx_runtime23.JSX.Element | undefined;
|
|
44
44
|
type BadgeProps = {
|
|
45
45
|
id: string;
|
|
46
46
|
children?: ReactNode;
|
|
@@ -48,7 +48,7 @@ type BadgeProps = {
|
|
|
48
48
|
declare function Badge({
|
|
49
49
|
id,
|
|
50
50
|
children
|
|
51
|
-
}: BadgeProps):
|
|
51
|
+
}: BadgeProps): react_jsx_runtime23.JSX.Element;
|
|
52
52
|
type TooltipProps = {
|
|
53
53
|
content: ReactNode;
|
|
54
54
|
children: ReactNode;
|
|
@@ -56,7 +56,7 @@ type TooltipProps = {
|
|
|
56
56
|
declare function Tooltip({
|
|
57
57
|
content,
|
|
58
58
|
children
|
|
59
|
-
}: TooltipProps): string | number | bigint | boolean |
|
|
59
|
+
}: TooltipProps): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react0.ReactPortal | react0.ReactElement<unknown, string | react0.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime23.JSX.Element | null | undefined;
|
|
60
60
|
type LinkProps = {
|
|
61
61
|
stainlessPath?: string;
|
|
62
62
|
scroll?: boolean;
|
|
@@ -67,7 +67,7 @@ declare function Link({
|
|
|
67
67
|
scroll,
|
|
68
68
|
children,
|
|
69
69
|
...props
|
|
70
|
-
}: LinkProps): string | number | bigint | boolean |
|
|
70
|
+
}: LinkProps): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react0.ReactPortal | react0.ReactElement<unknown, string | react0.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime23.JSX.Element | null | undefined;
|
|
71
71
|
type InputProps = {
|
|
72
72
|
left?: ReactNode;
|
|
73
73
|
right?: ReactNode;
|
|
@@ -79,7 +79,7 @@ declare function Input({
|
|
|
79
79
|
ref,
|
|
80
80
|
className,
|
|
81
81
|
...props
|
|
82
|
-
}: InputProps):
|
|
82
|
+
}: InputProps): react_jsx_runtime23.JSX.Element;
|
|
83
83
|
type ToggleButtonProps = {
|
|
84
84
|
children?: ReactNode;
|
|
85
85
|
selected?: boolean;
|
|
@@ -89,7 +89,7 @@ declare function ToggleButton({
|
|
|
89
89
|
selected,
|
|
90
90
|
ref,
|
|
91
91
|
...props
|
|
92
|
-
}: ToggleButtonProps):
|
|
92
|
+
}: ToggleButtonProps): react_jsx_runtime23.JSX.Element;
|
|
93
93
|
type ListViewProps<TItem> = {
|
|
94
94
|
items: Array<TItem>;
|
|
95
95
|
itemDelegate: (item: TItem, selected: boolean) => React.ReactNode;
|
|
@@ -100,6 +100,6 @@ declare function ListView<TItem>({
|
|
|
100
100
|
itemDelegate,
|
|
101
101
|
onSelectListItem,
|
|
102
102
|
...rest
|
|
103
|
-
}: ListViewProps<TItem>):
|
|
103
|
+
}: ListViewProps<TItem>): react_jsx_runtime23.JSX.Element;
|
|
104
104
|
//#endregion
|
|
105
105
|
export { Join as a, ListViewProps as c, ToggleButtonProps as d, Tooltip as f, InputProps as i, Markdown as l, Expander as n, Link as o, VirtualExpander as p, Input as r, ListView as s, Badge as t, ToggleButton as u };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ReactNode } from "react";
|
|
2
|
-
import * as
|
|
2
|
+
import * as react_jsx_runtime33 from "react/jsx-runtime";
|
|
3
3
|
|
|
4
4
|
//#region src/components/properties.d.ts
|
|
5
5
|
type PropertyToggleProps = {
|
|
@@ -7,19 +7,19 @@ type PropertyToggleProps = {
|
|
|
7
7
|
};
|
|
8
8
|
declare function PropertyToggle({
|
|
9
9
|
target
|
|
10
|
-
}: PropertyToggleProps):
|
|
10
|
+
}: PropertyToggleProps): react_jsx_runtime33.JSX.Element;
|
|
11
11
|
type PropertyDescriptionProps = {
|
|
12
12
|
description?: string;
|
|
13
13
|
};
|
|
14
14
|
declare function PropertyDescription({
|
|
15
15
|
description
|
|
16
|
-
}: PropertyDescriptionProps):
|
|
16
|
+
}: PropertyDescriptionProps): react_jsx_runtime33.JSX.Element | undefined;
|
|
17
17
|
type PropertyTitleProps = {
|
|
18
18
|
title?: string;
|
|
19
19
|
};
|
|
20
20
|
declare function PropertyTitle({
|
|
21
21
|
title
|
|
22
|
-
}: PropertyTitleProps):
|
|
22
|
+
}: PropertyTitleProps): react_jsx_runtime33.JSX.Element | undefined;
|
|
23
23
|
type PropertyProps = {
|
|
24
24
|
id?: string;
|
|
25
25
|
name?: ReactNode;
|
|
@@ -49,6 +49,6 @@ declare function Property({
|
|
|
49
49
|
additional,
|
|
50
50
|
constraints,
|
|
51
51
|
children
|
|
52
|
-
}: PropertyProps):
|
|
52
|
+
}: PropertyProps): react_jsx_runtime33.JSX.Element | null;
|
|
53
53
|
//#endregion
|
|
54
54
|
export { PropertyTitle as a, PropertyToggleProps as c, PropertyProps as i, PropertyDescription as n, PropertyTitleProps as o, PropertyDescriptionProps as r, PropertyToggle as s, Property as t };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { l as useSettings, o as useIgnoredResources, s as useLanguage } from "./docs-
|
|
1
|
+
import { l as useSettings, o as useIgnoredResources, s as useLanguage } from "./docs-YgoQ3bzY.js";
|
|
2
2
|
import { t as useComponents } from "./use-components-BUz3GbO4.js";
|
|
3
|
-
import { t as style_default } from "./style-
|
|
3
|
+
import { t as style_default } from "./style-DJIYkFhO.js";
|
|
4
4
|
import { Fragment, jsx, jsxs } from "react/jsx-runtime";
|
|
5
5
|
import { ArrowDownWideNarrowIcon, ArrowUpNarrowWideIcon } from "lucide-react";
|
|
6
6
|
|
|
@@ -39,6 +39,11 @@ function PropertyTitle({ title }) {
|
|
|
39
39
|
children: /* @__PURE__ */ jsx(Markdown, { content: title })
|
|
40
40
|
});
|
|
41
41
|
}
|
|
42
|
+
function splitDescription(description) {
|
|
43
|
+
const pos = description?.indexOf("\n\n");
|
|
44
|
+
if (!description || !pos || pos < 0) return [description, null];
|
|
45
|
+
return [description.slice(0, pos), description.slice(pos)];
|
|
46
|
+
}
|
|
42
47
|
function Property({ id, name, typeName, badges, type, declaration, description, title, deprecated, expand, additional, constraints, children }) {
|
|
43
48
|
const Docs = useComponents();
|
|
44
49
|
const language = useLanguage();
|
|
@@ -46,12 +51,13 @@ function Property({ id, name, typeName, badges, type, declaration, description,
|
|
|
46
51
|
if (useIgnoredResources().includes(id || "")) return null;
|
|
47
52
|
const { collapseDescription, showTitle } = properties ?? {};
|
|
48
53
|
const types = properties?.types;
|
|
54
|
+
const [descFirstLine, descRest] = collapseDescription === "show-first-line" ? splitDescription(description) : [null, description];
|
|
49
55
|
const textContent = /* @__PURE__ */ jsxs(Fragment, { children: [
|
|
50
56
|
typeof deprecated === "string" && /* @__PURE__ */ jsx("div", {
|
|
51
57
|
className: style_default.PropertyDeprecatedMessage,
|
|
52
58
|
children: deprecated
|
|
53
59
|
}),
|
|
54
|
-
|
|
60
|
+
descRest && /* @__PURE__ */ jsx(Docs.PropertyDescription, { description: descRest }),
|
|
55
61
|
constraints && /* @__PURE__ */ jsx("div", {
|
|
56
62
|
className: style_default.PropertyContent,
|
|
57
63
|
children: constraints
|
|
@@ -73,7 +79,7 @@ function Property({ id, name, typeName, badges, type, declaration, description,
|
|
|
73
79
|
]
|
|
74
80
|
}),
|
|
75
81
|
title && showTitle && /* @__PURE__ */ jsx(Docs.PropertyTitle, { title }),
|
|
76
|
-
collapseDescription === false ? textContent :
|
|
82
|
+
collapseDescription === false ? textContent : descFirstLine && /* @__PURE__ */ jsx(Docs.PropertyDescription, { description: descFirstLine })
|
|
77
83
|
] });
|
|
78
84
|
const simple = /* @__PURE__ */ jsxs(Fragment, { children: [
|
|
79
85
|
name && /* @__PURE__ */ jsxs("div", {
|
|
@@ -112,7 +118,7 @@ function Property({ id, name, typeName, badges, type, declaration, description,
|
|
|
112
118
|
return /* @__PURE__ */ jsx("div", {
|
|
113
119
|
className: style_default.Property,
|
|
114
120
|
"data-stldocs-language": language,
|
|
115
|
-
children: children || collapseDescription !== false &&
|
|
121
|
+
children: children || collapseDescription !== false && descRest ? /* @__PURE__ */ jsxs(Docs.Expander, {
|
|
116
122
|
summary: content,
|
|
117
123
|
muted: !children,
|
|
118
124
|
open: expand,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { t as __exportAll } from "./chunk-BN_g-Awi.js";
|
|
2
|
-
import { n as useLanguageComponents } from "./contexts-
|
|
2
|
+
import { n as useLanguageComponents } from "./contexts-_NNW5yqC.js";
|
|
3
3
|
import { t as useComponents } from "./use-components-BUz3GbO4.js";
|
|
4
|
-
import { t as style_default } from "./style-
|
|
4
|
+
import { t as style_default } from "./style-DJIYkFhO.js";
|
|
5
5
|
import * as React$1 from "react";
|
|
6
6
|
import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
|
|
7
7
|
|
package/dist/routing.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { S as walkTree, _ as parseStainlessPath, a as RouteEntry, b as trimStainlessPath, c as expandToElement, d as generateRoute, f as generateRouteList, g as parseRoute, h as isSupportedLanguage, i as ParsedStainlessPath, l as findNavigationPath, m as getResource, n as LanguageNames, o as SpecTreeEntry, p as getLanguageSnippet, r as Languages, s as SupportedLanguageSyntaxes, t as DocsLanguage, u as generateMissingRouteList, x as updateHistory, y as scrollToPath } from "./routing-
|
|
1
|
+
import { S as walkTree, _ as parseStainlessPath, a as RouteEntry, b as trimStainlessPath, c as expandToElement, d as generateRoute, f as generateRouteList, g as parseRoute, h as isSupportedLanguage, i as ParsedStainlessPath, l as findNavigationPath, m as getResource, n as LanguageNames, o as SpecTreeEntry, p as getLanguageSnippet, r as Languages, s as SupportedLanguageSyntaxes, t as DocsLanguage, u as generateMissingRouteList, x as updateHistory, y as scrollToPath } from "./routing-pAL4V4hv.js";
|
|
2
2
|
export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateMissingRouteList, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { t as __exportAll } from "./chunk-BN_g-Awi.js";
|
|
2
|
-
import {
|
|
3
|
-
import { n as useLanguageComponents } from "./contexts-
|
|
2
|
+
import { i as useDeclaration, m as useSpec, s as useLanguage } from "./docs-YgoQ3bzY.js";
|
|
3
|
+
import { n as useLanguageComponents } from "./contexts-_NNW5yqC.js";
|
|
4
4
|
import { t as useComponents } from "./use-components-BUz3GbO4.js";
|
|
5
|
-
import { t as style_default } from "./style-
|
|
5
|
+
import { t as style_default } from "./style-DJIYkFhO.js";
|
|
6
6
|
import * as React$1 from "react";
|
|
7
7
|
import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
|
|
8
8
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { d as
|
|
1
|
+
import { d as useSnippetIds, f as useSnippetResponse, i as useDeclaration, l as useSettings, m as useSpec, n as useAvailableLanguages, r as useContentPanelLayout, s as useLanguage } from "./docs-YgoQ3bzY.js";
|
|
2
2
|
import { n as useNavigation } from "./navigation-aoYZ_tl4.js";
|
|
3
|
-
import { n as useLanguageComponents } from "./contexts-
|
|
3
|
+
import { n as useLanguageComponents } from "./contexts-_NNW5yqC.js";
|
|
4
4
|
import { t as useComponents } from "./use-components-BUz3GbO4.js";
|
|
5
|
-
import { t as style_default } from "./style-
|
|
5
|
+
import { t as style_default } from "./style-DJIYkFhO.js";
|
|
6
6
|
import { l as getLanguageSnippet, p as parseStainlessPath, s as generateRoute, t as LanguageNames } from "./routing-C64k4fmX.js";
|
|
7
7
|
import { a as JavaIcon, c as PythonIcon, d as TypescriptIcon, i as GoIcon, l as RubyIcon, n as CSharpIcon, o as KotlinIcon, r as CurlIcon, s as PowershellIcon, t as CLIIcon, u as TerraformIcon } from "./icons-BYKn5X8E.js";
|
|
8
8
|
import * as React$1 from "react";
|
|
@@ -96,7 +96,7 @@ function SDKDeclaration({ path, expand, depth = 0 }) {
|
|
|
96
96
|
const parsedPath = selectedPath ? parseStainlessPath(selectedPath) : null;
|
|
97
97
|
const modelPropSetting = settings?.properties?.includeModelProperties;
|
|
98
98
|
const inlineModelProps = modelPropSetting === "method-page" ? Boolean(parsedPath?.method) : modelPropSetting !== false;
|
|
99
|
-
const isUnion = "childrenParentSchema" in decl && decl.childrenParentSchema && ["enum", "union"].includes(decl.childrenParentSchema);
|
|
99
|
+
const isUnion = "childrenParentSchema" in decl && decl.childrenParentSchema && decl.kind !== "CLIFlag" && decl.kind !== "CLISchemaProperty" && ["enum", "union"].includes(decl.childrenParentSchema);
|
|
100
100
|
const id = model?.propertyPath ? `${model.propertyPath} + ${path}` : path;
|
|
101
101
|
const shouldExpand = selectedPath?.startsWith(path) && nesting.length < 1 || settings?.properties?.expandDepth && depth <= settings?.properties?.expandDepth && !isUnion || expand;
|
|
102
102
|
const hasChildren = "children" in decl && (decl.children?.length ?? 0) > 0 && !decl.children?.includes(path) && !(isUnion && decl.childrenParentSchema === "enum" && decl.children?.length === 1) && (inlineModelProps || !("modelPath" in decl));
|
|
@@ -105,7 +105,7 @@ function SDKDeclaration({ path, expand, depth = 0 }) {
|
|
|
105
105
|
children: ({ ...props }) => /* @__PURE__ */ jsx(Docs.Property, {
|
|
106
106
|
id,
|
|
107
107
|
expand: shouldExpand,
|
|
108
|
-
constraints: "constraints" in decl && /* @__PURE__ */ jsx(Docs.SDKConstraints, { constraints: decl["constraints"] }),
|
|
108
|
+
constraints: "constraints" in decl && decl.kind !== "CLIFlag" && decl.kind !== "CLISchemaProperty" && /* @__PURE__ */ jsx(Docs.SDKConstraints, { constraints: decl["constraints"] }),
|
|
109
109
|
declaration: /* @__PURE__ */ jsx(Lang.Declaration, { decl }),
|
|
110
110
|
title: "title" in decl ? decl.title : void 0,
|
|
111
111
|
description: "docstring" in decl ? decl["docstring"] : void 0,
|
|
@@ -180,7 +180,12 @@ function SDKRequestTitle({ snippetLanguage }) {
|
|
|
180
180
|
}
|
|
181
181
|
function SDKExample({ method, transformRequestSnippet }) {
|
|
182
182
|
const Docs = useComponents();
|
|
183
|
-
const
|
|
183
|
+
const language = useLanguage();
|
|
184
|
+
const snippetLanguage = getLanguageSnippet(language);
|
|
185
|
+
if ((useSnippetIds(method.stainlessPath, language)?.filter((id) => id !== "default")?.length ?? 0) >= 2) return /* @__PURE__ */ jsx(Docs.MultiSnippets, {
|
|
186
|
+
requestTitle: /* @__PURE__ */ jsx(Docs.SDKRequestTitle, { snippetLanguage }),
|
|
187
|
+
method
|
|
188
|
+
});
|
|
184
189
|
return /* @__PURE__ */ jsx(Docs.Snippet, {
|
|
185
190
|
requestTitle: /* @__PURE__ */ jsx(Docs.SDKRequestTitle, { snippetLanguage }),
|
|
186
191
|
method,
|
|
@@ -284,6 +289,7 @@ function SDKMethod({ method, transformRequestSnippet }) {
|
|
|
284
289
|
const Docs = useComponents();
|
|
285
290
|
const decl = useDeclaration(method?.stainlessPath, false);
|
|
286
291
|
const layout = useContentPanelLayout();
|
|
292
|
+
const defaultResponses = useSnippetResponse(method.stainlessPath);
|
|
287
293
|
if (!decl) return /* @__PURE__ */ jsx(SDKMethodNotImplemented, { method });
|
|
288
294
|
return /* @__PURE__ */ jsxs(Docs.Method, {
|
|
289
295
|
id: method.stainlessPath,
|
|
@@ -306,7 +312,7 @@ function SDKMethod({ method, transformRequestSnippet }) {
|
|
|
306
312
|
}),
|
|
307
313
|
/* @__PURE__ */ jsxs("div", {
|
|
308
314
|
className: style_default.MethodResponseColumn,
|
|
309
|
-
children: [/* @__PURE__ */ jsx("h5", { children: "Returns Examples" }), /* @__PURE__ */ jsx(Docs.SnippetResponse, { responses:
|
|
315
|
+
children: [/* @__PURE__ */ jsx("h5", { children: "Returns Examples" }), /* @__PURE__ */ jsx(Docs.SnippetResponse, { responses: defaultResponses })]
|
|
310
316
|
})
|
|
311
317
|
]
|
|
312
318
|
});
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { c as ID, d as Method, f as Model, g as SnippetLanguage, o as HasStainlessPath, t as BaseDeclaration } from "./index-
|
|
2
|
-
import { t as DocsLanguage } from "./routing-
|
|
1
|
+
import { c as ID, d as Method, f as Model, g as SnippetLanguage, o as HasStainlessPath, t as BaseDeclaration } from "./index-W4Td2Hl7.js";
|
|
2
|
+
import { t as DocsLanguage } from "./routing-pAL4V4hv.js";
|
|
3
3
|
import * as React$1 from "react";
|
|
4
|
-
import * as
|
|
4
|
+
import * as react_jsx_runtime0 from "react/jsx-runtime";
|
|
5
5
|
|
|
6
6
|
//#region src/components/sdk.d.ts
|
|
7
7
|
type PropertyModelContextType = {
|
|
@@ -33,7 +33,7 @@ declare function SDKChildren({
|
|
|
33
33
|
paths,
|
|
34
34
|
expand,
|
|
35
35
|
depth
|
|
36
|
-
}: SDKChildrenProps):
|
|
36
|
+
}: SDKChildrenProps): react_jsx_runtime0.JSX.Element;
|
|
37
37
|
type SDKDeclarationProps = {
|
|
38
38
|
path: string;
|
|
39
39
|
expand?: boolean;
|
|
@@ -43,26 +43,26 @@ declare function SDKDeclaration({
|
|
|
43
43
|
path,
|
|
44
44
|
expand,
|
|
45
45
|
depth
|
|
46
|
-
}: SDKDeclarationProps):
|
|
46
|
+
}: SDKDeclarationProps): react_jsx_runtime0.JSX.Element;
|
|
47
47
|
type SDKConstraintsProps = {
|
|
48
|
-
constraints?: Record<string,
|
|
48
|
+
constraints?: Record<string, unknown>;
|
|
49
49
|
};
|
|
50
50
|
declare function SDKConstraints({
|
|
51
51
|
constraints
|
|
52
|
-
}: SDKConstraintsProps):
|
|
52
|
+
}: SDKConstraintsProps): react_jsx_runtime0.JSX.Element | undefined;
|
|
53
53
|
type SDKIconProps = {
|
|
54
54
|
language: SnippetLanguage;
|
|
55
55
|
size?: number;
|
|
56
56
|
};
|
|
57
57
|
declare function SDKIcon({
|
|
58
58
|
language
|
|
59
|
-
}: SDKIconProps):
|
|
59
|
+
}: SDKIconProps): react_jsx_runtime0.JSX.Element | null;
|
|
60
60
|
type SDKRequestTitleProps = {
|
|
61
61
|
snippetLanguage: SnippetLanguage;
|
|
62
62
|
};
|
|
63
63
|
declare function SDKRequestTitle({
|
|
64
64
|
snippetLanguage
|
|
65
|
-
}: SDKRequestTitleProps):
|
|
65
|
+
}: SDKRequestTitleProps): react_jsx_runtime0.JSX.Element;
|
|
66
66
|
type SDKExampleProps = {
|
|
67
67
|
method: Partial<Method> & HasStainlessPath;
|
|
68
68
|
transformRequestSnippet?: TransformRequestSnippetFn;
|
|
@@ -70,31 +70,31 @@ type SDKExampleProps = {
|
|
|
70
70
|
declare function SDKExample({
|
|
71
71
|
method,
|
|
72
72
|
transformRequestSnippet
|
|
73
|
-
}: SDKExampleProps):
|
|
73
|
+
}: SDKExampleProps): react_jsx_runtime0.JSX.Element;
|
|
74
74
|
type SDKMethodProps = {
|
|
75
75
|
method: Method;
|
|
76
76
|
transformRequestSnippet?: TransformRequestSnippetFn;
|
|
77
77
|
};
|
|
78
78
|
declare function SDKMethodHeader({
|
|
79
79
|
method
|
|
80
|
-
}: SDKMethodProps):
|
|
80
|
+
}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
|
|
81
81
|
declare function useStreamingResponse(method: BaseDeclaration): ID | undefined;
|
|
82
82
|
declare function SDKMethodInfo({
|
|
83
83
|
method
|
|
84
|
-
}: SDKMethodProps):
|
|
84
|
+
}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
|
|
85
85
|
declare function SDKMethodNotImplemented({
|
|
86
86
|
method
|
|
87
|
-
}: SDKMethodProps):
|
|
87
|
+
}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
|
|
88
88
|
declare function SDKMethod({
|
|
89
89
|
method,
|
|
90
90
|
transformRequestSnippet
|
|
91
|
-
}: SDKMethodProps):
|
|
91
|
+
}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
|
|
92
92
|
type SDKModelProps = {
|
|
93
93
|
model: Model;
|
|
94
94
|
};
|
|
95
95
|
declare function SDKModel({
|
|
96
96
|
model
|
|
97
|
-
}: SDKModelProps):
|
|
97
|
+
}: SDKModelProps): react_jsx_runtime0.JSX.Element | null;
|
|
98
98
|
type SDKReferenceProps = {
|
|
99
99
|
stainlessPath: string;
|
|
100
100
|
children?: React$1.ReactNode;
|
|
@@ -102,7 +102,7 @@ type SDKReferenceProps = {
|
|
|
102
102
|
declare function SDKReference({
|
|
103
103
|
stainlessPath,
|
|
104
104
|
children
|
|
105
|
-
}: SDKReferenceProps): string | number | bigint | boolean |
|
|
105
|
+
}: SDKReferenceProps): string | number | bigint | boolean | Iterable<React$1.ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<React$1.ReactNode> | null | undefined> | react_jsx_runtime0.JSX.Element | null | undefined;
|
|
106
106
|
type SDKLanguageBlockProps = {
|
|
107
107
|
language: DocsLanguage;
|
|
108
108
|
version: string;
|
|
@@ -117,6 +117,6 @@ declare function SDKLanguageBlock({
|
|
|
117
117
|
version,
|
|
118
118
|
install,
|
|
119
119
|
links
|
|
120
|
-
}: SDKLanguageBlockProps):
|
|
120
|
+
}: SDKLanguageBlockProps): react_jsx_runtime0.JSX.Element;
|
|
121
121
|
//#endregion
|
|
122
122
|
export { SDKSnippetLanguagesType as C, useStreamingResponse as D, useReferenceNesting as E, SDKSnippetLanguages as S, usePropertyModel as T, SDKModel as _, SDKChildren as a, SDKRequestTitle as b, SDKDeclaration as c, SDKLanguageBlock as d, SDKMethod as f, SDKMethodProps as g, SDKMethodNotImplemented as h, ReferenceNestingContextType as i, SDKExample as l, SDKMethodInfo as m, PropertyModelContextType as n, SDKConstraints as o, SDKMethodHeader as p, ReferenceNestingContext as r, SDKConstraintsProps as s, PropertyModelContext as t, SDKIcon as u, SDKModelProps as v, TransformRequestSnippetFn as w, SDKRequestTitleProps as x, SDKReference as y };
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { c as ID, d as Method, f as Model, g as SnippetLanguage, o as HasStainlessPath, t as BaseDeclaration } from "./index-
|
|
2
|
-
import { t as DocsLanguage } from "./routing-
|
|
1
|
+
import { c as ID, d as Method, f as Model, g as SnippetLanguage, o as HasStainlessPath, t as BaseDeclaration } from "./index-W4Td2Hl7.js";
|
|
2
|
+
import { t as DocsLanguage } from "./routing-pAL4V4hv.js";
|
|
3
3
|
import * as React$1 from "react";
|
|
4
|
-
import * as
|
|
4
|
+
import * as react_jsx_runtime38 from "react/jsx-runtime";
|
|
5
5
|
|
|
6
6
|
//#region src/components/sdk.d.ts
|
|
7
7
|
type PropertyModelContextType = {
|
|
@@ -33,7 +33,7 @@ declare function SDKChildren({
|
|
|
33
33
|
paths,
|
|
34
34
|
expand,
|
|
35
35
|
depth
|
|
36
|
-
}: SDKChildrenProps):
|
|
36
|
+
}: SDKChildrenProps): react_jsx_runtime38.JSX.Element;
|
|
37
37
|
type SDKDeclarationProps = {
|
|
38
38
|
path: string;
|
|
39
39
|
expand?: boolean;
|
|
@@ -43,26 +43,26 @@ declare function SDKDeclaration({
|
|
|
43
43
|
path,
|
|
44
44
|
expand,
|
|
45
45
|
depth
|
|
46
|
-
}: SDKDeclarationProps):
|
|
46
|
+
}: SDKDeclarationProps): react_jsx_runtime38.JSX.Element;
|
|
47
47
|
type SDKConstraintsProps = {
|
|
48
|
-
constraints?: Record<string,
|
|
48
|
+
constraints?: Record<string, unknown>;
|
|
49
49
|
};
|
|
50
50
|
declare function SDKConstraints({
|
|
51
51
|
constraints
|
|
52
|
-
}: SDKConstraintsProps):
|
|
52
|
+
}: SDKConstraintsProps): react_jsx_runtime38.JSX.Element | undefined;
|
|
53
53
|
type SDKIconProps = {
|
|
54
54
|
language: SnippetLanguage;
|
|
55
55
|
size?: number;
|
|
56
56
|
};
|
|
57
57
|
declare function SDKIcon({
|
|
58
58
|
language
|
|
59
|
-
}: SDKIconProps):
|
|
59
|
+
}: SDKIconProps): react_jsx_runtime38.JSX.Element | null;
|
|
60
60
|
type SDKRequestTitleProps = {
|
|
61
61
|
snippetLanguage: SnippetLanguage;
|
|
62
62
|
};
|
|
63
63
|
declare function SDKRequestTitle({
|
|
64
64
|
snippetLanguage
|
|
65
|
-
}: SDKRequestTitleProps):
|
|
65
|
+
}: SDKRequestTitleProps): react_jsx_runtime38.JSX.Element;
|
|
66
66
|
type SDKExampleProps = {
|
|
67
67
|
method: Partial<Method> & HasStainlessPath;
|
|
68
68
|
transformRequestSnippet?: TransformRequestSnippetFn;
|
|
@@ -70,31 +70,31 @@ type SDKExampleProps = {
|
|
|
70
70
|
declare function SDKExample({
|
|
71
71
|
method,
|
|
72
72
|
transformRequestSnippet
|
|
73
|
-
}: SDKExampleProps):
|
|
73
|
+
}: SDKExampleProps): react_jsx_runtime38.JSX.Element;
|
|
74
74
|
type SDKMethodProps = {
|
|
75
75
|
method: Method;
|
|
76
76
|
transformRequestSnippet?: TransformRequestSnippetFn;
|
|
77
77
|
};
|
|
78
78
|
declare function SDKMethodHeader({
|
|
79
79
|
method
|
|
80
|
-
}: SDKMethodProps):
|
|
80
|
+
}: SDKMethodProps): react_jsx_runtime38.JSX.Element;
|
|
81
81
|
declare function useStreamingResponse(method: BaseDeclaration): ID | undefined;
|
|
82
82
|
declare function SDKMethodInfo({
|
|
83
83
|
method
|
|
84
|
-
}: SDKMethodProps):
|
|
84
|
+
}: SDKMethodProps): react_jsx_runtime38.JSX.Element;
|
|
85
85
|
declare function SDKMethodNotImplemented({
|
|
86
86
|
method
|
|
87
|
-
}: SDKMethodProps):
|
|
87
|
+
}: SDKMethodProps): react_jsx_runtime38.JSX.Element;
|
|
88
88
|
declare function SDKMethod({
|
|
89
89
|
method,
|
|
90
90
|
transformRequestSnippet
|
|
91
|
-
}: SDKMethodProps):
|
|
91
|
+
}: SDKMethodProps): react_jsx_runtime38.JSX.Element;
|
|
92
92
|
type SDKModelProps = {
|
|
93
93
|
model: Model;
|
|
94
94
|
};
|
|
95
95
|
declare function SDKModel({
|
|
96
96
|
model
|
|
97
|
-
}: SDKModelProps):
|
|
97
|
+
}: SDKModelProps): react_jsx_runtime38.JSX.Element | null;
|
|
98
98
|
type SDKReferenceProps = {
|
|
99
99
|
stainlessPath: string;
|
|
100
100
|
children?: React$1.ReactNode;
|
|
@@ -102,7 +102,7 @@ type SDKReferenceProps = {
|
|
|
102
102
|
declare function SDKReference({
|
|
103
103
|
stainlessPath,
|
|
104
104
|
children
|
|
105
|
-
}: SDKReferenceProps): string | number | bigint | boolean | Iterable<React$1.ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<React$1.ReactNode> | null | undefined> |
|
|
105
|
+
}: SDKReferenceProps): string | number | bigint | boolean | Iterable<React$1.ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<React$1.ReactNode> | null | undefined> | react_jsx_runtime38.JSX.Element | null | undefined;
|
|
106
106
|
type SDKLanguageBlockProps = {
|
|
107
107
|
language: DocsLanguage;
|
|
108
108
|
version: string;
|
|
@@ -117,6 +117,6 @@ declare function SDKLanguageBlock({
|
|
|
117
117
|
version,
|
|
118
118
|
install,
|
|
119
119
|
links
|
|
120
|
-
}: SDKLanguageBlockProps):
|
|
120
|
+
}: SDKLanguageBlockProps): react_jsx_runtime38.JSX.Element;
|
|
121
121
|
//#endregion
|
|
122
122
|
export { SDKSnippetLanguagesType as C, useStreamingResponse as D, useReferenceNesting as E, SDKSnippetLanguages as S, usePropertyModel as T, SDKModel as _, SDKChildren as a, SDKRequestTitle as b, SDKDeclaration as c, SDKLanguageBlock as d, SDKMethod as f, SDKMethodProps as g, SDKMethodNotImplemented as h, ReferenceNestingContextType as i, SDKExample as l, SDKMethodInfo as m, PropertyModelContextType as n, SDKConstraints as o, SDKMethodHeader as p, ReferenceNestingContext as r, SDKConstraintsProps as s, PropertyModelContext as t, SDKIcon as u, SDKModelProps as v, TransformRequestSnippetFn as w, SDKRequestTitleProps as x, SDKReference as y };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { m as Resource } from "./index-
|
|
2
|
-
import * as
|
|
1
|
+
import { m as Resource } from "./index-W4Td2Hl7.js";
|
|
2
|
+
import * as react_jsx_runtime34 from "react/jsx-runtime";
|
|
3
3
|
|
|
4
4
|
//#region src/components/sdk-sidebar.d.ts
|
|
5
5
|
type SDKSidebarProps = {
|
|
@@ -10,6 +10,6 @@ type SDKSidebarProps = {
|
|
|
10
10
|
*/
|
|
11
11
|
declare function SDKSidebar({
|
|
12
12
|
resources
|
|
13
|
-
}: SDKSidebarProps):
|
|
13
|
+
}: SDKSidebarProps): react_jsx_runtime34.JSX.Element;
|
|
14
14
|
//#endregion
|
|
15
15
|
export { SDKSidebarProps as n, SDKSidebar as t };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { n as useNavigation } from "./navigation-aoYZ_tl4.js";
|
|
2
2
|
import { i as isResourceEmpty } from "./utils-DPbkW1Tz.js";
|
|
3
|
-
import { t as StlSidebar } from "./stl-sidebar-
|
|
3
|
+
import { t as StlSidebar } from "./stl-sidebar-DC5UOJiT.js";
|
|
4
4
|
import * as React$1 from "react";
|
|
5
5
|
import { jsx } from "react/jsx-runtime";
|
|
6
6
|
import { Badge, getHttpMethod } from "@stainless-api/ui-primitives";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { m as Resource } from "./index-
|
|
2
|
-
import * as
|
|
1
|
+
import { m as Resource } from "./index-W4Td2Hl7.js";
|
|
2
|
+
import * as react_jsx_runtime37 from "react/jsx-runtime";
|
|
3
3
|
|
|
4
4
|
//#region src/components/sdk-sidebar.d.ts
|
|
5
5
|
type SDKSidebarProps = {
|
|
@@ -10,6 +10,6 @@ type SDKSidebarProps = {
|
|
|
10
10
|
*/
|
|
11
11
|
declare function SDKSidebar({
|
|
12
12
|
resources
|
|
13
|
-
}: SDKSidebarProps):
|
|
13
|
+
}: SDKSidebarProps): react_jsx_runtime37.JSX.Element;
|
|
14
14
|
//#endregion
|
|
15
15
|
export { SDKSidebarProps as n, SDKSidebar as t };
|