@stainless-api/docs-ui 0.1.0-beta.29 → 0.1.0-beta.30

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 (194) hide show
  1. package/dist/{breadcrumbs-D5viAm7a.d.ts → breadcrumbs-wJ7A9MGt.d.ts} +2 -2
  2. package/dist/{component-generics-BnrVqdQj.d.ts → component-generics--y1IC_M-.d.ts} +2 -1
  3. package/dist/{component-generics-Df4EDvxk.js → component-generics-D3ybuN5r.js} +5 -1
  4. package/dist/components/breadcrumbs.d.ts +1 -1
  5. package/dist/components/breadcrumbs.js +13 -14
  6. package/dist/components/chat.d.ts +3 -3
  7. package/dist/components/chat.js +64 -50
  8. package/dist/components/icons.d.ts +10 -10
  9. package/dist/components/icons.js +1 -1
  10. package/dist/components/index.d.ts +11 -12
  11. package/dist/components/index.js +14 -15
  12. package/dist/components/method.d.ts +1 -1
  13. package/dist/components/method.js +13 -14
  14. package/dist/components/overview.d.ts +1 -1
  15. package/dist/components/overview.js +13 -14
  16. package/dist/components/primitives.d.ts +1 -1
  17. package/dist/components/primitives.js +13 -14
  18. package/dist/components/properties.d.ts +1 -1
  19. package/dist/components/properties.js +13 -14
  20. package/dist/components/sdk.d.ts +2 -2
  21. package/dist/components/sdk.js +13 -14
  22. package/dist/components/sidebar.d.ts +1 -1
  23. package/dist/components/sidebar.js +13 -14
  24. package/dist/components/snippets.d.ts +3 -3
  25. package/dist/components/snippets.js +13 -14
  26. package/dist/contexts/component-generics.d.ts +1 -1
  27. package/dist/contexts/component-generics.js +1 -1
  28. package/dist/contexts/component-types.d.ts +11 -12
  29. package/dist/contexts/component-types.js +0 -1
  30. package/dist/contexts/component.d.ts +14 -14
  31. package/dist/contexts/component.js +13 -14
  32. package/dist/contexts/docs.d.ts +1 -1
  33. package/dist/contexts/docs.js +1 -1
  34. package/dist/contexts/index.d.ts +18 -19
  35. package/dist/contexts/index.js +13 -14
  36. package/dist/contexts/markdown.d.ts +1 -1
  37. package/dist/contexts/markdown.js +2 -2
  38. package/dist/contexts/navigation.d.ts +2 -2
  39. package/dist/contexts/navigation.js +1 -1
  40. package/dist/contexts/search.d.ts +3 -3
  41. package/dist/contexts/search.js +13 -14
  42. package/dist/contexts/use-components.d.ts +10 -11
  43. package/dist/contexts/use-components.js +2 -2
  44. package/dist/contexts-CMNI3ctP.js +3799 -0
  45. package/dist/{docs-DhNaW0DE.d.ts → docs-BvahWQ28.d.ts} +2 -1
  46. package/dist/{docs-Cj25B-Sh.js → docs-CopwX9a7.js} +5 -1
  47. package/dist/icons-yb-Jhkmg.js +753 -0
  48. package/dist/{index-d8_VR8Z5.d.ts → index-BmPNhnpe.d.ts} +6 -6
  49. package/dist/{index-BXO3gZup.d.ts → index-D5NMSAld.d.ts} +26 -25
  50. package/dist/index-rVFBdVz8.d.ts +15 -0
  51. package/dist/index.d.ts +20 -21
  52. package/dist/index.js +15 -7700
  53. package/dist/languages/go.d.ts +11 -12
  54. package/dist/languages/go.js +13 -14
  55. package/dist/languages/http.d.ts +11 -12
  56. package/dist/languages/http.js +13 -14
  57. package/dist/languages/index.d.ts +11 -12
  58. package/dist/languages/index.js +13 -14
  59. package/dist/languages/java.d.ts +11 -12
  60. package/dist/languages/java.js +13 -14
  61. package/dist/languages/python.d.ts +11 -12
  62. package/dist/languages/python.js +13 -14
  63. package/dist/languages/ruby.d.ts +11 -12
  64. package/dist/languages/ruby.js +13 -14
  65. package/dist/languages/typescript.d.ts +11 -12
  66. package/dist/languages/typescript.js +13 -14
  67. package/dist/markdown/index.d.ts +3 -3
  68. package/dist/markdown/index.js +13 -14
  69. package/dist/markdown/md.js +1 -1
  70. package/dist/markdown/utils.d.ts +3 -3
  71. package/dist/markdown/utils.js +1 -1
  72. package/dist/{markdown-DunIdqFE.js → markdown-BmpyokB7.js} +9 -5
  73. package/dist/{markdown-DN8KaRR2.d.ts → markdown-w5UpIiGc.d.ts} +2 -1
  74. package/dist/{method-c3XDArUn.d.ts → method-CLpRObBV.d.ts} +7 -6
  75. package/dist/{navigation-BSn6PX-7.d.ts → navigation-Blr3LaES.d.ts} +3 -2
  76. package/dist/{navigation-CuCg3le8.js → navigation-CGr5_w6z.js} +5 -1
  77. package/dist/{overview-D21weqVJ.d.ts → overview-DBnqhjAg.d.ts} +6 -6
  78. package/dist/{primitives-iB9fIrMF.d.ts → primitives-BFubD3w8.d.ts} +9 -8
  79. package/dist/{properties-Ba6F_GGj.d.ts → properties-DeQRa6VK.d.ts} +4 -4
  80. package/dist/{routing-C8oZYLsf.js → routing-8itEXLx6.js} +1 -1
  81. package/dist/{routing-BE6Vrs-z.d.ts → routing-DNN8R6bZ.d.ts} +1 -1
  82. package/dist/routing.d.ts +1 -1
  83. package/dist/routing.js +3 -180
  84. package/dist/{sdk-D2x2l6JH.d.ts → sdk-BVQyp5Dw.d.ts} +14 -13
  85. package/dist/search/index.d.ts +6 -6
  86. package/dist/search/index.js +233 -110
  87. package/dist/search/providers/algolia.d.ts +2 -2
  88. package/dist/search/providers/algolia.js +13 -14
  89. package/dist/search/providers/fuse.d.ts +2 -2
  90. package/dist/search/providers/fuse.js +13 -14
  91. package/dist/search/providers/pagefind.d.ts +2 -2
  92. package/dist/search/providers/pagefind.js +1 -1
  93. package/dist/search/providers/walker.d.ts +2 -2
  94. package/dist/search/providers/walker.js +13 -14
  95. package/dist/search/types.d.ts +2 -2
  96. package/dist/search/types.js +1 -1
  97. package/dist/{search-KMqOU2tz.d.ts → search-CPp6HpUy.d.ts} +3 -2
  98. package/dist/{sidebar-B1X4gmY2.d.ts → sidebar-BoPLeaxp.d.ts} +5 -4
  99. package/dist/{snippets-BApdMOXp.d.ts → snippets-DLHH_Voi.d.ts} +7 -6
  100. package/dist/{style-BWu-Pqcm.d.ts → style-BEMLtSIK.d.ts} +0 -10
  101. package/dist/{style-CkbsakoF.js → style-CPgcT0Fw.js} +1 -11
  102. package/dist/style.d.ts +1 -1
  103. package/dist/style.js +1 -1
  104. package/dist/styles/main.css +51 -20
  105. package/dist/styles/main.js +0 -0
  106. package/dist/styles/primitives.css +1 -0
  107. package/dist/styles/primitives.js +0 -0
  108. package/dist/styles/resets.css +1 -0
  109. package/dist/styles/resets.js +0 -0
  110. package/dist/styles/search.css +1 -0
  111. package/dist/styles/search.js +0 -0
  112. package/dist/styles/sidebar.css +1 -0
  113. package/dist/styles/sidebar.js +0 -0
  114. package/dist/styles/snippets.css +1 -0
  115. package/dist/styles/snippets.js +0 -0
  116. package/dist/styles/variables.css +2 -0
  117. package/dist/styles/variables.js +0 -0
  118. package/dist/{types-BLgvxY4i.d.ts → types-DNSz4kuM.d.ts} +1 -1
  119. package/dist/{use-components-DI-AbT-D.js → use-components-BHEwm0mE.js} +1 -1
  120. package/dist/{utils-BhYTrLot.js → utils-2FmcHPHp.js} +2 -2
  121. package/dist/{utils-B9JL_XWH.d.ts → utils-DVi3gJLL.d.ts} +2 -2
  122. package/dist/utils.d.ts +1 -1
  123. package/dist/utils.js +2 -2
  124. package/package.json +63 -10
  125. package/dist/components/dropdown.d.ts +0 -2
  126. package/dist/components/dropdown.js +0 -4
  127. package/dist/components/scripts/dropdown.d.ts +0 -12
  128. package/dist/components/scripts/dropdown.js +0 -50
  129. package/dist/contexts-DO0sMzym.js +0 -2581
  130. package/dist/dropdown-Dv9VAYCW.d.ts +0 -42
  131. package/dist/dropdown-kUhwBigR.js +0 -38
  132. package/dist/icons--8QR-PrL.js +0 -222
  133. package/dist/index-BW6OPqAo.d.ts +0 -16
  134. package/dist/mcp.cjs +0 -983418
  135. package/src/components/breadcrumbs.tsx +0 -94
  136. package/src/components/chat.tsx +0 -157
  137. package/src/components/icons.tsx +0 -584
  138. package/src/components/index.ts +0 -8
  139. package/src/components/method.tsx +0 -145
  140. package/src/components/overview.tsx +0 -172
  141. package/src/components/primitives.tsx +0 -301
  142. package/src/components/properties.tsx +0 -132
  143. package/src/components/sdk.tsx +0 -408
  144. package/src/components/sidebar.tsx +0 -99
  145. package/src/components/snippets.tsx +0 -197
  146. package/src/contexts/component-generics.tsx +0 -43
  147. package/src/contexts/component-types.tsx +0 -5
  148. package/src/contexts/component.tsx +0 -32
  149. package/src/contexts/docs.tsx +0 -86
  150. package/src/contexts/index.tsx +0 -20
  151. package/src/contexts/markdown.tsx +0 -44
  152. package/src/contexts/navigation.tsx +0 -44
  153. package/src/contexts/search.tsx +0 -27
  154. package/src/contexts/use-components.tsx +0 -4
  155. package/src/hooks/use-strict-context.tsx +0 -16
  156. package/src/index.ts +0 -6
  157. package/src/languages/go.tsx +0 -281
  158. package/src/languages/http.tsx +0 -329
  159. package/src/languages/index.ts +0 -26
  160. package/src/languages/java.tsx +0 -358
  161. package/src/languages/python.tsx +0 -258
  162. package/src/languages/ruby.tsx +0 -327
  163. package/src/languages/typescript.tsx +0 -399
  164. package/src/markdown/index.ts +0 -112
  165. package/src/markdown/md.ts +0 -45
  166. package/src/markdown/utils.ts +0 -52
  167. package/src/routing.ts +0 -238
  168. package/src/search/form.tsx +0 -130
  169. package/src/search/index.tsx +0 -1
  170. package/src/search/indexer.ts +0 -248
  171. package/src/search/mcp.ts +0 -156
  172. package/src/search/printer.tsx +0 -86
  173. package/src/search/providers/algolia.ts +0 -88
  174. package/src/search/providers/fuse.ts +0 -19
  175. package/src/search/providers/pagefind.ts +0 -17
  176. package/src/search/providers/walker.ts +0 -32
  177. package/src/search/results.tsx +0 -183
  178. package/src/search/state.ts +0 -64
  179. package/src/search/types.ts +0 -116
  180. package/src/style.ts +0 -185
  181. package/src/styles/main.css +0 -989
  182. package/src/styles/primitives.css +0 -392
  183. package/src/styles/resets.css +0 -39
  184. package/src/styles/search.css +0 -359
  185. package/src/styles/sidebar.css +0 -85
  186. package/src/styles/snippets.css +0 -130
  187. package/src/styles/variables.css +0 -86
  188. package/src/utils.ts +0 -40
  189. /package/dist/{chunk-Bp6m_JJh.js → chunk-DsStOjWQ.js} +0 -0
  190. /package/dist/{md-Dg8aOyMA.js → md-DxiV1_vy.js} +0 -0
  191. /package/dist/{pagefind-ChrPfuVv.js → pagefind-BaK1krMe.js} +0 -0
  192. /package/dist/{types-DFN4M1Sp.js → types-__XoFvJ_.js} +0 -0
  193. /package/dist/{utils-ByZH9QWT.js → utils-BCfb0F9R.js} +0 -0
  194. /package/dist/{utils-DlayebL1.d.ts → utils-D43p_yTd.d.ts} +0 -0
@@ -1,327 +0,0 @@
1
- import * as React from 'react';
2
- import { RubyAST as AST } from '@stainless/sdk-json';
3
- import { useDeclaration, useLanguage, useLanguageComponents, useSpec } from '../contexts';
4
- import { useComponents } from '../contexts/use-components';
5
- import style from '../style';
6
- import { PropertyFn } from '.';
7
-
8
- const ComplexTypes: Record<string, string> = {
9
- RubyTypeObject: 'object',
10
- RubyTypeUnion: 'union',
11
- RubyTypeIntersection: 'intersection',
12
- RubyTypeArray: 'array',
13
- RubyTypeMap: 'hash',
14
- };
15
-
16
- const Keywords: Record<string, string> = {
17
- RubyTypeBinary: 'StringIO',
18
- RubyTypeUnknown: 'untyped',
19
- RubyTypeNull: 'nil',
20
- RubyTypeInteger: 'Integer',
21
- RubyTypeFloat: 'Float',
22
- RubyTypeBoolean: 'bool',
23
- };
24
-
25
- type TypeProps = {
26
- type: AST.RubyType;
27
- };
28
-
29
- export function TypeName({ type }: TypeProps) {
30
- const Lang = useLanguageComponents();
31
- return ComplexTypes[type.kind] ?? <Lang.Type type={type} />;
32
- }
33
-
34
- const VALID_IDENTIFIER = /^[_A-Za-z][_A-Za-z0-9]*$/;
35
-
36
- function TypePreview({ path }: { path: string }) {
37
- const spec = useSpec();
38
- const language = useLanguage();
39
- const decl = useDeclaration(path, false);
40
- const { Join } = useComponents();
41
-
42
- if (
43
- !(decl && 'children' in decl && decl.children && decl.children.length > 0) ||
44
- ('type' in decl && decl['type'] && 'kind' in decl['type'] && decl['type']?.['kind'] === 'RubyTypeUnion')
45
- )
46
- return;
47
-
48
- const items = decl.children.map((prop, key) => {
49
- const p = spec?.decls?.[language]?.[prop];
50
- return (
51
- <span key={key} className={style.TypePropertyName}>
52
- <span className={style.TextIdentifier}>{p && 'ident' in p ? p['ident'] : null}</span>
53
- </span>
54
- );
55
- });
56
-
57
- return (
58
- <span className={style.TypePreview} data-stldocs-type-preview="properties">
59
- <span className={style.TypeBrace}>{' {'}</span>
60
- <span className={style.TypePreviewContent}>
61
- {' '}
62
- <Join items={items} limit={3}>
63
- <span className={style.TextOperator}>, </span>
64
- </Join>{' '}
65
- </span>
66
- <span className={style.TypeBrace}>{'} '}</span>
67
- </span>
68
- );
69
- }
70
-
71
- export function Type({ type }: TypeProps) {
72
- const Lang = useLanguageComponents();
73
- const { SDKReference, Join } = useComponents();
74
-
75
- switch (type.kind) {
76
- case 'RubyTypeBinary':
77
- case 'RubyTypeUnknown':
78
- case 'RubyTypeNull':
79
- case 'RubyTypeInteger':
80
- case 'RubyTypeFloat':
81
- case 'RubyTypeBoolean':
82
- return (
83
- <span className={style.Type}>
84
- <span className={style.TypeKeyword}>{Keywords[type.kind]}</span>
85
- </span>
86
- );
87
-
88
- case 'RubyTypeString':
89
- return (
90
- <span className={style.Type}>
91
- <span className={style.TypeString}>String</span>
92
- </span>
93
- );
94
-
95
- case 'RubyTypeLiteral':
96
- switch (typeof type.literal) {
97
- case 'string':
98
- return (
99
- <span className={style.Type}>
100
- <span className={style.LiteralString}>
101
- {':'}
102
- {type.literal.match(VALID_IDENTIFIER) ? type.literal : JSON.stringify(type.literal)}
103
- </span>
104
- </span>
105
- );
106
- case 'number':
107
- return (
108
- <span className={style.Type}>
109
- <span className={style.LiteralNumeric}>{JSON.stringify(type.literal)}</span>
110
- </span>
111
- );
112
- case 'boolean':
113
- return (
114
- <span className={style.Type}>
115
- <span className={style.LiteralBoolean}>{JSON.stringify(type.literal)}</span>
116
- </span>
117
- );
118
- }
119
- break;
120
-
121
- case 'RubyTypeArray':
122
- return (
123
- <span className={style.Type}>
124
- <span className={style.TypeArray}>{'Array['}</span>
125
- <Lang.Type type={type.elementType} />
126
- <span className={style.TypeArray}>{']'}</span>
127
- </span>
128
- );
129
-
130
- case 'RubyTypeMap':
131
- return (
132
- <span className={style.Type}>
133
- <span className={style.TypeArray}>{'Hash['}</span>
134
- {type.indexType.kind === 'RubyTypeString' ? (
135
- <span className={style.TypeString}>Symbol</span>
136
- ) : (
137
- <Lang.Type type={type.indexType} />
138
- )}
139
- , <Lang.Type type={type.itemType} />
140
- <span className={style.TypeArray}>{']'}</span>
141
- </span>
142
- );
143
-
144
- case 'RubyTypeReference': {
145
- const name = type.ident.split('.').at(-1);
146
- if (!type.typeParameters || type.typeParameters.length === 0)
147
- return (
148
- <span className={style.Type}>
149
- <SDKReference stainlessPath={type.$ref!}>{name}</SDKReference>
150
- <TypePreview path={type.$ref!} />
151
- </span>
152
- );
153
-
154
- const typeParameters = type.typeParameters.map((t, i) => <Lang.Type key={i} type={t} />);
155
-
156
- return (
157
- <span className={style.Type}>
158
- <SDKReference stainlessPath={type.$ref!}>{name}</SDKReference>
159
- <span className={style.TypeBracket}>{'<'}</span>
160
- <Join items={typeParameters}>
161
- <span className={style.TextOperator}>, </span>
162
- </Join>
163
- <span className={style.TypeBracket}>{'>'}</span>
164
- <TypePreview path={type.$ref!} />
165
- </span>
166
- );
167
- }
168
-
169
- case 'RubyTypeIntersection':
170
- case 'RubyTypeUnion': {
171
- const items = type.types.map((t, key) => <Lang.Type key={key} type={t} />);
172
-
173
- const delimiter = type.kind === 'RubyTypeUnion' ? '|' : '&';
174
-
175
- return (
176
- <span className={style.Type}>
177
- <span className={style.TypePreview} data-stldocs-type-preview="union">
178
- <span className={style.TypePreviewContent}>
179
- <Join items={items} limit={3}>
180
- <span className={style.TextOperator}> {delimiter} </span>
181
- </Join>
182
- </span>
183
- </span>
184
- </span>
185
- );
186
- }
187
-
188
- case 'RubyTypeBuiltinClass':
189
- return <span className={style.TypeReference}>{type.className}</span>;
190
-
191
- case 'RubyTypeObject': {
192
- const items = type.members.map((prop, key) => (
193
- <span key={key} className={style.TextIdentifier}>
194
- {prop.ident}
195
- </span>
196
- ));
197
-
198
- return (
199
- <span className={style.Type}>
200
- <span className={style.TypePreview} data-stldocs-type-preview="properties">
201
- <span className={style.TypePreviewContent}>
202
- <span className={style.TypeBrace}>{'{ '}</span>
203
- <Join items={items} limit={3}>
204
- <span className={style.TextOperator}>, </span>
205
- </Join>
206
- <span className={style.TypeBrace}>{'}'}</span>
207
- </span>
208
- </span>
209
- </span>
210
- );
211
- }
212
- }
213
- }
214
-
215
- export type MethodSignatureProps = {
216
- decl: AST.RubyDeclFunction;
217
- };
218
-
219
- export function MethodSignature({ decl }: MethodSignatureProps) {
220
- const Lang = useLanguageComponents();
221
- const { Join } = useComponents();
222
-
223
- const params = decl.args.map((param, i) => (
224
- <React.Fragment key={i}>
225
- <span className={style.TextIdentifier}>{param.ident}</span>
226
- </React.Fragment>
227
- ));
228
-
229
- return (
230
- <div className={style.MethodSignature}>
231
- <span className={style.SignatureTitle}>
232
- <span className={style.SignatureQualified}>
233
- <span className={style.TextIdentifier}>{decl.qualified?.slice(0, -decl.ident.length)}</span>
234
- </span>
235
- <span className={style.SignatureName}>
236
- <span className={style.TextIdentifier}>{decl.ident}</span>
237
- </span>
238
- <span className={style.MethodSignature}>
239
- <span className={style.SignatureParen}>{'('}</span>
240
-
241
- <span className={style.SignatureParams}>
242
- <Join items={params}>
243
- <span className={style.TextOperator}>{', '}</span>
244
- </Join>
245
- </span>
246
-
247
- <span className={style.SignatureParen}>{')'}</span>
248
- {' -> '}
249
- {decl.returns ? <Lang.Type type={decl.returns} /> : 'void'}
250
- </span>
251
- </span>
252
- </div>
253
- );
254
- }
255
-
256
- export type PropertyProps = {
257
- decl: AST.RubyDeclaration;
258
- children: PropertyFn;
259
- };
260
-
261
- export function Property({ decl, children }: PropertyProps) {
262
- const Lang = useLanguageComponents();
263
-
264
- switch (decl.kind) {
265
- case 'RubyDeclProperty':
266
- return children({
267
- name: decl.ident,
268
- typeName: <Lang.TypeName type={decl.type} />,
269
- type: decl.type.kind in ComplexTypes && <Lang.Type type={decl.type} />,
270
- });
271
-
272
- case 'RubyDeclTypeAlias':
273
- return children({
274
- name: decl.ident,
275
- typeName: 'alias',
276
- type: <Lang.Type type={decl.type} />,
277
- });
278
-
279
- case 'RubyDeclReference':
280
- return children({ type: <Lang.Type type={decl.type} /> });
281
-
282
- case 'RubyDeclClass':
283
- return children({ name: decl.ident, typeName: 'class' });
284
- }
285
- }
286
-
287
- export type DeclarationProps = { decl: AST.RubyDeclaration };
288
-
289
- export function Declaration({ decl }: DeclarationProps) {
290
- const Lang = useLanguageComponents();
291
-
292
- if (!decl) return;
293
-
294
- switch (decl.kind) {
295
- case 'RubyDeclProperty':
296
- return (
297
- <>
298
- <span className={style.TypePropertyName}>
299
- <span className={style.TextIdentifier}>{decl.ident}</span>
300
- </span>
301
- <span className={style.TextPunctuation}>: </span>
302
- <Lang.Type type={decl.type} />
303
- </>
304
- );
305
-
306
- case 'RubyDeclTypeAlias':
307
- return (
308
- <>
309
- <span className={style.TextIdentifier}>{decl.ident}</span>
310
- <span className={style.TextOperator}> = </span>
311
- <Lang.Type type={decl.type} />
312
- </>
313
- );
314
-
315
- case 'RubyDeclClass':
316
- return (
317
- <>
318
- <span className={style.TextKeyword}>class </span>
319
- <span className={style.TextIdentifier}>{decl.ident}</span>
320
- <TypePreview path={decl.stainlessPath} />
321
- </>
322
- );
323
-
324
- case 'RubyDeclReference':
325
- return <Lang.Type type={decl.type} />;
326
- }
327
- }