@stainless-api/docs-ui 0.1.0-beta.63 → 0.1.0-beta.65
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-hzZqGExJ.js → breadcrumbs-C22Eos5U.js} +3 -3
- package/dist/{breadcrumbs-DwldC63b.d.ts → breadcrumbs-Cvm5Ifm7.d.ts} +1 -1
- package/dist/{cli-BAhN1pvm.js → cli-C9b02R53.js} +2 -2
- package/dist/{component-Bf-__z99.js → component-B5j-H4cO.js} +2 -2
- package/dist/{component-generics-uYXTXWFi.d.ts → component-generics-DBuEnCtJ.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 +2 -2
- package/dist/components/icons.d.ts +12 -12
- package/dist/components/index.d.ts +11 -11
- package/dist/components/index.js +10 -10
- package/dist/components/method.d.ts +1 -1
- package/dist/components/method.js +2 -2
- package/dist/components/overview.d.ts +1 -1
- package/dist/components/overview.js +3 -3
- package/dist/components/primitives.d.ts +1 -1
- package/dist/components/primitives.js +1 -1
- package/dist/components/properties.d.ts +1 -1
- package/dist/components/properties.js +1 -1
- package/dist/components/sdk-sidebar.d.ts +1 -1
- package/dist/components/sdk-sidebar.js +2 -2
- package/dist/components/sdk.d.ts +1 -1
- package/dist/components/sdk.js +1 -1
- package/dist/components/snippets.d.ts +2 -2
- package/dist/components/snippets.js +1 -1
- package/dist/components/stl-sidebar.d.ts +2 -2
- package/dist/components/stl-sidebar.js +1 -1
- package/dist/{components-CwIKWfid.js → components-C4bGzXqr.js} +9 -9
- package/dist/contexts/component-generics.d.ts +1 -1
- package/dist/contexts/component-types.d.ts +11 -11
- package/dist/contexts/component.d.ts +14 -14
- package/dist/contexts/component.js +21 -20
- package/dist/contexts/docs.d.ts +1 -1
- package/dist/contexts/index.d.ts +15 -15
- package/dist/contexts/markdown.d.ts +1 -1
- package/dist/contexts/navigation.d.ts +1 -1
- package/dist/contexts/use-components.d.ts +10 -10
- package/dist/{csharp-BD37FKH6.js → csharp-Ckuihkec.js} +1 -1
- package/dist/{docs-Chc8A7zc.d.ts → docs-CMkfabi3.d.ts} +3 -3
- package/dist/{go-v-i4WDzK.js → go-DrZxKwGv.js} +1 -1
- package/dist/{http-BKoVLcpv.js → http-BoZv04yo.js} +33 -4
- package/dist/{index-Dz6SFEud.d.ts → index-BYTDY59Z.d.ts} +10 -10
- package/dist/{index-DuHyTVVD.d.ts → index-CwjGm9zX.d.ts} +33 -2
- package/dist/index-DCqDybi3.d.ts +345 -0
- package/dist/index.d.ts +16 -16
- package/dist/index.js +23 -22
- package/dist/{java-A6j1NMJ7.js → java-DB33acTL.js} +1 -1
- package/dist/languages/cli.d.ts +11 -11
- package/dist/languages/cli.js +12 -12
- package/dist/languages/csharp.d.ts +11 -11
- package/dist/languages/csharp.js +1 -1
- package/dist/languages/go.d.ts +11 -11
- package/dist/languages/go.js +1 -1
- package/dist/languages/http.d.ts +11 -11
- package/dist/languages/http.js +11 -11
- package/dist/languages/index.d.ts +12 -12
- package/dist/languages/index.js +21 -20
- package/dist/languages/java.d.ts +11 -11
- package/dist/languages/java.js +1 -1
- package/dist/languages/python.d.ts +11 -11
- package/dist/languages/python.js +1 -1
- package/dist/languages/ruby.d.ts +11 -11
- package/dist/languages/ruby.js +1 -1
- package/dist/languages/terraform.d.ts +12 -0
- package/dist/languages/terraform.js +9 -0
- package/dist/languages/typescript.d.ts +11 -11
- package/dist/languages/typescript.js +1 -1
- package/dist/languages-ZaloBYTK.js +30 -0
- package/dist/markdown/index.d.ts +2 -2
- package/dist/markdown/index.js +21 -20
- package/dist/markdown/printer.d.ts +2 -2
- package/dist/markdown/printer.js +22 -21
- package/dist/markdown/utils.d.ts +3 -3
- package/dist/{markdown-CoIy7fea.d.ts → markdown-9xLfF9XX.d.ts} +2 -2
- package/dist/{method-Bt3V4B4q.d.ts → method-BwXzL3P1.d.ts} +6 -6
- package/dist/{method-mosT_h9v.js → method-DuiknwGt.js} +9 -3
- package/dist/{navigation-CHVw_t5x.d.ts → navigation-C7KdkOOQ.d.ts} +3 -3
- package/dist/{overview-9J_EJ4Uv.d.ts → overview-Bgw9OG4s.d.ts} +7 -7
- package/dist/{overview-dG8i3EyZ.js → overview-CcVRPEBm.js} +10 -11
- package/dist/{primitives-B6nufz49.js → primitives-B6y6nqBK.js} +2 -2
- package/dist/{primitives-BkenBSev.d.ts → primitives-BFT7Ya7M.d.ts} +11 -11
- package/dist/{properties-4w8hy0hf.js → properties-D2J5gvC-.js} +1 -1
- package/dist/{python-CtQJaLw5.js → python-CU3scKKD.js} +1 -1
- package/dist/{routing-CLgL--x1.js → routing-B7QoUwlD.js} +1 -1
- package/dist/{routing-CqnhQY4G.d.ts → routing-Cm_9XJiQ.d.ts} +1 -1
- package/dist/routing.d.ts +1 -1
- package/dist/routing.js +1 -1
- package/dist/{ruby-DJqEHgOw.js → ruby-DGRZDnHB.js} +1 -1
- package/dist/{sdk-BDzHdl2y.d.ts → sdk-AjblXmHS.d.ts} +3 -3
- package/dist/{sdk-afI6c7Wd.js → sdk-CR-rCp9e.js} +4 -4
- package/dist/{sdk-sidebar-CoVgP38f.d.ts → sdk-sidebar-D0TtSeoG.d.ts} +1 -1
- package/dist/{sdk-sidebar-ZaXTw63C.js → sdk-sidebar-FL7e7_BM.js} +24 -10
- package/dist/{snippets-Dfd3zU_j.d.ts → snippets-Cp1UqKR_.d.ts} +11 -11
- package/dist/{snippets-bh8lfniq.js → snippets-Us8YSl3A.js} +2 -2
- package/dist/spec.d.ts +4 -4
- package/dist/spec.js +2 -2
- package/dist/{stl-sidebar-D6OGr1Gl.d.ts → stl-sidebar-GAhLy2ST.d.ts} +22 -9
- package/dist/stl-sidebar-WtimNrk1.js +106 -0
- package/dist/{style-Bxr5gqcM.js → style-HpXpcJ9v.js} +2 -0
- package/dist/style.d.ts +2 -0
- package/dist/style.js +1 -1
- package/dist/styles/main.css +20 -3
- package/dist/styles/sidebar.css +45 -109
- package/dist/styles.css +67 -115
- package/dist/terraform-BD7o7zbh.js +243 -0
- package/dist/{typescript-DA7mcN1t.js → typescript-CEVQ6kS_.js} +1 -1
- package/dist/{utils-36jzmKxv.js → utils-KWHcUI-r.js} +1 -1
- package/dist/utils.d.ts +1 -1
- package/dist/utils.js +1 -1
- package/package.json +3 -3
- package/dist/breadcrumbs-CpdCGzeH.d.ts +0 -25
- package/dist/component-generics-Bs9VsgxB.d.ts +0 -30
- package/dist/docs-FJV1-6V2.d.ts +0 -47
- package/dist/index-C9bUFWfw.d.ts +0 -302
- package/dist/index-WHKRwqwo.d.ts +0 -302
- package/dist/index-_wZU78e1.d.ts +0 -16
- package/dist/languages-BPVYg1lj.js +0 -28
- package/dist/markdown-IA9nH38V.d.ts +0 -22
- package/dist/method-CZDrcjKP.d.ts +0 -59
- package/dist/navigation-CIQImbWI.d.ts +0 -29
- package/dist/overview-DVklHrbY.d.ts +0 -39
- package/dist/primitives-Bmr19wBU.d.ts +0 -105
- package/dist/properties-NrkX1jGk.d.ts +0 -54
- package/dist/sdk-hDAzjotL.d.ts +0 -122
- package/dist/sdk-sidebar-ByMsvpUm.d.ts +0 -15
- package/dist/snippets-BqKFOZfY.d.ts +0 -53
- package/dist/stl-sidebar-DdxZx2KK.js +0 -82
- package/dist/stl-sidebar-nQWQbRVM.d.ts +0 -45
- /package/dist/{properties-Dx6tQNus.d.ts → properties-Dw7HWUj0.d.ts} +0 -0
package/dist/styles.css
CHANGED
|
@@ -193,7 +193,7 @@ body {
|
|
|
193
193
|
letter-spacing: normal;
|
|
194
194
|
|
|
195
195
|
/* inline code */
|
|
196
|
-
&:where(:not(pre >
|
|
196
|
+
&:where(:not(pre > code)) {
|
|
197
197
|
color: var(--stl-color-foreground);
|
|
198
198
|
padding: 0 0.2em;
|
|
199
199
|
background-color: rgb(from var(--stl-color-foreground) r g b / 0.1);
|
|
@@ -1218,8 +1218,7 @@ a.stl-ui-button {
|
|
|
1218
1218
|
}
|
|
1219
1219
|
&.stl-ui-badge--intent-info {
|
|
1220
1220
|
background-color: var(--stl-color-muted-background);
|
|
1221
|
-
color: var(--stl-color-foreground
|
|
1222
|
-
--stl-ui-badge-icon-opacity: var(--stl-opacity-level-040);
|
|
1221
|
+
color: var(--stl-color-foreground);
|
|
1223
1222
|
border-color: var(--stl-color-border);
|
|
1224
1223
|
&.stl-ui-badge--solid {
|
|
1225
1224
|
background-color: var(--stl-color-inverse-background);
|
|
@@ -1862,7 +1861,7 @@ a.stl-ui-button {
|
|
|
1862
1861
|
.stldocs-resource {
|
|
1863
1862
|
padding: 2rem 0;
|
|
1864
1863
|
|
|
1865
|
-
.stldocs-resource-content {
|
|
1864
|
+
&:not([data-stl-resource-language='terraform']) .stldocs-resource-content {
|
|
1866
1865
|
max-width: var(--stldocs-content-width);
|
|
1867
1866
|
margin: auto 0;
|
|
1868
1867
|
}
|
|
@@ -1936,7 +1935,8 @@ a.stl-ui-button {
|
|
|
1936
1935
|
}
|
|
1937
1936
|
|
|
1938
1937
|
/* Overview page method summary */
|
|
1939
|
-
.stldocs-root .stldocs-overview .stldocs-method-summary
|
|
1938
|
+
.stldocs-root .stldocs-overview .stldocs-method-summary,
|
|
1939
|
+
.stldocs-root .stldocs-overview .stldocs-method {
|
|
1940
1940
|
padding: var(--stldocs-content-padding) 0;
|
|
1941
1941
|
|
|
1942
1942
|
.stldocs-method-header {
|
|
@@ -2246,7 +2246,8 @@ a.stl-ui-button {
|
|
|
2246
2246
|
}
|
|
2247
2247
|
}
|
|
2248
2248
|
|
|
2249
|
-
.stldocs-root .stldocs-method
|
|
2249
|
+
.stldocs-root .stldocs-method,
|
|
2250
|
+
.stldocs-root .stldocs-resource-content {
|
|
2250
2251
|
.stldocs-method-content-column {
|
|
2251
2252
|
display: contents;
|
|
2252
2253
|
}
|
|
@@ -2314,6 +2315,13 @@ a.stl-ui-button {
|
|
|
2314
2315
|
}
|
|
2315
2316
|
}
|
|
2316
2317
|
|
|
2318
|
+
/* TODO(soon): we shouldn't be copying these styles here. */
|
|
2319
|
+
.stldocs-method-available-languages a {
|
|
2320
|
+
color: var(--stl-color-link-foreground);
|
|
2321
|
+
text-decoration-color: rgb(from currentColor r g b / calc(alpha * var(--stl-opacity-level-040)));
|
|
2322
|
+
transition: text-decoration-color 0.1s ease-out;
|
|
2323
|
+
}
|
|
2324
|
+
|
|
2317
2325
|
.stldocs-method-info-section {
|
|
2318
2326
|
display: flex;
|
|
2319
2327
|
gap: 0.5rem;
|
|
@@ -2357,6 +2365,14 @@ a.stl-ui-button {
|
|
|
2357
2365
|
.stldocs-method-parameters h5 {
|
|
2358
2366
|
margin-left: var(--stldocs-expander-margin-shift);
|
|
2359
2367
|
}
|
|
2368
|
+
|
|
2369
|
+
.stldocs-terraform-resource-title {
|
|
2370
|
+
font-family: var(--stl-typography-font-mono);
|
|
2371
|
+
font-size: 1.1rem;
|
|
2372
|
+
white-space: nowrap;
|
|
2373
|
+
overflow: hidden;
|
|
2374
|
+
text-overflow: ellipsis;
|
|
2375
|
+
}
|
|
2360
2376
|
}
|
|
2361
2377
|
|
|
2362
2378
|
.stldocs-snippet {
|
|
@@ -2865,10 +2881,14 @@ a.stl-ui-button {
|
|
|
2865
2881
|
|
|
2866
2882
|
.stldocs-expander-summary,
|
|
2867
2883
|
.stldocs-sidebar-entry-link a {
|
|
2868
|
-
cursor: pointer;
|
|
2869
2884
|
padding: var(--stldocs-sidebar-item-padding-block) var(--stldocs-sidebar-item-padding-inline);
|
|
2870
2885
|
}
|
|
2871
2886
|
|
|
2887
|
+
summary.stldocs-expander-summary,
|
|
2888
|
+
.stldocs-sidebar-entry-link a {
|
|
2889
|
+
cursor: pointer;
|
|
2890
|
+
}
|
|
2891
|
+
|
|
2872
2892
|
.stldocs-sidebar-entry-link a:hover {
|
|
2873
2893
|
color: var(--stl-color-foreground);
|
|
2874
2894
|
}
|
|
@@ -2902,7 +2922,7 @@ a.stl-ui-button {
|
|
|
2902
2922
|
.stldocs-sidebar-entry-group:has(> a:is(:hover, [aria-current='page']))
|
|
2903
2923
|
> .stldocs-sidebar-expander
|
|
2904
2924
|
> .stldocs-expander-summary,
|
|
2905
|
-
.stldocs-expander-summary:hover {
|
|
2925
|
+
summary.stldocs-expander-summary:hover {
|
|
2906
2926
|
background-color: var(--stl-color-background-hover);
|
|
2907
2927
|
}
|
|
2908
2928
|
|
|
@@ -2919,130 +2939,62 @@ a.stl-ui-button {
|
|
|
2919
2939
|
.stldocs-sidebar-list .stldocs-sidebar-list .stldocs-sidebar-entry {
|
|
2920
2940
|
border-inline-start: 1px solid var(--stl-color-border-faint);
|
|
2921
2941
|
margin-inline-start: var(--stldocs-sidebar-indent);
|
|
2922
|
-
|
|
2942
|
+
|
|
2943
|
+
> a[aria-current='page'] {
|
|
2923
2944
|
border-inline-start: 2px solid var(--stl-color-accent-border-strong);
|
|
2924
|
-
|
|
2925
|
-
margin-left: -1px;
|
|
2926
|
-
}
|
|
2945
|
+
margin-left: -1px;
|
|
2927
2946
|
}
|
|
2928
2947
|
}
|
|
2929
2948
|
|
|
2930
|
-
/*
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2949
|
+
/* Icon positioning within links/groups. */
|
|
2950
|
+
.stldocs-sidebar-entry-link > a,
|
|
2951
|
+
.stldocs-sidebar-entry-group > a,
|
|
2952
|
+
.stldocs-sidebar-entry-group .stldocs-expander-summary > span {
|
|
2953
|
+
display: flex;
|
|
2954
|
+
align-items: center;
|
|
2955
|
+
gap: 8px;
|
|
2936
2956
|
}
|
|
2937
|
-
a[data-stldocs-method] {
|
|
2938
|
-
--stldocs-sidebar-icon-size-inner: 16px;
|
|
2939
|
-
--stldocs-sidebar-icon-color-inverse-background: var(--stldocs-sidebar-icon-color);
|
|
2940
2957
|
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
|
|
2945
|
-
|
|
2946
|
-
--stldocs-sidebar-icon-color-inverse-background: var(--stl-color-green-inverse-background);
|
|
2947
|
-
--stldocs-sidebar-icon-color-inverse-foreground: var(--stl-color-green-inverse-foreground);
|
|
2948
|
-
}
|
|
2949
|
-
&[data-stldocs-method='post'] {
|
|
2950
|
-
--stldocs-sidebar-icon-color: var(--stl-color-blue-foreground);
|
|
2951
|
-
--stldocs-sidebar-icon-color-border: var(--stl-color-blue-border);
|
|
2952
|
-
--stldocs-sidebar-icon-color-background: var(--stl-color-blue-muted-background);
|
|
2953
|
-
--stldocs-sidebar-icon-color-background-hover: var(--stl-color-blue-muted-background-hover);
|
|
2954
|
-
--stldocs-sidebar-icon-color-inverse-background: var(--stl-color-blue-inverse-background);
|
|
2955
|
-
--stldocs-sidebar-icon-color-inverse-foreground: var(--stl-color-blue-inverse-foreground);
|
|
2956
|
-
}
|
|
2957
|
-
&[data-stldocs-method='patch'],
|
|
2958
|
-
&[data-stldocs-method='put'] {
|
|
2959
|
-
--stldocs-sidebar-icon-color: var(--stl-color-orange-foreground);
|
|
2960
|
-
--stldocs-sidebar-icon-color-border: var(--stl-color-orange-border);
|
|
2961
|
-
--stldocs-sidebar-icon-color-background: var(--stl-color-orange-muted-background);
|
|
2962
|
-
--stldocs-sidebar-icon-color-background-hover: var(--stl-color-orange-muted-background-hover);
|
|
2963
|
-
--stldocs-sidebar-icon-color-inverse-background: var(--stl-color-orange-inverse-background);
|
|
2964
|
-
--stldocs-sidebar-icon-color-inverse-foreground: var(--stl-color-orange-inverse-foreground);
|
|
2965
|
-
}
|
|
2966
|
-
&[data-stldocs-method='delete'] {
|
|
2967
|
-
--stldocs-sidebar-icon-color: var(--stl-color-red-foreground);
|
|
2968
|
-
--stldocs-sidebar-icon-color-border: var(--stl-color-red-border);
|
|
2969
|
-
--stldocs-sidebar-icon-color-background: var(--stl-color-red-muted-background);
|
|
2970
|
-
--stldocs-sidebar-icon-color-background-hover: var(--stl-color-red-muted-background-hover);
|
|
2971
|
-
--stldocs-sidebar-icon-color-inverse-background: var(--stl-color-red-inverse-background);
|
|
2972
|
-
--stldocs-sidebar-icon-color-inverse-foreground: var(--stl-color-red-inverse-foreground);
|
|
2958
|
+
/* Hover/active states for HTTP badges. */
|
|
2959
|
+
a[aria-current='page'] .stl-ui-badge--http {
|
|
2960
|
+
&.stl-ui-badge--http-get {
|
|
2961
|
+
background-color: var(--stl-color-green-inverse-background);
|
|
2962
|
+
color: var(--stl-color-green-inverse-foreground);
|
|
2973
2963
|
}
|
|
2974
2964
|
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
&[data-stldocs-method='post'],
|
|
2979
|
-
&[data-stldocs-method='put'],
|
|
2980
|
-
&[data-stldocs-method='patch'] {
|
|
2981
|
-
--stldocs-sidebar-icon-url: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="black" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M7 7h10v10"/><path d="M7 17 17 7"/></svg>');
|
|
2982
|
-
}
|
|
2983
|
-
&[data-stldocs-method='delete'] {
|
|
2984
|
-
--stldocs-sidebar-icon-url: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="black" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M18 6 6 18"/><path d="m6 6 12 12"/></svg>');
|
|
2965
|
+
&.stl-ui-badge--http-post {
|
|
2966
|
+
background-color: var(--stl-color-blue-inverse-background);
|
|
2967
|
+
color: var(--stl-color-blue-inverse-foreground);
|
|
2985
2968
|
}
|
|
2986
|
-
}
|
|
2987
2969
|
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
--stldocs-sidebar-icon-color-background-hover: var(--stl-color-faint-background-hover);
|
|
2994
|
-
--stldocs-sidebar-icon-color-inverse-background: var(--stl-color-inverse-background);
|
|
2995
|
-
--stldocs-sidebar-icon-color-inverse-foreground: var(--stl-color-inverse-foreground);
|
|
2970
|
+
&.stl-ui-badge--http-patch,
|
|
2971
|
+
&.stl-ui-badge--http-put {
|
|
2972
|
+
background-color: var(--stl-color-orange-inverse-background);
|
|
2973
|
+
color: var(--stl-color-orange-inverse-foreground);
|
|
2974
|
+
}
|
|
2996
2975
|
|
|
2997
|
-
|
|
2998
|
-
|
|
2976
|
+
&.stl-ui-badge--http-delete {
|
|
2977
|
+
background-color: var(--stl-color-red-inverse-background);
|
|
2978
|
+
color: var(--stl-color-red-inverse-foreground);
|
|
2979
|
+
}
|
|
2999
2980
|
}
|
|
3000
2981
|
|
|
3001
|
-
a[
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
gap: var(--stldocs-sidebar-icon-margin);
|
|
3005
|
-
align-items: center;
|
|
3006
|
-
position: relative;
|
|
3007
|
-
|
|
3008
|
-
&::before,
|
|
3009
|
-
&::after {
|
|
3010
|
-
content: '';
|
|
3011
|
-
width: var(--stldocs-sidebar-icon-size-outer);
|
|
3012
|
-
height: var(--stldocs-sidebar-icon-size-outer);
|
|
3013
|
-
display: block;
|
|
2982
|
+
a:hover:not([aria-current='page']) .stl-ui-badge--http {
|
|
2983
|
+
&.stl-ui-badge--http-get {
|
|
2984
|
+
background-color: var(--stl-color-green-muted-background-hover);
|
|
3014
2985
|
}
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
background-color: var(--
|
|
3018
|
-
flex: 0 0 auto;
|
|
3019
|
-
border: 1px solid var(--stldocs-sidebar-icon-color-border, transparent);
|
|
3020
|
-
}
|
|
3021
|
-
/* yuck (we can clean this up once we are changing sidebar markup) */
|
|
3022
|
-
&::after {
|
|
3023
|
-
background-color: var(--stldocs-sidebar-icon-color);
|
|
3024
|
-
mask-image: var(--stldocs-sidebar-icon-url);
|
|
3025
|
-
mask-size: var(--stldocs-sidebar-icon-size-inner) var(--stldocs-sidebar-icon-size-inner);
|
|
3026
|
-
mask-repeat: no-repeat;
|
|
3027
|
-
mask-position: center;
|
|
3028
|
-
position: absolute;
|
|
3029
|
-
left: var(--stldocs-sidebar-item-padding-inline);
|
|
3030
|
-
top: 50%;
|
|
3031
|
-
transform: translateY(-50%);
|
|
2986
|
+
|
|
2987
|
+
&.stl-ui-badge--http-post {
|
|
2988
|
+
background-color: var(--stl-color-blue-muted-background-hover);
|
|
3032
2989
|
}
|
|
3033
2990
|
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
}
|
|
2991
|
+
&.stl-ui-badge--http-patch,
|
|
2992
|
+
&.stl-ui-badge--http-put {
|
|
2993
|
+
background-color: var(--stl-color-orange-muted-background-hover);
|
|
3038
2994
|
}
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
}
|
|
3043
|
-
&::after {
|
|
3044
|
-
background-color: var(--stldocs-sidebar-icon-color-inverse-foreground);
|
|
3045
|
-
}
|
|
2995
|
+
|
|
2996
|
+
&.stl-ui-badge--http-delete {
|
|
2997
|
+
background-color: var(--stl-color-red-muted-background-hover);
|
|
3046
2998
|
}
|
|
3047
2999
|
}
|
|
3048
3000
|
}
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
import { t as __exportAll } from "./chunk-BN_g-Awi.js";
|
|
2
|
+
import { i as useDeclaration } from "./docs-6PYi1eEV.js";
|
|
3
|
+
import { n as useLanguageComponents } from "./contexts-DMjqoc7S.js";
|
|
4
|
+
import { t as useComponents } from "./use-components-BUz3GbO4.js";
|
|
5
|
+
import { t as style_default } from "./style-HpXpcJ9v.js";
|
|
6
|
+
import "react";
|
|
7
|
+
import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
|
|
8
|
+
import clsx from "clsx";
|
|
9
|
+
import { Badge, Callout } from "@stainless-api/ui-primitives";
|
|
10
|
+
|
|
11
|
+
//#region src/languages/terraform.tsx
|
|
12
|
+
var terraform_exports = /* @__PURE__ */ __exportAll({
|
|
13
|
+
Declaration: () => Declaration,
|
|
14
|
+
MethodSignature: () => MethodSignature,
|
|
15
|
+
Property: () => Property,
|
|
16
|
+
Resource: () => Resource,
|
|
17
|
+
TerraformSource: () => TerraformSource,
|
|
18
|
+
Type: () => Type,
|
|
19
|
+
TypeName: () => TypeName
|
|
20
|
+
});
|
|
21
|
+
function TypeName({ type }) {
|
|
22
|
+
return /* @__PURE__ */ jsx(useLanguageComponents().Type, { type });
|
|
23
|
+
}
|
|
24
|
+
function Type({ type }) {
|
|
25
|
+
const Lang = useLanguageComponents();
|
|
26
|
+
const { Join } = useComponents();
|
|
27
|
+
switch (type.category) {
|
|
28
|
+
case "nested": switch (type.type) {
|
|
29
|
+
case "ListNested":
|
|
30
|
+
case "MapNested":
|
|
31
|
+
case "SetNested": return /* @__PURE__ */ jsxs("span", {
|
|
32
|
+
className: style_default.Type,
|
|
33
|
+
children: [
|
|
34
|
+
/* @__PURE__ */ jsx("span", {
|
|
35
|
+
className: style_default.TypeArray,
|
|
36
|
+
children: type.type.replace("Nested", "")
|
|
37
|
+
}),
|
|
38
|
+
/* @__PURE__ */ jsx("span", {
|
|
39
|
+
className: style_default.TypeBracket,
|
|
40
|
+
children: "["
|
|
41
|
+
}),
|
|
42
|
+
/* @__PURE__ */ jsx("span", {
|
|
43
|
+
className: style_default.TypeReference,
|
|
44
|
+
children: "Attributes"
|
|
45
|
+
}),
|
|
46
|
+
/* @__PURE__ */ jsx("span", {
|
|
47
|
+
className: style_default.TypeBracket,
|
|
48
|
+
children: "]"
|
|
49
|
+
})
|
|
50
|
+
]
|
|
51
|
+
});
|
|
52
|
+
case "SingleNested": return /* @__PURE__ */ jsx("span", {
|
|
53
|
+
className: style_default.Type,
|
|
54
|
+
children: /* @__PURE__ */ jsx("span", {
|
|
55
|
+
className: style_default.TypeReference,
|
|
56
|
+
children: "Attributes"
|
|
57
|
+
})
|
|
58
|
+
});
|
|
59
|
+
default: return;
|
|
60
|
+
}
|
|
61
|
+
case "collection": return /* @__PURE__ */ jsxs("span", {
|
|
62
|
+
className: style_default.Type,
|
|
63
|
+
children: [
|
|
64
|
+
/* @__PURE__ */ jsx("span", {
|
|
65
|
+
className: style_default.TypeArray,
|
|
66
|
+
children: type.type
|
|
67
|
+
}),
|
|
68
|
+
/* @__PURE__ */ jsx("span", {
|
|
69
|
+
className: style_default.TypeBracket,
|
|
70
|
+
children: "["
|
|
71
|
+
}),
|
|
72
|
+
/* @__PURE__ */ jsx(Lang.Type, { type: type.elementType }),
|
|
73
|
+
/* @__PURE__ */ jsx("span", {
|
|
74
|
+
className: style_default.TypeBracket,
|
|
75
|
+
children: "]"
|
|
76
|
+
})
|
|
77
|
+
]
|
|
78
|
+
});
|
|
79
|
+
case "dynamic": {
|
|
80
|
+
const subtypes = type.allowedSubtypes.length > 0 ? /* @__PURE__ */ jsx(Join, {
|
|
81
|
+
items: type.allowedSubtypes,
|
|
82
|
+
children: " | "
|
|
83
|
+
}) : null;
|
|
84
|
+
return /* @__PURE__ */ jsx("span", {
|
|
85
|
+
className: style_default.Type,
|
|
86
|
+
children: /* @__PURE__ */ jsxs("span", {
|
|
87
|
+
className: style_default.TypeKeyword,
|
|
88
|
+
children: ["Dynamic ", subtypes]
|
|
89
|
+
})
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
case "primitive":
|
|
93
|
+
if (type.type === "String") return /* @__PURE__ */ jsx("span", {
|
|
94
|
+
className: style_default.Type,
|
|
95
|
+
children: /* @__PURE__ */ jsx("span", {
|
|
96
|
+
className: style_default.TypeString,
|
|
97
|
+
children: "String"
|
|
98
|
+
})
|
|
99
|
+
});
|
|
100
|
+
return /* @__PURE__ */ jsx("span", {
|
|
101
|
+
className: style_default.Type,
|
|
102
|
+
children: /* @__PURE__ */ jsx("span", {
|
|
103
|
+
className: style_default.TypeKeyword,
|
|
104
|
+
children: type.type
|
|
105
|
+
})
|
|
106
|
+
});
|
|
107
|
+
case "unknown": return /* @__PURE__ */ jsx("span", {
|
|
108
|
+
className: style_default.Type,
|
|
109
|
+
children: /* @__PURE__ */ jsx("span", {
|
|
110
|
+
className: style_default.TypeKeyword,
|
|
111
|
+
children: "JSON"
|
|
112
|
+
})
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
function MethodSignature() {
|
|
117
|
+
return null;
|
|
118
|
+
}
|
|
119
|
+
const PropGroups = [
|
|
120
|
+
"required",
|
|
121
|
+
"optional",
|
|
122
|
+
"computed"
|
|
123
|
+
];
|
|
124
|
+
function Property({ decl, children }) {
|
|
125
|
+
if (!decl) return null;
|
|
126
|
+
switch (decl.kind) {
|
|
127
|
+
case "TerraformDeclAttribute": return children({ name: decl.name });
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
function TerraformSource({ path, group }) {
|
|
131
|
+
const Docs = useComponents();
|
|
132
|
+
const decl = useDeclaration(path, true);
|
|
133
|
+
if (decl.kind !== "TerraformDeclSource") return;
|
|
134
|
+
const type = decl.type === "resource" ? "resource" : "data";
|
|
135
|
+
const badge = type === "resource" ? `success` : `note`;
|
|
136
|
+
const children = PropGroups.filter((section) => decl[section].length > 0).map((section) => {
|
|
137
|
+
const propGroupId = `${decl.name}-${section}-${group}`;
|
|
138
|
+
return /* @__PURE__ */ jsxs("div", {
|
|
139
|
+
className: style_default.ResourceContentGroup,
|
|
140
|
+
children: [/* @__PURE__ */ jsxs("h5", {
|
|
141
|
+
className: style_default.ResourceContentGroupModelTitle,
|
|
142
|
+
children: [
|
|
143
|
+
section,
|
|
144
|
+
" ",
|
|
145
|
+
/* @__PURE__ */ jsx(Docs.PropertyToggle, { target: propGroupId })
|
|
146
|
+
]
|
|
147
|
+
}), /* @__PURE__ */ jsx("div", {
|
|
148
|
+
className: style_default.ResourceContentProperties,
|
|
149
|
+
"data-stldocs-property-group": propGroupId,
|
|
150
|
+
children: /* @__PURE__ */ jsx(Docs.SDKChildren, { paths: decl[section] })
|
|
151
|
+
})]
|
|
152
|
+
}, section);
|
|
153
|
+
});
|
|
154
|
+
return /* @__PURE__ */ jsx("div", {
|
|
155
|
+
className: clsx(style_default.Method, style_default.MethodDoublePane),
|
|
156
|
+
children: /* @__PURE__ */ jsxs("div", {
|
|
157
|
+
className: style_default.MethodBody,
|
|
158
|
+
children: [/* @__PURE__ */ jsxs("div", {
|
|
159
|
+
className: style_default.MethodContentColumn,
|
|
160
|
+
children: [/* @__PURE__ */ jsxs("h4", {
|
|
161
|
+
className: style_default.TerraformResourceTitle,
|
|
162
|
+
children: [
|
|
163
|
+
/* @__PURE__ */ jsx(Badge, {
|
|
164
|
+
intent: badge,
|
|
165
|
+
children: type
|
|
166
|
+
}),
|
|
167
|
+
" ",
|
|
168
|
+
decl.name
|
|
169
|
+
]
|
|
170
|
+
}), children]
|
|
171
|
+
}), /* @__PURE__ */ jsx("div", {
|
|
172
|
+
className: clsx(style_default.MethodExample, "not-content", "stl-ui-not-prose"),
|
|
173
|
+
children: /* @__PURE__ */ jsx(Docs.SDKExample, { method: {
|
|
174
|
+
title: decl.name,
|
|
175
|
+
stainlessPath: path
|
|
176
|
+
} })
|
|
177
|
+
})]
|
|
178
|
+
})
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
function Declaration({ decl }) {
|
|
182
|
+
const Lang = useLanguageComponents();
|
|
183
|
+
if (!decl) return;
|
|
184
|
+
switch (decl.kind) {
|
|
185
|
+
case "TerraformDeclAttribute": {
|
|
186
|
+
const isOptional = decl.configurability === "optional" || decl.configurability === "computed_optional";
|
|
187
|
+
return /* @__PURE__ */ jsxs(Fragment$1, { children: [
|
|
188
|
+
/* @__PURE__ */ jsx("span", {
|
|
189
|
+
className: style_default.TextIdentifier,
|
|
190
|
+
children: decl.name
|
|
191
|
+
}),
|
|
192
|
+
isOptional && /* @__PURE__ */ jsx("span", {
|
|
193
|
+
className: style_default.TextPunctuation,
|
|
194
|
+
children: "?"
|
|
195
|
+
}),
|
|
196
|
+
/* @__PURE__ */ jsx("span", {
|
|
197
|
+
className: style_default.TextPunctuation,
|
|
198
|
+
children: ": "
|
|
199
|
+
}),
|
|
200
|
+
/* @__PURE__ */ jsx("span", {
|
|
201
|
+
className: style_default.TextKeyword,
|
|
202
|
+
children: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
|
|
203
|
+
})
|
|
204
|
+
] });
|
|
205
|
+
}
|
|
206
|
+
case "TerraformDeclServiceNode": {
|
|
207
|
+
const { resource, dataSource, listDataSource } = decl;
|
|
208
|
+
return /* @__PURE__ */ jsxs("div", {
|
|
209
|
+
className: style_default.Method,
|
|
210
|
+
children: [
|
|
211
|
+
resource && /* @__PURE__ */ jsx(TerraformSource, {
|
|
212
|
+
path: resource,
|
|
213
|
+
group: "resource"
|
|
214
|
+
}),
|
|
215
|
+
dataSource && /* @__PURE__ */ jsx(TerraformSource, {
|
|
216
|
+
path: dataSource,
|
|
217
|
+
group: "dataSource"
|
|
218
|
+
}),
|
|
219
|
+
listDataSource && /* @__PURE__ */ jsx(TerraformSource, {
|
|
220
|
+
path: listDataSource,
|
|
221
|
+
group: "listDataSource"
|
|
222
|
+
})
|
|
223
|
+
]
|
|
224
|
+
});
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
function Resource({ resource }) {
|
|
229
|
+
const Lang = useLanguageComponents();
|
|
230
|
+
const decl = useDeclaration(resource.stainlessPath, false);
|
|
231
|
+
if (decl) return /* @__PURE__ */ jsx(Lang.Declaration, { decl });
|
|
232
|
+
return /* @__PURE__ */ jsxs(Callout, {
|
|
233
|
+
variant: "warning",
|
|
234
|
+
children: [
|
|
235
|
+
"The resource ",
|
|
236
|
+
/* @__PURE__ */ jsx("code", { children: resource.name }),
|
|
237
|
+
" is not supported in Terraform."
|
|
238
|
+
]
|
|
239
|
+
});
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
//#endregion
|
|
243
|
+
export { TerraformSource as a, terraform_exports as c, Resource as i, MethodSignature as n, Type as o, Property as r, TypeName as s, Declaration as t };
|
|
@@ -2,7 +2,7 @@ import { t as __exportAll } from "./chunk-BN_g-Awi.js";
|
|
|
2
2
|
import { i as useDeclaration, o as useLanguage, u as useSpec } from "./docs-6PYi1eEV.js";
|
|
3
3
|
import { n as useLanguageComponents } from "./contexts-DMjqoc7S.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-HpXpcJ9v.js";
|
|
6
6
|
import * as React$1 from "react";
|
|
7
7
|
import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
|
|
8
8
|
|
package/dist/utils.d.ts
CHANGED
package/dist/utils.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { n as getResourceFromSpec, r as isResourceEmpty, t as flatResources } from "./utils-
|
|
1
|
+
import { n as getResourceFromSpec, r as isResourceEmpty, t as flatResources } from "./utils-KWHcUI-r.js";
|
|
2
2
|
|
|
3
3
|
export { flatResources, getResourceFromSpec, isResourceEmpty };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stainless-api/docs-ui",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "0.1.0-beta.
|
|
4
|
+
"version": "0.1.0-beta.65",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"clsx": "^2.1.1",
|
|
19
19
|
"htmlparser2": "^10.0.0",
|
|
20
20
|
"lucide-react": "^0.562.0",
|
|
21
|
-
"@stainless-api/ui-primitives": "0.1.0-beta.
|
|
21
|
+
"@stainless-api/ui-primitives": "0.1.0-beta.46"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"@types/node": "24.10.9",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"tsdown": "^0.20.0",
|
|
31
31
|
"typescript": "5.9.3",
|
|
32
32
|
"@stainless/eslint-config": "0.1.0-beta.1",
|
|
33
|
-
"@stainless/sdk-json": "^0.1.0-beta.
|
|
33
|
+
"@stainless/sdk-json": "^0.1.0-beta.4"
|
|
34
34
|
},
|
|
35
35
|
"exports": {
|
|
36
36
|
".": {
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { g as Spec } from "./index-DuHyTVVD.js";
|
|
2
|
-
import * as react_jsx_runtime38 from "react/jsx-runtime";
|
|
3
|
-
|
|
4
|
-
//#region src/components/breadcrumbs.d.ts
|
|
5
|
-
type Breadcrumb = {
|
|
6
|
-
title: string;
|
|
7
|
-
href: string;
|
|
8
|
-
};
|
|
9
|
-
type BreadcrumbConfig = {
|
|
10
|
-
includeCurrentPage?: boolean;
|
|
11
|
-
};
|
|
12
|
-
declare function generateApiBreadcrumbs(fullPath: string, spec: any, basePath: string): Breadcrumb[] | null;
|
|
13
|
-
declare function SDKBreadcrumbs({
|
|
14
|
-
spec,
|
|
15
|
-
currentPath,
|
|
16
|
-
basePath,
|
|
17
|
-
config
|
|
18
|
-
}: {
|
|
19
|
-
spec: Spec;
|
|
20
|
-
currentPath: string;
|
|
21
|
-
basePath?: string;
|
|
22
|
-
config?: BreadcrumbConfig | null;
|
|
23
|
-
}): react_jsx_runtime38.JSX.Element | null;
|
|
24
|
-
//#endregion
|
|
25
|
-
export { generateApiBreadcrumbs as n, SDKBreadcrumbs as t };
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import * as React$1 from "react";
|
|
2
|
-
import * as react_jsx_runtime81 from "react/jsx-runtime";
|
|
3
|
-
|
|
4
|
-
//#region src/contexts/component-generics.d.ts
|
|
5
|
-
type DeepPartialMap<L> = { [K in keyof L]?: Partial<L[K]> };
|
|
6
|
-
type ComponentsContextType<C, L> = {
|
|
7
|
-
components: C;
|
|
8
|
-
language: L;
|
|
9
|
-
};
|
|
10
|
-
declare const useComponentContext: () => ComponentsContextType<any, any>;
|
|
11
|
-
declare function useComponents<C = unknown>(): C;
|
|
12
|
-
declare function customizeComponents<C, L>(defaults: {
|
|
13
|
-
components: C;
|
|
14
|
-
language: L;
|
|
15
|
-
}, overrides?: {
|
|
16
|
-
components?: Partial<C>;
|
|
17
|
-
language?: DeepPartialMap<L>;
|
|
18
|
-
}): {
|
|
19
|
-
components: C;
|
|
20
|
-
language: L;
|
|
21
|
-
};
|
|
22
|
-
declare function ComponentProvider<C, L>({
|
|
23
|
-
value,
|
|
24
|
-
children
|
|
25
|
-
}: {
|
|
26
|
-
value: ComponentsContextType<C, L>;
|
|
27
|
-
children: React$1.ReactNode;
|
|
28
|
-
}): react_jsx_runtime81.JSX.Element;
|
|
29
|
-
//#endregion
|
|
30
|
-
export { useComponents as a, useComponentContext as i, ComponentsContextType as n, customizeComponents as r, ComponentProvider as t };
|
package/dist/docs-FJV1-6V2.d.ts
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import { _ as SpecLanguage, g as Spec, l as LanguageDeclNodes, p as Resource } from "./index-DuHyTVVD.js";
|
|
2
|
-
import * as React$1 from "react";
|
|
3
|
-
import * as react_jsx_runtime33 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;
|
|
10
|
-
collapseDescription?: boolean;
|
|
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 useSnippet(stainlessPath: string, language?: SpecLanguage, variant?: string): string | undefined;
|
|
31
|
-
type Declaration = LanguageDeclNodes[SpecLanguage];
|
|
32
|
-
declare function useDeclaration<Required extends boolean>(stainlessPath: string, required: Required, language?: SpecLanguage): (Required extends true ? never : undefined) | Declaration;
|
|
33
|
-
declare function useAvailableLanguages(stainlessPath: string): SpecLanguage[];
|
|
34
|
-
declare function useResource(name: string): Resource | undefined;
|
|
35
|
-
declare function useLanguage(): "cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript";
|
|
36
|
-
declare function useContentPanelLayout(): ContentPanelLayout;
|
|
37
|
-
type DocsProviderProps = DocsContextType & {
|
|
38
|
-
children: React$1.ReactNode;
|
|
39
|
-
};
|
|
40
|
-
declare function DocsProvider({
|
|
41
|
-
spec,
|
|
42
|
-
language,
|
|
43
|
-
settings,
|
|
44
|
-
children
|
|
45
|
-
}: DocsProviderProps): react_jsx_runtime33.JSX.Element;
|
|
46
|
-
//#endregion
|
|
47
|
-
export { DocsProviderProps as a, useContentPanelLayout as c, useLanguage as d, useResource as f, useSpec as h, DocsProvider as i, useDeclaration as l, useSnippet as m, Declaration as n, PropertySettingsType as o, useSettings as p, DocsContextType as r, useAvailableLanguages as s, ContentPanelLayout as t, useDocs as u };
|