@stainless-api/docs-ui 0.1.0-beta.4 → 0.1.0-beta.40

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 (188) hide show
  1. package/dist/breadcrumbs-CZg0Fk4V.d.ts +20 -0
  2. package/dist/chunk-Bf_Gc_jT.js +18 -0
  3. package/dist/component-generics-BLXXX1dz.d.ts +30 -0
  4. package/dist/component-generics-D3ybuN5r.js +45 -0
  5. package/dist/components/breadcrumbs.d.ts +2 -0
  6. package/dist/components/breadcrumbs.js +15 -0
  7. package/dist/components/icons.d.ts +50 -0
  8. package/dist/components/icons.js +3 -0
  9. package/dist/components/index.d.ts +11 -0
  10. package/dist/components/index.js +15 -0
  11. package/dist/components/method.d.ts +2 -0
  12. package/dist/components/method.js +15 -0
  13. package/dist/components/overview.d.ts +2 -0
  14. package/dist/components/overview.js +15 -0
  15. package/dist/components/primitives.d.ts +2 -0
  16. package/dist/components/primitives.js +15 -0
  17. package/dist/components/properties.d.ts +2 -0
  18. package/dist/components/properties.js +15 -0
  19. package/dist/components/sdk.d.ts +3 -0
  20. package/dist/components/sdk.js +15 -0
  21. package/dist/components/sidebar.d.ts +2 -0
  22. package/dist/components/sidebar.js +15 -0
  23. package/dist/components/snippets.d.ts +4 -0
  24. package/dist/components/snippets.js +15 -0
  25. package/dist/contexts/component-generics.d.ts +2 -0
  26. package/dist/contexts/component-generics.js +3 -0
  27. package/dist/contexts/component-types.d.ts +17 -0
  28. package/dist/contexts/component-types.js +0 -0
  29. package/dist/contexts/component.d.ts +30 -0
  30. package/dist/contexts/component.js +15 -0
  31. package/dist/contexts/docs.d.ts +2 -0
  32. package/dist/contexts/docs.js +3 -0
  33. package/dist/contexts/index.d.ts +19 -0
  34. package/dist/contexts/index.js +15 -0
  35. package/dist/contexts/markdown.d.ts +2 -0
  36. package/dist/contexts/markdown.js +4 -0
  37. package/dist/contexts/navigation.d.ts +3 -0
  38. package/dist/contexts/navigation.js +3 -0
  39. package/dist/contexts/search.d.ts +4 -0
  40. package/dist/contexts/search.js +15 -0
  41. package/dist/contexts/use-components.d.ts +15 -0
  42. package/dist/contexts/use-components.js +4 -0
  43. package/dist/contexts-B-OYzYpz.js +3837 -0
  44. package/dist/docs-BeJaKOCE.d.ts +46 -0
  45. package/dist/docs-CopwX9a7.js +54 -0
  46. package/dist/icons-yb-Jhkmg.js +753 -0
  47. package/dist/index-CBi59jcw.d.ts +240 -0
  48. package/dist/index-DT1wzg21.d.ts +15 -0
  49. package/dist/index-DteYqCJO.d.ts +14 -0
  50. package/dist/index.d.ts +21 -0
  51. package/dist/index.js +15 -7542
  52. package/dist/languages/go.d.ts +12 -0
  53. package/dist/languages/go.js +15 -0
  54. package/dist/languages/http.d.ts +12 -0
  55. package/dist/languages/http.js +15 -0
  56. package/dist/languages/index.d.ts +12 -0
  57. package/dist/languages/index.js +15 -0
  58. package/dist/languages/java.d.ts +12 -0
  59. package/dist/languages/java.js +15 -0
  60. package/dist/languages/python.d.ts +12 -0
  61. package/dist/languages/python.js +15 -0
  62. package/dist/languages/ruby.d.ts +12 -0
  63. package/dist/languages/ruby.js +15 -0
  64. package/dist/languages/typescript.d.ts +12 -0
  65. package/dist/languages/typescript.js +15 -0
  66. package/dist/markdown/index.d.ts +12 -0
  67. package/dist/markdown/index.js +15 -0
  68. package/dist/markdown/md.d.ts +15 -0
  69. package/dist/markdown/md.js +3 -0
  70. package/dist/markdown/utils.d.ts +4 -0
  71. package/dist/markdown/utils.js +3 -0
  72. package/dist/markdown-DTVxnxGP.d.ts +22 -0
  73. package/dist/markdown-Diyg-eof.js +48 -0
  74. package/dist/md-DxiV1_vy.js +41 -0
  75. package/dist/method-DHjDGGA_.d.ts +71 -0
  76. package/dist/navigation-CGr5_w6z.js +24 -0
  77. package/dist/navigation-rt_B_1lt.d.ts +29 -0
  78. package/dist/overview-CKJV2xUO.d.ts +39 -0
  79. package/dist/pagefind-BaK1krMe.js +15 -0
  80. package/dist/primitives-CiVFjnRA.d.ts +99 -0
  81. package/dist/properties-Z45x-uLZ.d.ts +46 -0
  82. package/dist/routing-DNN8R6bZ.d.ts +54 -0
  83. package/dist/routing-qs2YNG9o.js +189 -0
  84. package/dist/routing.d.ts +2 -0
  85. package/dist/routing.js +3 -180
  86. package/dist/sdk-DDWWoPPD.d.ts +119 -0
  87. package/dist/search/index.d.ts +26 -0
  88. package/dist/search/index.js +334 -0
  89. package/dist/search/providers/algolia.d.ts +24 -0
  90. package/dist/search/providers/algolia.js +15 -0
  91. package/dist/search/providers/fuse.d.ts +18 -0
  92. package/dist/search/providers/fuse.js +30 -0
  93. package/dist/search/providers/pagefind.d.ts +7 -0
  94. package/dist/search/providers/pagefind.js +3 -0
  95. package/dist/search/providers/walker.d.ts +9 -0
  96. package/dist/search/providers/walker.js +34 -0
  97. package/dist/search/types.d.ts +3 -0
  98. package/dist/search/types.js +3 -0
  99. package/dist/search-CCDWCiAd.d.ts +21 -0
  100. package/dist/sidebar-DrtsF85U.d.ts +36 -0
  101. package/dist/snippets-B2EEG7AK.d.ts +46 -0
  102. package/dist/spec.d.ts +65 -0
  103. package/dist/spec.js +167 -0
  104. package/dist/style-BhhgPVF6.js +165 -0
  105. package/dist/style-p4qTfnmO.d.ts +164 -0
  106. package/dist/style.d.ts +2 -0
  107. package/dist/style.js +3 -0
  108. package/dist/styles/main.css +724 -754
  109. package/dist/styles/main.js +0 -0
  110. package/dist/styles/primitives.css +287 -466
  111. package/dist/styles/primitives.js +0 -0
  112. package/dist/styles/resets.css +31 -41
  113. package/dist/styles/resets.js +0 -0
  114. package/dist/styles/search.css +175 -274
  115. package/dist/styles/search.js +0 -0
  116. package/dist/styles/sidebar.css +59 -60
  117. package/dist/styles/sidebar.js +0 -0
  118. package/dist/styles/variables.css +26 -89
  119. package/dist/styles/variables.js +0 -0
  120. package/dist/styles.css +1753 -0
  121. package/dist/styles.mjs +1 -0
  122. package/dist/types-DNSz4kuM.d.ts +83 -0
  123. package/dist/types-__XoFvJ_.js +34 -0
  124. package/dist/use-components-BHEwm0mE.js +7 -0
  125. package/dist/utils-CA3mYNaX.d.ts +21 -0
  126. package/dist/utils-D43p_yTd.d.ts +14 -0
  127. package/dist/utils-FnJ4tyuN.js +32 -0
  128. package/dist/utils-Jo_o4DX9.js +31 -0
  129. package/dist/utils.d.ts +2 -0
  130. package/dist/utils.js +4 -0
  131. package/package.json +84 -19
  132. package/dist/mcp.js +0 -16003
  133. package/dist/styles/snippets.css +0 -132
  134. package/src/components/breadcrumbs.tsx +0 -94
  135. package/src/components/chat.tsx +0 -154
  136. package/src/components/dropdown.tsx +0 -91
  137. package/src/components/icons.tsx +0 -584
  138. package/src/components/index.ts +0 -9
  139. package/src/components/method.tsx +0 -144
  140. package/src/components/overview.tsx +0 -159
  141. package/src/components/primitives.tsx +0 -284
  142. package/src/components/properties.tsx +0 -130
  143. package/src/components/scripts/dropdown.ts +0 -78
  144. package/src/components/sdk.tsx +0 -402
  145. package/src/components/sidebar.tsx +0 -99
  146. package/src/components/snippets.tsx +0 -179
  147. package/src/contexts/component-generics.tsx +0 -48
  148. package/src/contexts/component-types.tsx +0 -5
  149. package/src/contexts/component.tsx +0 -32
  150. package/src/contexts/docs.tsx +0 -75
  151. package/src/contexts/index.tsx +0 -17
  152. package/src/contexts/markdown.tsx +0 -43
  153. package/src/contexts/navigation.tsx +0 -44
  154. package/src/contexts/search.tsx +0 -28
  155. package/src/contexts/use-components.tsx +0 -4
  156. package/src/index.ts +0 -6
  157. package/src/languages/go.tsx +0 -281
  158. package/src/languages/http.tsx +0 -321
  159. package/src/languages/index.ts +0 -26
  160. package/src/languages/java.tsx +0 -358
  161. package/src/languages/python.tsx +0 -255
  162. package/src/languages/ruby.tsx +0 -320
  163. package/src/languages/typescript.tsx +0 -393
  164. package/src/markdown/index.ts +0 -107
  165. package/src/markdown/md.ts +0 -45
  166. package/src/markdown/utils.ts +0 -49
  167. package/src/routing.ts +0 -238
  168. package/src/search/form.tsx +0 -127
  169. package/src/search/index.tsx +0 -1
  170. package/src/search/indexer.ts +0 -246
  171. package/src/search/mcp.ts +0 -61
  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 -30
  177. package/src/search/results.tsx +0 -181
  178. package/src/search/state.ts +0 -64
  179. package/src/search/types.ts +0 -116
  180. package/src/style.ts +0 -197
  181. package/src/styles/main.css +0 -993
  182. package/src/styles/primitives.css +0 -572
  183. package/src/styles/resets.css +0 -47
  184. package/src/styles/search.css +0 -342
  185. package/src/styles/sidebar.css +0 -87
  186. package/src/styles/snippets.css +0 -132
  187. package/src/styles/variables.css +0 -90
  188. package/src/utils.ts +0 -41
@@ -1,320 +0,0 @@
1
- import * as React from 'react';
2
- import type * as AST from '~/lib/json-spec-v2/RubyAST';
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);
40
- const { Join } = useComponents();
41
-
42
- if (!(decl && 'children' in decl && decl.children.length > 0) || decl['type']?.['kind'] === 'RubyTypeUnion')
43
- return;
44
-
45
- const items = decl.children.map((prop, key) => (
46
- <span key={key} className={style.TypePropertyName}>
47
- <span className={style.TextIdentifier}>{spec?.decls?.[language]?.[prop]?.['ident']}</span>
48
- </span>
49
- ));
50
-
51
- return (
52
- <span className={style.TypePreview} data-stldocs-type-preview="properties">
53
- <span className={style.TypeBrace}>{' {'}</span>
54
- <span className={style.TypePreviewContent}>
55
- {' '}
56
- <Join items={items} limit={3}>
57
- <span className={style.TextOperator}>, </span>
58
- </Join>{' '}
59
- </span>
60
- <span className={style.TypeBrace}>{'} '}</span>
61
- </span>
62
- );
63
- }
64
-
65
- export function Type({ type }: TypeProps) {
66
- const Lang = useLanguageComponents();
67
- const { SDKReference, Join } = useComponents();
68
-
69
- switch (type.kind) {
70
- case 'RubyTypeBinary':
71
- case 'RubyTypeUnknown':
72
- case 'RubyTypeNull':
73
- case 'RubyTypeInteger':
74
- case 'RubyTypeFloat':
75
- case 'RubyTypeBoolean':
76
- return (
77
- <span className={style.Type}>
78
- <span className={style.TypeKeyword}>{Keywords[type.kind]}</span>
79
- </span>
80
- );
81
-
82
- case 'RubyTypeString':
83
- return (
84
- <span className={style.Type}>
85
- <span className={style.TypeString}>String</span>
86
- </span>
87
- );
88
-
89
- case 'RubyTypeLiteral':
90
- switch (typeof type.literal) {
91
- case 'string':
92
- return (
93
- <span className={style.Type}>
94
- <span className={style.LiteralString}>
95
- {':'}
96
- {type.literal.match(VALID_IDENTIFIER) ? type.literal : JSON.stringify(type.literal)}
97
- </span>
98
- </span>
99
- );
100
- case 'number':
101
- return (
102
- <span className={style.Type}>
103
- <span className={style.LiteralNumeric}>{JSON.stringify(type.literal)}</span>
104
- </span>
105
- );
106
- case 'boolean':
107
- return (
108
- <span className={style.Type}>
109
- <span className={style.LiteralBoolean}>{JSON.stringify(type.literal)}</span>
110
- </span>
111
- );
112
- }
113
-
114
- case 'RubyTypeArray':
115
- return (
116
- <span className={style.Type}>
117
- <span className={style.TypeArray}>{'Array['}</span>
118
- <Lang.Type type={type.elementType} />
119
- <span className={style.TypeArray}>{']'}</span>
120
- </span>
121
- );
122
-
123
- case 'RubyTypeMap':
124
- return (
125
- <span className={style.Type}>
126
- <span className={style.TypeArray}>{'Hash['}</span>
127
- {type.indexType.kind === 'RubyTypeString' ? (
128
- <span className={style.TypeString}>Symbol</span>
129
- ) : (
130
- <Lang.Type type={type.indexType} />
131
- )}
132
- , <Lang.Type type={type.itemType} />
133
- <span className={style.TypeArray}>{']'}</span>
134
- </span>
135
- );
136
-
137
- case 'RubyTypeReference': {
138
- const name = type.ident.split('.').at(-1);
139
- if (!type.typeParameters || type.typeParameters.length === 0)
140
- return (
141
- <span className={style.Type}>
142
- <SDKReference stainlessPath={type.$ref}>{name}</SDKReference>
143
- <TypePreview path={type.$ref} />
144
- </span>
145
- );
146
-
147
- const typeParameters = type.typeParameters.map((t, i) => <Lang.Type key={i} type={t} />);
148
-
149
- return (
150
- <span className={style.Type}>
151
- <SDKReference stainlessPath={type.$ref}>{name}</SDKReference>
152
- <span className={style.TypeBracket}>{'<'}</span>
153
- <Join items={typeParameters}>
154
- <span className={style.TextOperator}>, </span>
155
- </Join>
156
- <span className={style.TypeBracket}>{'>'}</span>
157
- <TypePreview path={type.$ref} />
158
- </span>
159
- );
160
- }
161
-
162
- case 'RubyTypeIntersection':
163
- case 'RubyTypeUnion': {
164
- const items = type.types.map((t, key) => <Lang.Type key={key} type={t} />);
165
-
166
- const delimiter = type.kind === 'RubyTypeUnion' ? '|' : '&';
167
-
168
- return (
169
- <span className={style.Type}>
170
- <span className={style.TypePreview} data-stldocs-type-preview="union">
171
- <span className={style.TypePreviewContent}>
172
- <Join items={items} limit={3}>
173
- <span className={style.TextOperator}> {delimiter} </span>
174
- </Join>
175
- </span>
176
- </span>
177
- </span>
178
- );
179
- }
180
-
181
- case 'RubyTypeBuiltinClass':
182
- return <span className={style.TypeReference}>{type.className}</span>;
183
-
184
- case 'RubyTypeObject': {
185
- const items = type.members.map((prop, key) => (
186
- <span key={key} className={style.TextIdentifier}>
187
- {prop.ident}
188
- </span>
189
- ));
190
-
191
- return (
192
- <span className={style.Type}>
193
- <span className={style.TypePreview} data-stldocs-type-preview="properties">
194
- <span className={style.TypePreviewContent}>
195
- <span className={style.TypeBrace}>{'{ '}</span>
196
- <Join items={items} limit={3}>
197
- <span className={style.TextOperator}>, </span>
198
- </Join>
199
- <span className={style.TypeBrace}>{'}'}</span>
200
- </span>
201
- </span>
202
- </span>
203
- );
204
- }
205
- }
206
- }
207
-
208
- export type MethodSignatureProps = {
209
- decl: AST.RubyDeclFunction;
210
- };
211
-
212
- export function MethodSignature({ decl }: MethodSignatureProps) {
213
- const Lang = useLanguageComponents();
214
- const { Join } = useComponents();
215
-
216
- const params = decl.args.map((param, i) => (
217
- <React.Fragment key={i}>
218
- <span className={style.TextIdentifier}>{param.ident}</span>
219
- </React.Fragment>
220
- ));
221
-
222
- return (
223
- <div className={style.MethodSignature}>
224
- <span className={style.SignatureTitle}>
225
- <span className={style.SignatureQualified}>
226
- <span className={style.TextIdentifier}>{decl.qualified?.slice(0, -decl.ident.length)}</span>
227
- </span>
228
- <span className={style.SignatureName}>
229
- <span className={style.TextIdentifier}>{decl.ident}</span>
230
- </span>
231
- <span className={style.MethodSignature}>
232
- <span className={style.SignatureParen}>{'('}</span>
233
-
234
- <span className={style.SignatureParams}>
235
- <Join items={params}>
236
- <span className={style.TextOperator}>{', '}</span>
237
- </Join>
238
- </span>
239
-
240
- <span className={style.SignatureParen}>{')'}</span>
241
- {' -> '}
242
- {decl.returns ? <Lang.Type type={decl.returns} /> : 'void'}
243
- </span>
244
- </span>
245
- </div>
246
- );
247
- }
248
-
249
- export type PropertyProps = {
250
- decl: AST.RubyDeclaration;
251
- children?: PropertyFn;
252
- };
253
-
254
- export function Property({ decl, children }: PropertyProps) {
255
- const Lang = useLanguageComponents();
256
-
257
- switch (decl.kind) {
258
- case 'RubyDeclProperty':
259
- return children({
260
- name: decl.ident,
261
- typeName: <Lang.TypeName type={decl.type} />,
262
- type: decl.type.kind in ComplexTypes && <Lang.Type type={decl.type} />,
263
- });
264
-
265
- case 'RubyDeclTypeAlias':
266
- return children({
267
- name: decl.ident,
268
- typeName: 'alias',
269
- type: <Lang.Type type={decl.type} />,
270
- });
271
-
272
- case 'RubyDeclReference':
273
- return children({ type: <Lang.Type type={decl.type} /> });
274
-
275
- case 'RubyDeclClass':
276
- return children({ name: decl.ident, typeName: 'class' });
277
- }
278
- }
279
-
280
- export type DeclarationProps = { decl: AST.RubyDeclaration };
281
-
282
- export function Declaration({ decl }: DeclarationProps) {
283
- const Lang = useLanguageComponents();
284
-
285
- if (!decl) return;
286
-
287
- switch (decl.kind) {
288
- case 'RubyDeclProperty':
289
- return (
290
- <>
291
- <span className={style.TypePropertyName}>
292
- <span className={style.TextIdentifier}>{decl.ident}</span>
293
- </span>
294
- <span className={style.TextPunctuation}>: </span>
295
- <Lang.Type type={decl.type} />
296
- </>
297
- );
298
-
299
- case 'RubyDeclTypeAlias':
300
- return (
301
- <>
302
- <span className={style.TextIdentifier}>{decl.ident}</span>
303
- <span className={style.TextOperator}> = </span>
304
- <Lang.Type type={decl.type} />
305
- </>
306
- );
307
-
308
- case 'RubyDeclClass':
309
- return (
310
- <>
311
- <span className={style.TextKeyword}>class </span>
312
- <span className={style.TextIdentifier}>{decl.ident}</span>
313
- <TypePreview path={decl.stainlessPath} />
314
- </>
315
- );
316
-
317
- case 'RubyDeclReference':
318
- return <Lang.Type type={decl.type} />;
319
- }
320
- }