@stainless-api/docs-ui 0.1.0-beta.63 → 0.1.0-beta.64

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.
Files changed (132) hide show
  1. package/dist/{breadcrumbs-DwldC63b.d.ts → breadcrumbs--UnnviuM.d.ts} +3 -3
  2. package/dist/{breadcrumbs-CpdCGzeH.d.ts → breadcrumbs-D-5T4feJ.d.ts} +3 -3
  3. package/dist/{breadcrumbs-hzZqGExJ.js → breadcrumbs-LWaLZTKQ.js} +3 -3
  4. package/dist/{cli-BAhN1pvm.js → cli-DxaqMIw8.js} +2 -2
  5. package/dist/{component-Bf-__z99.js → component-DJPAOOcm.js} +2 -2
  6. package/dist/{component-generics-uYXTXWFi.d.ts → component-generics-B7o0uTDM.d.ts} +2 -2
  7. package/dist/{component-generics-Bs9VsgxB.d.ts → component-generics-MlWbpDgJ.d.ts} +2 -2
  8. package/dist/components/MaskedInput.d.ts +3 -3
  9. package/dist/components/MaskedInput.js +1 -1
  10. package/dist/components/breadcrumbs.d.ts +1 -1
  11. package/dist/components/breadcrumbs.js +2 -2
  12. package/dist/components/icons.d.ts +12 -12
  13. package/dist/components/index.d.ts +11 -11
  14. package/dist/components/index.js +10 -10
  15. package/dist/components/method.d.ts +1 -1
  16. package/dist/components/method.js +2 -2
  17. package/dist/components/overview.d.ts +1 -1
  18. package/dist/components/overview.js +3 -3
  19. package/dist/components/primitives.d.ts +1 -1
  20. package/dist/components/primitives.js +1 -1
  21. package/dist/components/properties.d.ts +1 -1
  22. package/dist/components/properties.js +1 -1
  23. package/dist/components/sdk-sidebar.d.ts +1 -1
  24. package/dist/components/sdk-sidebar.js +2 -2
  25. package/dist/components/sdk.d.ts +1 -1
  26. package/dist/components/sdk.js +1 -1
  27. package/dist/components/snippets.d.ts +2 -2
  28. package/dist/components/snippets.js +1 -1
  29. package/dist/components/stl-sidebar.d.ts +2 -2
  30. package/dist/components/stl-sidebar.js +1 -1
  31. package/dist/{components-CwIKWfid.js → components-BDWui61-.js} +9 -9
  32. package/dist/contexts/component-generics.d.ts +1 -1
  33. package/dist/contexts/component-types.d.ts +11 -11
  34. package/dist/contexts/component.d.ts +14 -14
  35. package/dist/contexts/component.js +21 -20
  36. package/dist/contexts/docs.d.ts +1 -1
  37. package/dist/contexts/index.d.ts +15 -15
  38. package/dist/contexts/markdown.d.ts +1 -1
  39. package/dist/contexts/navigation.d.ts +1 -1
  40. package/dist/contexts/use-components.d.ts +10 -10
  41. package/dist/{csharp-BD37FKH6.js → csharp-DG58HgOR.js} +1 -1
  42. package/dist/{docs-FJV1-6V2.d.ts → docs-B7UKWxWn.d.ts} +3 -3
  43. package/dist/{docs-Chc8A7zc.d.ts → docs-QzBZ07DA.d.ts} +3 -3
  44. package/dist/{go-v-i4WDzK.js → go-FsjdFhA1.js} +1 -1
  45. package/dist/{http-BKoVLcpv.js → http-BjtWXfQq.js} +3 -3
  46. package/dist/{index-DuHyTVVD.d.ts → index-CwjGm9zX.d.ts} +33 -2
  47. package/dist/index-D7cYRCX9.d.ts +345 -0
  48. package/dist/{index-Dz6SFEud.d.ts → index-DJvggpZ-.d.ts} +10 -10
  49. package/dist/{index-_wZU78e1.d.ts → index-DRblqs_x.d.ts} +10 -10
  50. package/dist/index-DbDRmfDC.d.ts +345 -0
  51. package/dist/index.d.ts +16 -16
  52. package/dist/index.js +23 -22
  53. package/dist/{java-A6j1NMJ7.js → java-Bd6ywsPr.js} +1 -1
  54. package/dist/languages/cli.d.ts +11 -11
  55. package/dist/languages/cli.js +12 -12
  56. package/dist/languages/csharp.d.ts +11 -11
  57. package/dist/languages/csharp.js +1 -1
  58. package/dist/languages/go.d.ts +11 -11
  59. package/dist/languages/go.js +1 -1
  60. package/dist/languages/http.d.ts +11 -11
  61. package/dist/languages/http.js +11 -11
  62. package/dist/languages/index.d.ts +12 -12
  63. package/dist/languages/index.js +21 -20
  64. package/dist/languages/java.d.ts +11 -11
  65. package/dist/languages/java.js +1 -1
  66. package/dist/languages/python.d.ts +11 -11
  67. package/dist/languages/python.js +1 -1
  68. package/dist/languages/ruby.d.ts +11 -11
  69. package/dist/languages/ruby.js +1 -1
  70. package/dist/languages/terraform.d.ts +12 -0
  71. package/dist/languages/terraform.js +9 -0
  72. package/dist/languages/typescript.d.ts +11 -11
  73. package/dist/languages/typescript.js +1 -1
  74. package/dist/languages-BN8-A3YZ.js +30 -0
  75. package/dist/markdown/index.d.ts +2 -2
  76. package/dist/markdown/index.js +21 -20
  77. package/dist/markdown/printer.d.ts +2 -2
  78. package/dist/markdown/printer.js +22 -21
  79. package/dist/markdown/utils.d.ts +3 -3
  80. package/dist/{markdown-CoIy7fea.d.ts → markdown-DJp68jgE.d.ts} +2 -2
  81. package/dist/{markdown-IA9nH38V.d.ts → markdown-Dg9HMal8.d.ts} +2 -2
  82. package/dist/{method-Bt3V4B4q.d.ts → method-Co4oGHq0.d.ts} +6 -6
  83. package/dist/{method-mosT_h9v.js → method-Cz2lZSmc.js} +2 -2
  84. package/dist/{method-CZDrcjKP.d.ts → method-O9UBNEp2.d.ts} +6 -6
  85. package/dist/{navigation-CHVw_t5x.d.ts → navigation-B4vW2BCl.d.ts} +3 -3
  86. package/dist/{navigation-CIQImbWI.d.ts → navigation-D3NgO72i.d.ts} +3 -3
  87. package/dist/{overview-DVklHrbY.d.ts → overview-Cj_1NjH4.d.ts} +7 -7
  88. package/dist/{overview-9J_EJ4Uv.d.ts → overview-LaDqIxPP.d.ts} +7 -7
  89. package/dist/{overview-dG8i3EyZ.js → overview-Rmj_2SSL.js} +9 -10
  90. package/dist/{primitives-BkenBSev.d.ts → primitives-BVImQZIK.d.ts} +11 -11
  91. package/dist/{primitives-B6nufz49.js → primitives-CLz53F72.js} +2 -2
  92. package/dist/{primitives-Bmr19wBU.d.ts → primitives-ClTSL56K.d.ts} +11 -11
  93. package/dist/{properties-NrkX1jGk.d.ts → properties-CjcmtaiQ.d.ts} +5 -5
  94. package/dist/{properties-Dx6tQNus.d.ts → properties-DrXRF5dN.d.ts} +5 -5
  95. package/dist/{properties-4w8hy0hf.js → properties-USEPePSD.js} +1 -1
  96. package/dist/{python-CtQJaLw5.js → python-DuKMXtnf.js} +1 -1
  97. package/dist/{routing-CLgL--x1.js → routing-B7QoUwlD.js} +1 -1
  98. package/dist/routing-BEbg8P4_.d.ts +61 -0
  99. package/dist/{routing-CqnhQY4G.d.ts → routing-Cm_9XJiQ.d.ts} +1 -1
  100. package/dist/routing.d.ts +1 -1
  101. package/dist/routing.js +1 -1
  102. package/dist/{ruby-DJqEHgOw.js → ruby-caNh8R-U.js} +1 -1
  103. package/dist/{sdk-hDAzjotL.d.ts → sdk-BiZDCG58.d.ts} +17 -17
  104. package/dist/{sdk-afI6c7Wd.js → sdk-BjiDGP5c.js} +2 -2
  105. package/dist/{sdk-BDzHdl2y.d.ts → sdk-hxjRpJH0.d.ts} +17 -17
  106. package/dist/{sdk-sidebar-CoVgP38f.d.ts → sdk-sidebar-COHATE2-.d.ts} +3 -3
  107. package/dist/{sdk-sidebar-ZaXTw63C.js → sdk-sidebar-DdpmtIRH.js} +24 -10
  108. package/dist/{sdk-sidebar-ByMsvpUm.d.ts → sdk-sidebar-f7SS4xxq.d.ts} +3 -3
  109. package/dist/{snippets-BqKFOZfY.d.ts → snippets-Ci86b9RQ.d.ts} +11 -11
  110. package/dist/{snippets-bh8lfniq.js → snippets-DSwfbtDo.js} +1 -1
  111. package/dist/{snippets-Dfd3zU_j.d.ts → snippets-DWblYtQ8.d.ts} +11 -11
  112. package/dist/spec.d.ts +2 -2
  113. package/dist/spec.js +2 -2
  114. package/dist/{stl-sidebar-D6OGr1Gl.d.ts → stl-sidebar-BKBJelb1.d.ts} +22 -9
  115. package/dist/{stl-sidebar-nQWQbRVM.d.ts → stl-sidebar-BUEH7mR_.d.ts} +22 -9
  116. package/dist/stl-sidebar-Cygo6VjR.js +106 -0
  117. package/dist/{style-Bxr5gqcM.js → style-Btdhlyzs.js} +1 -0
  118. package/dist/style.d.ts +1 -0
  119. package/dist/style.js +1 -1
  120. package/dist/styles/main.css +13 -3
  121. package/dist/styles/sidebar.css +45 -109
  122. package/dist/styles.css +58 -112
  123. package/dist/terraform-C5niSkCy.js +243 -0
  124. package/dist/{typescript-DA7mcN1t.js → typescript-MlS1z4sG.js} +1 -1
  125. package/dist/{utils-36jzmKxv.js → utils-KWHcUI-r.js} +1 -1
  126. package/dist/utils.d.ts +1 -1
  127. package/dist/utils.js +1 -1
  128. package/package.json +2 -2
  129. package/dist/index-C9bUFWfw.d.ts +0 -302
  130. package/dist/index-WHKRwqwo.d.ts +0 -302
  131. package/dist/languages-BPVYg1lj.js +0 -28
  132. package/dist/stl-sidebar-DdxZx2KK.js +0 -82
@@ -1,7 +1,7 @@
1
- import { d as Model, h as SnippetLanguage, s as ID, t as BaseDeclaration, u as Method } from "./index-DuHyTVVD.js";
2
- import { t as DocsLanguage } from "./routing-CqnhQY4G.js";
1
+ import { c as ID, d as Method, f as Model, g as SnippetLanguage, o as HasStainlessPath, t as BaseDeclaration } from "./index-CwjGm9zX.js";
2
+ import { t as DocsLanguage } from "./routing-Cm_9XJiQ.js";
3
3
  import * as React$1 from "react";
4
- import * as react_jsx_runtime75 from "react/jsx-runtime";
4
+ import * as react_jsx_runtime47 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): react_jsx_runtime75.JSX.Element;
36
+ }: SDKChildrenProps): react_jsx_runtime47.JSX.Element;
37
37
  type SDKDeclarationProps = {
38
38
  path: string;
39
39
  expand?: boolean;
@@ -43,58 +43,58 @@ declare function SDKDeclaration({
43
43
  path,
44
44
  expand,
45
45
  depth
46
- }: SDKDeclarationProps): react_jsx_runtime75.JSX.Element;
46
+ }: SDKDeclarationProps): react_jsx_runtime47.JSX.Element;
47
47
  type SDKConstraintsProps = {
48
48
  constraints?: Record<string, any>;
49
49
  };
50
50
  declare function SDKConstraints({
51
51
  constraints
52
- }: SDKConstraintsProps): react_jsx_runtime75.JSX.Element | undefined;
52
+ }: SDKConstraintsProps): react_jsx_runtime47.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): react_jsx_runtime75.JSX.Element | null;
59
+ }: SDKIconProps): react_jsx_runtime47.JSX.Element | null;
60
60
  type SDKRequestTitleProps = {
61
61
  snippetLanguage: SnippetLanguage;
62
62
  };
63
63
  declare function SDKRequestTitle({
64
64
  snippetLanguage
65
- }: SDKRequestTitleProps): react_jsx_runtime75.JSX.Element;
65
+ }: SDKRequestTitleProps): react_jsx_runtime47.JSX.Element;
66
66
  type SDKExampleProps = {
67
- method: Method;
67
+ method: Partial<Method> & HasStainlessPath;
68
68
  transformRequestSnippet?: TransformRequestSnippetFn;
69
69
  };
70
70
  declare function SDKExample({
71
71
  method,
72
72
  transformRequestSnippet
73
- }: SDKExampleProps): react_jsx_runtime75.JSX.Element;
73
+ }: SDKExampleProps): react_jsx_runtime47.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): react_jsx_runtime75.JSX.Element;
80
+ }: SDKMethodProps): react_jsx_runtime47.JSX.Element;
81
81
  declare function useStreamingResponse(method: BaseDeclaration): ID | undefined;
82
82
  declare function SDKMethodInfo({
83
83
  method
84
- }: SDKMethodProps): react_jsx_runtime75.JSX.Element;
84
+ }: SDKMethodProps): react_jsx_runtime47.JSX.Element;
85
85
  declare function SDKMethodNotImplemented({
86
86
  method
87
- }: SDKMethodProps): react_jsx_runtime75.JSX.Element;
87
+ }: SDKMethodProps): react_jsx_runtime47.JSX.Element;
88
88
  declare function SDKMethod({
89
89
  method,
90
90
  transformRequestSnippet
91
- }: SDKMethodProps): react_jsx_runtime75.JSX.Element;
91
+ }: SDKMethodProps): react_jsx_runtime47.JSX.Element;
92
92
  type SDKModelProps = {
93
93
  model: Model;
94
94
  };
95
95
  declare function SDKModel({
96
96
  model
97
- }: SDKModelProps): react_jsx_runtime75.JSX.Element | null;
97
+ }: SDKModelProps): react_jsx_runtime47.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> | react_jsx_runtime75.JSX.Element | null | undefined;
105
+ }: SDKReferenceProps): string | number | bigint | boolean | react_jsx_runtime47.JSX.Element | 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> | 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): react_jsx_runtime75.JSX.Element;
120
+ }: SDKLanguageBlockProps): react_jsx_runtime47.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 { p as Resource } from "./index-DuHyTVVD.js";
2
- import * as react_jsx_runtime74 from "react/jsx-runtime";
1
+ import { m as Resource } from "./index-CwjGm9zX.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): react_jsx_runtime74.JSX.Element;
13
+ }: SDKSidebarProps): react_jsx_runtime37.JSX.Element;
14
14
  //#endregion
15
15
  export { SDKSidebarProps as n, SDKSidebar as t };
@@ -1,8 +1,9 @@
1
1
  import { n as useNavigation } from "./navigation-aoYZ_tl4.js";
2
- import { r as isResourceEmpty } from "./utils-36jzmKxv.js";
3
- import { t as StlSidebar } from "./stl-sidebar-DdxZx2KK.js";
2
+ import { r as isResourceEmpty } from "./utils-KWHcUI-r.js";
3
+ import { t as StlSidebar } from "./stl-sidebar-Cygo6VjR.js";
4
4
  import * as React$1 from "react";
5
5
  import { jsx } from "react/jsx-runtime";
6
+ import { Badge, getHttpMethod } from "@stainless-api/ui-primitives";
6
7
 
7
8
  //#region src/components/sdk-sidebar.tsx
8
9
  function resourceToEntry(resource, selectedPath) {
@@ -11,16 +12,29 @@ function resourceToEntry(resource, selectedPath) {
11
12
  collapsed: false,
12
13
  label: resource.title,
13
14
  entries: [],
14
- stainlessPath: resource.stainlessPath,
15
+ target: {
16
+ type: "stainlessPath",
17
+ stainlessPath: resource.stainlessPath
18
+ },
15
19
  isCurrent: selectedPath === resource.stainlessPath
16
20
  };
17
- for (const method of Object.values(resource.methods)) result.entries.push({
18
- type: "link",
19
- attrs: { "data-stldocs-method": method.httpMethod },
20
- stainlessPath: method.stainlessPath,
21
- label: method.title,
22
- isCurrent: selectedPath === method.stainlessPath
23
- });
21
+ for (const method of Object.values(resource.methods)) {
22
+ const httpMethod = getHttpMethod(method.httpMethod);
23
+ result.entries.push({
24
+ type: "link",
25
+ target: {
26
+ type: "stainlessPath",
27
+ stainlessPath: method.stainlessPath
28
+ },
29
+ label: method.title,
30
+ isCurrent: selectedPath === method.stainlessPath,
31
+ icon: httpMethod ? /* @__PURE__ */ jsx(Badge.HTTP, {
32
+ method: httpMethod,
33
+ iconOnly: true,
34
+ size: "sm"
35
+ }) : void 0
36
+ });
37
+ }
24
38
  for (const subresource of Object.values(resource.subresources ?? {})) result.entries.push(resourceToEntry(subresource, selectedPath));
25
39
  return result;
26
40
  }
@@ -1,5 +1,5 @@
1
- import { p as Resource } from "./index-DuHyTVVD.js";
2
- import * as react_jsx_runtime60 from "react/jsx-runtime";
1
+ import { m as Resource } from "./index-CwjGm9zX.js";
2
+ import * as react_jsx_runtime43 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): react_jsx_runtime60.JSX.Element;
13
+ }: SDKSidebarProps): react_jsx_runtime43.JSX.Element;
14
14
  //#endregion
15
15
  export { SDKSidebarProps as n, SDKSidebar as t };
@@ -1,7 +1,7 @@
1
- import { u as Method } from "./index-DuHyTVVD.js";
2
- import { w as TransformRequestSnippetFn } from "./sdk-hDAzjotL.js";
1
+ import { d as Method, o as HasStainlessPath } from "./index-CwjGm9zX.js";
2
+ import { w as TransformRequestSnippetFn } from "./sdk-hxjRpJH0.js";
3
3
  import * as React$1 from "react";
4
- import * as react_jsx_runtime75 from "react/jsx-runtime";
4
+ import * as react_jsx_runtime38 from "react/jsx-runtime";
5
5
 
6
6
  //#region src/components/snippets.d.ts
7
7
  type SnippetCodeProps = {
@@ -12,42 +12,42 @@ type SnippetCodeProps = {
12
12
  declare function SnippetCode({
13
13
  content,
14
14
  language
15
- }: SnippetCodeProps): react_jsx_runtime75.JSX.Element;
15
+ }: SnippetCodeProps): react_jsx_runtime38.JSX.Element;
16
16
  type SnippetProps = {
17
- method: Method;
17
+ method: Partial<Method> & HasStainlessPath;
18
18
  requestTitle?: React$1.ReactNode;
19
19
  transformRequestSnippet?: TransformRequestSnippetFn;
20
20
  };
21
21
  type SnippetContainerProps = {
22
- method: Method;
22
+ method: Partial<Method> & HasStainlessPath;
23
23
  children: React$1.ReactNode;
24
24
  signature?: string;
25
25
  };
26
26
  declare function SnippetContainer({
27
27
  children
28
- }: SnippetContainerProps): react_jsx_runtime75.JSX.Element;
28
+ }: SnippetContainerProps): react_jsx_runtime38.JSX.Element;
29
29
  type SnippetRequestContainerProps = {
30
30
  children?: React$1.ReactNode;
31
31
  signature?: string;
32
32
  };
33
33
  declare function SnippetRequestContainer({
34
34
  children
35
- }: SnippetRequestContainerProps): react_jsx_runtime75.JSX.Element;
35
+ }: SnippetRequestContainerProps): react_jsx_runtime38.JSX.Element;
36
36
  declare function Snippet({
37
37
  requestTitle,
38
38
  method,
39
39
  transformRequestSnippet
40
- }: SnippetProps): react_jsx_runtime75.JSX.Element | null;
40
+ }: SnippetProps): react_jsx_runtime38.JSX.Element | null;
41
41
  declare function SnippetButtons({
42
42
  content
43
43
  }: {
44
44
  content: string;
45
- }): react_jsx_runtime75.JSX.Element;
45
+ }): react_jsx_runtime38.JSX.Element;
46
46
  declare function SnippetFooter(): React$1.ReactNode;
47
47
  declare function SnippetResponse({
48
48
  responses
49
49
  }: {
50
50
  responses: Method['exampleResponses'];
51
- }): react_jsx_runtime75.JSX.Element | null;
51
+ }): react_jsx_runtime38.JSX.Element | null;
52
52
  //#endregion
53
53
  export { SnippetContainer as a, SnippetProps as c, SnippetResponse as d, SnippetCodeProps as i, SnippetRequestContainer as l, SnippetButtons as n, SnippetContainerProps as o, SnippetCode as r, SnippetFooter as s, Snippet as t, SnippetRequestContainerProps as u };
@@ -1,7 +1,7 @@
1
1
  import { i as useDeclaration, l as useSnippet, o as useLanguage } from "./docs-6PYi1eEV.js";
2
2
  import { r as useHighlight } from "./markdown-DHjcD13O.js";
3
3
  import { t as useComponents } from "./use-components-BUz3GbO4.js";
4
- import { t as style_default } from "./style-Bxr5gqcM.js";
4
+ import { t as style_default } from "./style-Btdhlyzs.js";
5
5
  import * as React$1 from "react";
6
6
  import { jsx, jsxs } from "react/jsx-runtime";
7
7
  import clsx from "clsx";
@@ -1,7 +1,7 @@
1
- import { u as Method } from "./index-DuHyTVVD.js";
2
- import { w as TransformRequestSnippetFn } from "./sdk-BDzHdl2y.js";
1
+ import { d as Method, o as HasStainlessPath } from "./index-CwjGm9zX.js";
2
+ import { w as TransformRequestSnippetFn } from "./sdk-BiZDCG58.js";
3
3
  import * as React$1 from "react";
4
- import * as react_jsx_runtime88 from "react/jsx-runtime";
4
+ import * as react_jsx_runtime89 from "react/jsx-runtime";
5
5
 
6
6
  //#region src/components/snippets.d.ts
7
7
  type SnippetCodeProps = {
@@ -12,42 +12,42 @@ type SnippetCodeProps = {
12
12
  declare function SnippetCode({
13
13
  content,
14
14
  language
15
- }: SnippetCodeProps): react_jsx_runtime88.JSX.Element;
15
+ }: SnippetCodeProps): react_jsx_runtime89.JSX.Element;
16
16
  type SnippetProps = {
17
- method: Method;
17
+ method: Partial<Method> & HasStainlessPath;
18
18
  requestTitle?: React$1.ReactNode;
19
19
  transformRequestSnippet?: TransformRequestSnippetFn;
20
20
  };
21
21
  type SnippetContainerProps = {
22
- method: Method;
22
+ method: Partial<Method> & HasStainlessPath;
23
23
  children: React$1.ReactNode;
24
24
  signature?: string;
25
25
  };
26
26
  declare function SnippetContainer({
27
27
  children
28
- }: SnippetContainerProps): react_jsx_runtime88.JSX.Element;
28
+ }: SnippetContainerProps): react_jsx_runtime89.JSX.Element;
29
29
  type SnippetRequestContainerProps = {
30
30
  children?: React$1.ReactNode;
31
31
  signature?: string;
32
32
  };
33
33
  declare function SnippetRequestContainer({
34
34
  children
35
- }: SnippetRequestContainerProps): react_jsx_runtime88.JSX.Element;
35
+ }: SnippetRequestContainerProps): react_jsx_runtime89.JSX.Element;
36
36
  declare function Snippet({
37
37
  requestTitle,
38
38
  method,
39
39
  transformRequestSnippet
40
- }: SnippetProps): react_jsx_runtime88.JSX.Element | null;
40
+ }: SnippetProps): react_jsx_runtime89.JSX.Element | null;
41
41
  declare function SnippetButtons({
42
42
  content
43
43
  }: {
44
44
  content: string;
45
- }): react_jsx_runtime88.JSX.Element;
45
+ }): react_jsx_runtime89.JSX.Element;
46
46
  declare function SnippetFooter(): React$1.ReactNode;
47
47
  declare function SnippetResponse({
48
48
  responses
49
49
  }: {
50
50
  responses: Method['exampleResponses'];
51
- }): react_jsx_runtime88.JSX.Element | null;
51
+ }): react_jsx_runtime89.JSX.Element | null;
52
52
  //#endregion
53
53
  export { SnippetContainer as a, SnippetProps as c, SnippetResponse as d, SnippetCodeProps as i, SnippetRequestContainer as l, SnippetButtons as n, SnippetContainerProps as o, SnippetCode as r, SnippetFooter as s, Snippet as t, SnippetRequestContainerProps as u };
package/dist/spec.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { _ as SpecLanguage, d as Model, g as Spec, i as DeclarationNode, p as Resource, u as Method } from "./index-DuHyTVVD.js";
2
- import { t as DocsLanguage } from "./routing-CqnhQY4G.js";
1
+ import { _ as Spec, d as Method, f as Model, i as DeclarationNode, m as Resource, v as SpecLanguage } from "./index-CwjGm9zX.js";
2
+ import { t as DocsLanguage } from "./routing-BEbg8P4_.js";
3
3
 
4
4
  //#region src/spec.d.ts
5
5
  type SecurityScheme = Spec['security_schemes'][number];
package/dist/spec.js CHANGED
@@ -1,5 +1,5 @@
1
- import { n as Languages } from "./routing-CLgL--x1.js";
2
- import { r as isResourceEmpty } from "./utils-36jzmKxv.js";
1
+ import { n as Languages } from "./routing-B7QoUwlD.js";
2
+ import { r as isResourceEmpty } from "./utils-KWHcUI-r.js";
3
3
 
4
4
  //#region src/spec.ts
5
5
  const defaultTransforms = {
@@ -1,4 +1,5 @@
1
- import * as react_jsx_runtime74 from "react/jsx-runtime";
1
+ import { ReactNode } from "react";
2
+ import * as react_jsx_runtime61 from "react/jsx-runtime";
2
3
 
3
4
  //#region src/components/stl-sidebar.d.ts
4
5
  declare module 'react' {
@@ -11,22 +12,34 @@ declare module 'react' {
11
12
  }
12
13
  }
13
14
  }
15
+ type StlSidebarTarget = {
16
+ type: 'href';
17
+ href: string;
18
+ } | {
19
+ type: 'stainlessPath';
20
+ stainlessPath: string;
21
+ };
14
22
  interface StlSidebarLink {
15
23
  type: 'link';
24
+ icon?: ReactNode;
16
25
  label: string;
26
+ /** Current sidebar item is highlighted. */
17
27
  isCurrent?: boolean;
18
- attrs: Record<string, unknown>;
19
- href?: string;
20
- stainlessPath?: string;
28
+ target: StlSidebarTarget;
29
+ /** Additional HTML attributes that will be attached to the anchor element. */
30
+ attrs?: Record<string, unknown>;
21
31
  }
22
32
  interface StlSidebarGroup {
23
33
  type: 'group';
34
+ icon?: ReactNode;
24
35
  label: string;
25
36
  entries: Array<StlSidebarLink | StlSidebarGroup>;
26
- collapsed: boolean;
37
+ /** Defaults to true. */
38
+ collapsible?: boolean;
39
+ collapsed?: boolean;
40
+ /** Current sidebar item is highlighted. */
27
41
  isCurrent?: boolean;
28
- href?: string;
29
- stainlessPath?: string;
42
+ target?: StlSidebarTarget;
30
43
  }
31
44
  type StlSidebarEntry = StlSidebarLink | StlSidebarGroup;
32
45
  type StlSidebarProps = {
@@ -40,6 +53,6 @@ type StlSidebarProps = {
40
53
  declare function StlSidebar({
41
54
  entries,
42
55
  withStarlightRestoration
43
- }: StlSidebarProps): react_jsx_runtime74.JSX.Element;
56
+ }: StlSidebarProps): react_jsx_runtime61.JSX.Element;
44
57
  //#endregion
45
- export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarGroup as r, StlSidebar as t };
58
+ export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarTarget as o, StlSidebarGroup as r, StlSidebar as t };
@@ -1,4 +1,5 @@
1
- import * as react_jsx_runtime34 from "react/jsx-runtime";
1
+ import { ReactNode } from "react";
2
+ import * as react_jsx_runtime44 from "react/jsx-runtime";
2
3
 
3
4
  //#region src/components/stl-sidebar.d.ts
4
5
  declare module 'react' {
@@ -11,22 +12,34 @@ declare module 'react' {
11
12
  }
12
13
  }
13
14
  }
15
+ type StlSidebarTarget = {
16
+ type: 'href';
17
+ href: string;
18
+ } | {
19
+ type: 'stainlessPath';
20
+ stainlessPath: string;
21
+ };
14
22
  interface StlSidebarLink {
15
23
  type: 'link';
24
+ icon?: ReactNode;
16
25
  label: string;
26
+ /** Current sidebar item is highlighted. */
17
27
  isCurrent?: boolean;
18
- attrs: Record<string, unknown>;
19
- href?: string;
20
- stainlessPath?: string;
28
+ target: StlSidebarTarget;
29
+ /** Additional HTML attributes that will be attached to the anchor element. */
30
+ attrs?: Record<string, unknown>;
21
31
  }
22
32
  interface StlSidebarGroup {
23
33
  type: 'group';
34
+ icon?: ReactNode;
24
35
  label: string;
25
36
  entries: Array<StlSidebarLink | StlSidebarGroup>;
26
- collapsed: boolean;
37
+ /** Defaults to true. */
38
+ collapsible?: boolean;
39
+ collapsed?: boolean;
40
+ /** Current sidebar item is highlighted. */
27
41
  isCurrent?: boolean;
28
- href?: string;
29
- stainlessPath?: string;
42
+ target?: StlSidebarTarget;
30
43
  }
31
44
  type StlSidebarEntry = StlSidebarLink | StlSidebarGroup;
32
45
  type StlSidebarProps = {
@@ -40,6 +53,6 @@ type StlSidebarProps = {
40
53
  declare function StlSidebar({
41
54
  entries,
42
55
  withStarlightRestoration
43
- }: StlSidebarProps): react_jsx_runtime34.JSX.Element;
56
+ }: StlSidebarProps): react_jsx_runtime44.JSX.Element;
44
57
  //#endregion
45
- export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarGroup as r, StlSidebar as t };
58
+ export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarTarget as o, StlSidebarGroup as r, StlSidebar as t };
@@ -0,0 +1,106 @@
1
+ import { t as useComponents } from "./use-components-BUz3GbO4.js";
2
+ import { t as style_default } from "./style-Btdhlyzs.js";
3
+ import { Fragment, jsx, jsxs } from "react/jsx-runtime";
4
+ import clsx from "clsx";
5
+ import { ChevronRight } from "lucide-react";
6
+
7
+ //#region src/components/stl-sidebar.tsx
8
+ function targetToAttributes(target) {
9
+ return {
10
+ href: target.type === "href" ? target.href : void 0,
11
+ stainlessPath: target.type === "stainlessPath" ? target.stainlessPath : void 0
12
+ };
13
+ }
14
+ function StlSidebarSublist({ entries, entryToIndex }) {
15
+ return /* @__PURE__ */ jsx("ul", {
16
+ className: style_default.SidebarList,
17
+ children: entries.map((entry, index) => entry.type === "link" ? /* @__PURE__ */ jsx(LinkEntry, { entry }, index) : /* @__PURE__ */ jsx(GroupEntry, {
18
+ entry,
19
+ entryToIndex
20
+ }, index))
21
+ });
22
+ }
23
+ function EntryItem({ className, children }) {
24
+ return /* @__PURE__ */ jsx("li", {
25
+ className: clsx(style_default.SidebarEntry, className),
26
+ children
27
+ });
28
+ }
29
+ function LinkEntry({ entry }) {
30
+ const Docs = useComponents();
31
+ return /* @__PURE__ */ jsx(EntryItem, {
32
+ className: style_default.SidebarEntryLink,
33
+ children: /* @__PURE__ */ jsxs(Docs.Link, {
34
+ ...targetToAttributes(entry.target),
35
+ "aria-current": entry.isCurrent ? "page" : void 0,
36
+ ...entry.attrs,
37
+ children: [entry.icon, entry.label]
38
+ })
39
+ });
40
+ }
41
+ function GroupEntry({ entry, entryToIndex }) {
42
+ const Docs = useComponents();
43
+ const restorePointIndex = entryToIndex?.get(entry);
44
+ const { collapsible = true } = entry;
45
+ const labelWithIcon = /* @__PURE__ */ jsxs(Fragment, { children: [entry.label, entry.icon] });
46
+ const GroupElement = collapsible ? "details" : "div";
47
+ const GroupLabelElement = collapsible ? "summary" : "div";
48
+ return /* @__PURE__ */ jsxs(EntryItem, {
49
+ className: style_default.SidebarEntryGroup,
50
+ children: [entry.target && /* @__PURE__ */ jsx(Docs.Link, {
51
+ ...targetToAttributes(entry.target),
52
+ "aria-current": entry.isCurrent ? "page" : void 0,
53
+ children: labelWithIcon
54
+ }), /* @__PURE__ */ jsxs(GroupElement, {
55
+ className: style_default.SidebarExpander,
56
+ ...collapsible ? { open: flattenStlSidebar(entry.entries).some((i) => i.isCurrent) || !entry.collapsed } : {},
57
+ children: [
58
+ /* @__PURE__ */ jsxs(GroupLabelElement, {
59
+ className: style_default.ExpanderSummary,
60
+ children: [/* @__PURE__ */ jsx("span", {
61
+ "aria-hidden": entry.target ? "true" : void 0,
62
+ children: labelWithIcon
63
+ }), entry.entries.length > 0 && collapsible && /* @__PURE__ */ jsx(ChevronRight, {
64
+ size: 16,
65
+ strokeWidth: 1,
66
+ className: `${style_default.Icon} ${style_default.ExpanderSummaryIcon}`
67
+ })]
68
+ }),
69
+ restorePointIndex !== void 0 && /* @__PURE__ */ jsx("sl-sidebar-restore", { "data-index": restorePointIndex }),
70
+ entry.entries.length > 0 && /* @__PURE__ */ jsx(StlSidebarSublist, {
71
+ entries: entry.entries,
72
+ entryToIndex
73
+ })
74
+ ]
75
+ })]
76
+ });
77
+ }
78
+ function StlSidebar({ entries, withStarlightRestoration }) {
79
+ const entryToIndex = withStarlightRestoration ? computeEntryToIndex(entries) : void 0;
80
+ return /* @__PURE__ */ jsx("div", {
81
+ className: `${style_default.Root} ${style_default.Sidebar}`,
82
+ children: /* @__PURE__ */ jsx(StlSidebarSublist, {
83
+ entries,
84
+ entryToIndex
85
+ })
86
+ });
87
+ }
88
+ function computeEntryToIndex(allEntries) {
89
+ const entryToIndex = /* @__PURE__ */ new Map();
90
+ let currentIndex = 0;
91
+ function addEntries(entries) {
92
+ for (const entry of entries) if (entry.type === "group") {
93
+ entryToIndex.set(entry, currentIndex);
94
+ currentIndex++;
95
+ addEntries(entry.entries);
96
+ }
97
+ }
98
+ addEntries(allEntries);
99
+ return entryToIndex;
100
+ }
101
+ function flattenStlSidebar(sidebar) {
102
+ return sidebar.flatMap((entry) => entry.type === "group" ? flattenStlSidebar(entry.entries) : entry);
103
+ }
104
+
105
+ //#endregion
106
+ export { StlSidebar as t };
@@ -90,6 +90,7 @@ var style_default = {
90
90
  SignatureParams: "stldoc-signature-params",
91
91
  SignatureParen: "stldocs-signature-paren",
92
92
  SignatureReturns: "stldocs-signature-returns",
93
+ TerraformResourceTitle: "stldocs-terraform-resource-title",
93
94
  Property: "stldocs-property",
94
95
  Properties: "stldocs-properties",
95
96
  PropertyHeader: "stldocs-property-header",
package/dist/style.d.ts CHANGED
@@ -90,6 +90,7 @@ declare const _default: {
90
90
  readonly SignatureParams: "stldoc-signature-params";
91
91
  readonly SignatureParen: "stldocs-signature-paren";
92
92
  readonly SignatureReturns: "stldocs-signature-returns";
93
+ readonly TerraformResourceTitle: "stldocs-terraform-resource-title";
93
94
  readonly Property: "stldocs-property";
94
95
  readonly Properties: "stldocs-properties";
95
96
  readonly PropertyHeader: "stldocs-property-header";
package/dist/style.js CHANGED
@@ -1,3 +1,3 @@
1
- import { t as style_default } from "./style-Bxr5gqcM.js";
1
+ import { t as style_default } from "./style-Btdhlyzs.js";
2
2
 
3
3
  export { style_default as default };
@@ -25,7 +25,7 @@
25
25
  .stldocs-resource {
26
26
  padding: 2rem 0;
27
27
 
28
- .stldocs-resource-content {
28
+ &:not([data-stl-resource-language='terraform']) .stldocs-resource-content {
29
29
  max-width: var(--stldocs-content-width);
30
30
  margin: auto 0;
31
31
  }
@@ -99,7 +99,8 @@
99
99
  }
100
100
 
101
101
  /* Overview page method summary */
102
- .stldocs-root .stldocs-overview .stldocs-method-summary {
102
+ .stldocs-root .stldocs-overview .stldocs-method-summary,
103
+ .stldocs-root .stldocs-overview .stldocs-method {
103
104
  padding: var(--stldocs-content-padding) 0;
104
105
 
105
106
  .stldocs-method-header {
@@ -409,7 +410,8 @@
409
410
  }
410
411
  }
411
412
 
412
- .stldocs-root .stldocs-method {
413
+ .stldocs-root .stldocs-method,
414
+ .stldocs-root .stldocs-resource-content {
413
415
  .stldocs-method-content-column {
414
416
  display: contents;
415
417
  }
@@ -520,6 +522,14 @@
520
522
  .stldocs-method-parameters h5 {
521
523
  margin-left: var(--stldocs-expander-margin-shift);
522
524
  }
525
+
526
+ .stldocs-terraform-resource-title {
527
+ font-family: var(--stl-typography-font-mono);
528
+ font-size: 1.1rem;
529
+ white-space: nowrap;
530
+ overflow: hidden;
531
+ text-overflow: ellipsis;
532
+ }
523
533
  }
524
534
 
525
535
  .stldocs-snippet {