rspress-plugin-api-extractor 0.1.2 → 0.2.0
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/README.md +2 -2
- package/api-extracted-package.js +426 -0
- package/build-program.js +120 -0
- package/build-stages.js +664 -0
- package/category-resolver.js +50 -0
- package/code-post-processor.js +38 -0
- package/config-helpers.js +106 -0
- package/config-utils.js +258 -0
- package/content-hash.js +79 -0
- package/errors.js +29 -0
- package/formatter.js +69 -0
- package/hide-cut-transformer.js +96 -0
- package/index.d.ts +901 -831
- package/index.js +4 -6128
- package/layers/ConfigServiceLive.js +377 -0
- package/layers/ObservabilityLive.js +136 -0
- package/layers/PathDerivationServiceLive.js +16 -0
- package/layers/SnapshotServiceLive.js +94 -0
- package/layers/TypeRegistryServiceLive.js +46 -0
- package/llms-processing.js +270 -0
- package/llms-program.js +262 -0
- package/loader.js +186 -0
- package/markdown/cross-linker.js +156 -0
- package/markdown/helpers.js +364 -0
- package/markdown/index.js +11 -0
- package/markdown/page-generators/class-page.js +357 -0
- package/markdown/page-generators/enum-page.js +152 -0
- package/markdown/page-generators/function-page.js +127 -0
- package/markdown/page-generators/index-pages.js +27 -0
- package/markdown/page-generators/interface-page.js +307 -0
- package/markdown/page-generators/namespace-page.js +280 -0
- package/markdown/page-generators/type-alias-page.js +110 -0
- package/markdown/page-generators/variable-page.js +110 -0
- package/markdown/shiki-utils.js +48 -0
- package/migrations/001_create_snapshots.js +25 -0
- package/model-loader.js +95 -0
- package/multi-entry-resolver.js +70 -0
- package/og-resolver.js +271 -0
- package/package.json +63 -73
- package/path-derivation.js +48 -0
- package/plugin.js +218 -0
- package/prettier-formatter.js +73 -0
- package/public/tsconfig/rspress.json +44 -0
- package/remark-api-codeblocks.js +130 -0
- package/remark-with-api.js +172 -0
- package/route-collisions.js +52 -0
- package/runtime/components/ApiExample/index.js +29 -25
- package/runtime/components/ApiLlmsPackageActions/index.js +252 -323
- package/runtime/components/ApiLlmsViewOptions/index.js +269 -340
- package/runtime/components/ApiMember/index.js +49 -47
- package/runtime/components/ApiSignature/index.js +32 -28
- package/runtime/components/EnumMembersTable/{index_module.css → index.css} +18 -19
- package/runtime/components/EnumMembersTable/index.js +36 -67
- package/runtime/components/EnumMembersTable/index.module.js +9 -6
- package/runtime/components/ExampleBlock/{index_module.css → index.css} +2 -3
- package/runtime/components/ExampleBlock/index.js +23 -28
- package/runtime/components/ExampleBlock/index.module.js +8 -5
- package/runtime/components/MarkdownContent/index.js +26 -18
- package/runtime/components/MarkdownText/index.js +28 -22
- package/runtime/components/MemberSignature/{index_module.css → index.css} +5 -6
- package/runtime/components/MemberSignature/index.js +46 -46
- package/runtime/components/MemberSignature/index.module.js +9 -6
- package/runtime/components/ParametersTable/{index_module.css → index.css} +19 -20
- package/runtime/components/ParametersTable/index.js +36 -67
- package/runtime/components/ParametersTable/index.module.js +9 -6
- package/runtime/components/SignatureBlock/{index_module.css → index.css} +5 -6
- package/runtime/components/SignatureBlock/index.js +30 -29
- package/runtime/components/SignatureBlock/index.module.js +9 -6
- package/runtime/components/SignatureCode/{index_module.css → index.css} +9 -10
- package/runtime/components/SignatureCode/index.js +40 -32
- package/runtime/components/SignatureCode/index.module.js +9 -6
- package/runtime/components/SignatureToolbar/{index_module.css → index.css} +18 -20
- package/runtime/components/SignatureToolbar/index.js +48 -51
- package/runtime/components/SignatureToolbar/index.module.js +13 -10
- package/runtime/components/buttons/ButtonGroup.js +13 -6
- package/runtime/components/buttons/CopyCodeButton.js +40 -38
- package/runtime/components/buttons/WrapSignatureButton.js +20 -16
- package/runtime/components/buttons/{index_module.css → index.css} +5 -6
- package/runtime/components/buttons/index.module.js +8 -5
- package/runtime/components/icons/CheckIcon/index.js +20 -17
- package/runtime/components/icons/CopyIcon/index.js +20 -17
- package/runtime/components/icons/UnwrapIcon/index.js +22 -18
- package/runtime/components/icons/WrapIcon/index.js +20 -17
- package/runtime/components/shared/_twoslash.css +3 -10
- package/runtime/components/shared/variables.css +0 -3
- package/runtime/hooks/useWrapToggle.js +32 -9
- package/runtime/index.d.ts +513 -173
- package/runtime/index.js +11 -9
- package/runtime/utils/decode-hast.js +31 -16
- package/runtime/utils/hast-renderer.js +21 -7
- package/schemas/config.js +199 -0
- package/schemas/index.js +5 -0
- package/schemas/opengraph.js +26 -0
- package/schemas/performance.js +19 -0
- package/serve.js +133 -0
- package/services/ConfigService.js +7 -0
- package/services/PathDerivationService.js +7 -0
- package/services/SnapshotService.js +7 -0
- package/services/TypeRegistryService.js +7 -0
- package/shiki-transformer.js +758 -0
- package/tsconfig-parser.js +127 -0
- package/tsdoc-metadata.json +11 -11
- package/twoslash-patterns.js +87 -0
- package/twoslash-transformer.js +316 -0
- package/type-reference-extractor.js +201 -0
- package/typescript-config.js +168 -0
- package/vfs-registry.js +121 -0
- package/0~llms-program.js +0 -344
- package/runtime/components/ApiLlmsPackageActions/index.module.js +0 -2
package/index.d.ts
CHANGED
|
@@ -1,831 +1,901 @@
|
|
|
1
|
-
import { ApiItemKind } from
|
|
2
|
-
import
|
|
3
|
-
import { RspressPlugin } from
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
}
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
}
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
}
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
}
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
1
|
+
import { ApiItemKind, ApiModel } from "@microsoft/api-extractor-model";
|
|
2
|
+
import { Schema } from "effect";
|
|
3
|
+
import { RspressPlugin } from "@rspress/core";
|
|
4
|
+
|
|
5
|
+
//#region src/schemas/config.d.ts
|
|
6
|
+
declare const LogLevel: Schema.Literal<["none", "info", "verbose", "debug", "warn", "error"]>;
|
|
7
|
+
type LogLevel = Schema.Schema.Type<typeof LogLevel>;
|
|
8
|
+
declare const CategoryConfig: Schema.mutable<Schema.Struct<{
|
|
9
|
+
displayName: typeof Schema.String;
|
|
10
|
+
singularName: typeof Schema.String;
|
|
11
|
+
folderName: typeof Schema.String;
|
|
12
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
13
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
14
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
15
|
+
default: () => true;
|
|
16
|
+
}>;
|
|
17
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
18
|
+
default: () => true;
|
|
19
|
+
}>;
|
|
20
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
21
|
+
default: () => number[];
|
|
22
|
+
}>;
|
|
23
|
+
}>>;
|
|
24
|
+
/**
|
|
25
|
+
* Consumer-facing type uses Encoded (input shape with optional fields).
|
|
26
|
+
* Schema.decode fills in defaults at runtime.
|
|
27
|
+
*/
|
|
28
|
+
type CategoryConfig = Schema.Schema.Encoded<typeof CategoryConfig>;
|
|
29
|
+
declare const SourceConfig: Schema.mutable<Schema.Struct<{
|
|
30
|
+
url: typeof Schema.String;
|
|
31
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
32
|
+
}>>;
|
|
33
|
+
type SourceConfig = Schema.Schema.Type<typeof SourceConfig>;
|
|
34
|
+
/**
|
|
35
|
+
* Built-in default categories
|
|
36
|
+
*/
|
|
37
|
+
declare const DEFAULT_CATEGORIES: Record<string, CategoryConfig>;
|
|
38
|
+
declare const VersionConfig: Schema.mutable<Schema.Struct<{
|
|
39
|
+
model: Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>;
|
|
40
|
+
packageJson: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
41
|
+
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
42
|
+
displayName: typeof Schema.String;
|
|
43
|
+
singularName: typeof Schema.String;
|
|
44
|
+
folderName: typeof Schema.String;
|
|
45
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
46
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
47
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
48
|
+
default: () => true;
|
|
49
|
+
}>;
|
|
50
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
51
|
+
default: () => true;
|
|
52
|
+
}>;
|
|
53
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
54
|
+
default: () => number[];
|
|
55
|
+
}>;
|
|
56
|
+
}>>>>>;
|
|
57
|
+
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
58
|
+
url: typeof Schema.String;
|
|
59
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
60
|
+
}>>>;
|
|
61
|
+
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
62
|
+
name: typeof Schema.String;
|
|
63
|
+
version: typeof Schema.String;
|
|
64
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
65
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
66
|
+
}>>>>>;
|
|
67
|
+
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
68
|
+
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
69
|
+
default: () => false;
|
|
70
|
+
}>;
|
|
71
|
+
devDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
72
|
+
default: () => false;
|
|
73
|
+
}>;
|
|
74
|
+
peerDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
75
|
+
default: () => true;
|
|
76
|
+
}>;
|
|
77
|
+
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
78
|
+
default: () => true;
|
|
79
|
+
}>;
|
|
80
|
+
}>>>;
|
|
81
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
82
|
+
url: typeof Schema.String;
|
|
83
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
84
|
+
type: Schema.optional<typeof Schema.String>;
|
|
85
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
86
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
87
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
88
|
+
}>>]>>;
|
|
89
|
+
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
90
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
91
|
+
default: () => true;
|
|
92
|
+
}>;
|
|
93
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
94
|
+
default: () => true;
|
|
95
|
+
}>;
|
|
96
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
97
|
+
default: () => true;
|
|
98
|
+
}>;
|
|
99
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
100
|
+
default: () => true;
|
|
101
|
+
}>;
|
|
102
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
103
|
+
default: () => true;
|
|
104
|
+
}>;
|
|
105
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
106
|
+
default: () => string;
|
|
107
|
+
}>;
|
|
108
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
109
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
110
|
+
}>;
|
|
111
|
+
}>>>;
|
|
112
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
113
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
114
|
+
}>>;
|
|
115
|
+
type VersionConfig = Schema.Schema.Type<typeof VersionConfig>;
|
|
116
|
+
declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
117
|
+
packageName: typeof Schema.String;
|
|
118
|
+
name: Schema.optional<typeof Schema.String>;
|
|
119
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
120
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
121
|
+
model: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
122
|
+
packageJson: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
123
|
+
versions: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.Union<[Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>, Schema.mutable<Schema.Struct<{
|
|
124
|
+
model: Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>;
|
|
125
|
+
packageJson: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
126
|
+
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
127
|
+
displayName: typeof Schema.String;
|
|
128
|
+
singularName: typeof Schema.String;
|
|
129
|
+
folderName: typeof Schema.String;
|
|
130
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
131
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
132
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
133
|
+
default: () => true;
|
|
134
|
+
}>;
|
|
135
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
136
|
+
default: () => true;
|
|
137
|
+
}>;
|
|
138
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
139
|
+
default: () => number[];
|
|
140
|
+
}>;
|
|
141
|
+
}>>>>>;
|
|
142
|
+
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
143
|
+
url: typeof Schema.String;
|
|
144
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
145
|
+
}>>>;
|
|
146
|
+
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
147
|
+
name: typeof Schema.String;
|
|
148
|
+
version: typeof Schema.String;
|
|
149
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
150
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
151
|
+
}>>>>>;
|
|
152
|
+
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
153
|
+
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
154
|
+
default: () => false;
|
|
155
|
+
}>;
|
|
156
|
+
devDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
157
|
+
default: () => false;
|
|
158
|
+
}>;
|
|
159
|
+
peerDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
160
|
+
default: () => true;
|
|
161
|
+
}>;
|
|
162
|
+
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
163
|
+
default: () => true;
|
|
164
|
+
}>;
|
|
165
|
+
}>>>;
|
|
166
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
167
|
+
url: typeof Schema.String;
|
|
168
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
169
|
+
type: Schema.optional<typeof Schema.String>;
|
|
170
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
171
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
172
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
173
|
+
}>>]>>;
|
|
174
|
+
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
175
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
176
|
+
default: () => true;
|
|
177
|
+
}>;
|
|
178
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
179
|
+
default: () => true;
|
|
180
|
+
}>;
|
|
181
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
182
|
+
default: () => true;
|
|
183
|
+
}>;
|
|
184
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
185
|
+
default: () => true;
|
|
186
|
+
}>;
|
|
187
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
188
|
+
default: () => true;
|
|
189
|
+
}>;
|
|
190
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
191
|
+
default: () => string;
|
|
192
|
+
}>;
|
|
193
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
194
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
195
|
+
}>;
|
|
196
|
+
}>>>;
|
|
197
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
198
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
199
|
+
}>>]>>>>;
|
|
200
|
+
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
201
|
+
light: typeof Schema.String;
|
|
202
|
+
dark: typeof Schema.String;
|
|
203
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
204
|
+
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
205
|
+
displayName: typeof Schema.String;
|
|
206
|
+
singularName: typeof Schema.String;
|
|
207
|
+
folderName: typeof Schema.String;
|
|
208
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
209
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
210
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
211
|
+
default: () => true;
|
|
212
|
+
}>;
|
|
213
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
214
|
+
default: () => true;
|
|
215
|
+
}>;
|
|
216
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
217
|
+
default: () => number[];
|
|
218
|
+
}>;
|
|
219
|
+
}>>>>>;
|
|
220
|
+
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
221
|
+
url: typeof Schema.String;
|
|
222
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
223
|
+
}>>>;
|
|
224
|
+
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
225
|
+
name: typeof Schema.String;
|
|
226
|
+
version: typeof Schema.String;
|
|
227
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
228
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
229
|
+
}>>>>>;
|
|
230
|
+
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
231
|
+
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
232
|
+
default: () => false;
|
|
233
|
+
}>;
|
|
234
|
+
devDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
235
|
+
default: () => false;
|
|
236
|
+
}>;
|
|
237
|
+
peerDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
238
|
+
default: () => true;
|
|
239
|
+
}>;
|
|
240
|
+
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
241
|
+
default: () => true;
|
|
242
|
+
}>;
|
|
243
|
+
}>>>;
|
|
244
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
245
|
+
url: typeof Schema.String;
|
|
246
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
247
|
+
type: Schema.optional<typeof Schema.String>;
|
|
248
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
249
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
250
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
251
|
+
}>>]>>;
|
|
252
|
+
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
253
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
254
|
+
default: () => true;
|
|
255
|
+
}>;
|
|
256
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
257
|
+
default: () => true;
|
|
258
|
+
}>;
|
|
259
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
260
|
+
default: () => true;
|
|
261
|
+
}>;
|
|
262
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
263
|
+
default: () => true;
|
|
264
|
+
}>;
|
|
265
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
266
|
+
default: () => true;
|
|
267
|
+
}>;
|
|
268
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
269
|
+
default: () => string;
|
|
270
|
+
}>;
|
|
271
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
272
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
273
|
+
}>;
|
|
274
|
+
}>>>;
|
|
275
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
276
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
277
|
+
}>>;
|
|
278
|
+
type SingleApiConfig = Schema.Schema.Type<typeof SingleApiConfig>;
|
|
279
|
+
declare const MultiApiConfig: Schema.mutable<Schema.Struct<{
|
|
280
|
+
packageName: typeof Schema.String;
|
|
281
|
+
name: Schema.optional<typeof Schema.String>;
|
|
282
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
283
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
284
|
+
model: Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>;
|
|
285
|
+
packageJson: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
286
|
+
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
287
|
+
light: typeof Schema.String;
|
|
288
|
+
dark: typeof Schema.String;
|
|
289
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
290
|
+
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
291
|
+
displayName: typeof Schema.String;
|
|
292
|
+
singularName: typeof Schema.String;
|
|
293
|
+
folderName: typeof Schema.String;
|
|
294
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
295
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
296
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
297
|
+
default: () => true;
|
|
298
|
+
}>;
|
|
299
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
300
|
+
default: () => true;
|
|
301
|
+
}>;
|
|
302
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
303
|
+
default: () => number[];
|
|
304
|
+
}>;
|
|
305
|
+
}>>>>>;
|
|
306
|
+
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
307
|
+
url: typeof Schema.String;
|
|
308
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
309
|
+
}>>>;
|
|
310
|
+
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
311
|
+
name: typeof Schema.String;
|
|
312
|
+
version: typeof Schema.String;
|
|
313
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
314
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
315
|
+
}>>>>>;
|
|
316
|
+
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
317
|
+
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
318
|
+
default: () => false;
|
|
319
|
+
}>;
|
|
320
|
+
devDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
321
|
+
default: () => false;
|
|
322
|
+
}>;
|
|
323
|
+
peerDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
324
|
+
default: () => true;
|
|
325
|
+
}>;
|
|
326
|
+
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
327
|
+
default: () => true;
|
|
328
|
+
}>;
|
|
329
|
+
}>>>;
|
|
330
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
331
|
+
url: typeof Schema.String;
|
|
332
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
333
|
+
type: Schema.optional<typeof Schema.String>;
|
|
334
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
335
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
336
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
337
|
+
}>>]>>;
|
|
338
|
+
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
339
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
340
|
+
default: () => true;
|
|
341
|
+
}>;
|
|
342
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
343
|
+
default: () => true;
|
|
344
|
+
}>;
|
|
345
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
346
|
+
default: () => true;
|
|
347
|
+
}>;
|
|
348
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
349
|
+
default: () => true;
|
|
350
|
+
}>;
|
|
351
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
352
|
+
default: () => true;
|
|
353
|
+
}>;
|
|
354
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
355
|
+
default: () => string;
|
|
356
|
+
}>;
|
|
357
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
358
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
359
|
+
}>;
|
|
360
|
+
}>>>;
|
|
361
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
362
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
363
|
+
}>>;
|
|
364
|
+
type MultiApiConfig = Schema.Schema.Type<typeof MultiApiConfig>;
|
|
365
|
+
declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
366
|
+
api: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
367
|
+
packageName: typeof Schema.String;
|
|
368
|
+
name: Schema.optional<typeof Schema.String>;
|
|
369
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
370
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
371
|
+
model: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
372
|
+
packageJson: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
373
|
+
versions: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.Union<[Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>, Schema.mutable<Schema.Struct<{
|
|
374
|
+
model: Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>;
|
|
375
|
+
packageJson: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
376
|
+
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
377
|
+
displayName: typeof Schema.String;
|
|
378
|
+
singularName: typeof Schema.String;
|
|
379
|
+
folderName: typeof Schema.String;
|
|
380
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
381
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
382
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
383
|
+
default: () => true;
|
|
384
|
+
}>;
|
|
385
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
386
|
+
default: () => true;
|
|
387
|
+
}>;
|
|
388
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
389
|
+
default: () => number[];
|
|
390
|
+
}>;
|
|
391
|
+
}>>>>>;
|
|
392
|
+
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
393
|
+
url: typeof Schema.String;
|
|
394
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
395
|
+
}>>>;
|
|
396
|
+
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
397
|
+
name: typeof Schema.String;
|
|
398
|
+
version: typeof Schema.String;
|
|
399
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
400
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
401
|
+
}>>>>>;
|
|
402
|
+
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
403
|
+
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
404
|
+
default: () => false;
|
|
405
|
+
}>;
|
|
406
|
+
devDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
407
|
+
default: () => false;
|
|
408
|
+
}>;
|
|
409
|
+
peerDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
410
|
+
default: () => true;
|
|
411
|
+
}>;
|
|
412
|
+
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
413
|
+
default: () => true;
|
|
414
|
+
}>;
|
|
415
|
+
}>>>;
|
|
416
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
417
|
+
url: typeof Schema.String;
|
|
418
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
419
|
+
type: Schema.optional<typeof Schema.String>;
|
|
420
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
421
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
422
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
423
|
+
}>>]>>;
|
|
424
|
+
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
425
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
426
|
+
default: () => true;
|
|
427
|
+
}>;
|
|
428
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
429
|
+
default: () => true;
|
|
430
|
+
}>;
|
|
431
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
432
|
+
default: () => true;
|
|
433
|
+
}>;
|
|
434
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
435
|
+
default: () => true;
|
|
436
|
+
}>;
|
|
437
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
438
|
+
default: () => true;
|
|
439
|
+
}>;
|
|
440
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
441
|
+
default: () => string;
|
|
442
|
+
}>;
|
|
443
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
444
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
445
|
+
}>;
|
|
446
|
+
}>>>;
|
|
447
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
448
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
449
|
+
}>>]>>>>;
|
|
450
|
+
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
451
|
+
light: typeof Schema.String;
|
|
452
|
+
dark: typeof Schema.String;
|
|
453
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
454
|
+
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
455
|
+
displayName: typeof Schema.String;
|
|
456
|
+
singularName: typeof Schema.String;
|
|
457
|
+
folderName: typeof Schema.String;
|
|
458
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
459
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
460
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
461
|
+
default: () => true;
|
|
462
|
+
}>;
|
|
463
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
464
|
+
default: () => true;
|
|
465
|
+
}>;
|
|
466
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
467
|
+
default: () => number[];
|
|
468
|
+
}>;
|
|
469
|
+
}>>>>>;
|
|
470
|
+
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
471
|
+
url: typeof Schema.String;
|
|
472
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
473
|
+
}>>>;
|
|
474
|
+
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
475
|
+
name: typeof Schema.String;
|
|
476
|
+
version: typeof Schema.String;
|
|
477
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
478
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
479
|
+
}>>>>>;
|
|
480
|
+
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
481
|
+
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
482
|
+
default: () => false;
|
|
483
|
+
}>;
|
|
484
|
+
devDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
485
|
+
default: () => false;
|
|
486
|
+
}>;
|
|
487
|
+
peerDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
488
|
+
default: () => true;
|
|
489
|
+
}>;
|
|
490
|
+
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
491
|
+
default: () => true;
|
|
492
|
+
}>;
|
|
493
|
+
}>>>;
|
|
494
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
495
|
+
url: typeof Schema.String;
|
|
496
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
497
|
+
type: Schema.optional<typeof Schema.String>;
|
|
498
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
499
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
500
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
501
|
+
}>>]>>;
|
|
502
|
+
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
503
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
504
|
+
default: () => true;
|
|
505
|
+
}>;
|
|
506
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
507
|
+
default: () => true;
|
|
508
|
+
}>;
|
|
509
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
510
|
+
default: () => true;
|
|
511
|
+
}>;
|
|
512
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
513
|
+
default: () => true;
|
|
514
|
+
}>;
|
|
515
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
516
|
+
default: () => true;
|
|
517
|
+
}>;
|
|
518
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
519
|
+
default: () => string;
|
|
520
|
+
}>;
|
|
521
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
522
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
523
|
+
}>;
|
|
524
|
+
}>>>;
|
|
525
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
526
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
527
|
+
}>>>;
|
|
528
|
+
apis: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
529
|
+
packageName: typeof Schema.String;
|
|
530
|
+
name: Schema.optional<typeof Schema.String>;
|
|
531
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
532
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
533
|
+
model: Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>;
|
|
534
|
+
packageJson: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
535
|
+
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
536
|
+
light: typeof Schema.String;
|
|
537
|
+
dark: typeof Schema.String;
|
|
538
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
539
|
+
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
540
|
+
displayName: typeof Schema.String;
|
|
541
|
+
singularName: typeof Schema.String;
|
|
542
|
+
folderName: typeof Schema.String;
|
|
543
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
544
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
545
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
546
|
+
default: () => true;
|
|
547
|
+
}>;
|
|
548
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
549
|
+
default: () => true;
|
|
550
|
+
}>;
|
|
551
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
552
|
+
default: () => number[];
|
|
553
|
+
}>;
|
|
554
|
+
}>>>>>;
|
|
555
|
+
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
556
|
+
url: typeof Schema.String;
|
|
557
|
+
ref: Schema.optional<typeof Schema.String>;
|
|
558
|
+
}>>>;
|
|
559
|
+
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
560
|
+
name: typeof Schema.String;
|
|
561
|
+
version: typeof Schema.String;
|
|
562
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
563
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
564
|
+
}>>>>>;
|
|
565
|
+
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
566
|
+
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
567
|
+
default: () => false;
|
|
568
|
+
}>;
|
|
569
|
+
devDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
570
|
+
default: () => false;
|
|
571
|
+
}>;
|
|
572
|
+
peerDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
573
|
+
default: () => true;
|
|
574
|
+
}>;
|
|
575
|
+
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
576
|
+
default: () => true;
|
|
577
|
+
}>;
|
|
578
|
+
}>>>;
|
|
579
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
580
|
+
url: typeof Schema.String;
|
|
581
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
582
|
+
type: Schema.optional<typeof Schema.String>;
|
|
583
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
584
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
585
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
586
|
+
}>>]>>;
|
|
587
|
+
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
588
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
589
|
+
default: () => true;
|
|
590
|
+
}>;
|
|
591
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
592
|
+
default: () => true;
|
|
593
|
+
}>;
|
|
594
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
595
|
+
default: () => true;
|
|
596
|
+
}>;
|
|
597
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
598
|
+
default: () => true;
|
|
599
|
+
}>;
|
|
600
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
601
|
+
default: () => true;
|
|
602
|
+
}>;
|
|
603
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
604
|
+
default: () => string;
|
|
605
|
+
}>;
|
|
606
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
607
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
608
|
+
}>;
|
|
609
|
+
}>>>;
|
|
610
|
+
tsconfig: Schema.optional<Schema.declare<string | ((...args: Array<unknown>) => unknown) | URL, string | ((...args: Array<unknown>) => unknown) | URL, readonly [], never>>;
|
|
611
|
+
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
612
|
+
}>>>>>;
|
|
613
|
+
siteUrl: Schema.optional<typeof Schema.String>;
|
|
614
|
+
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
615
|
+
url: typeof Schema.String;
|
|
616
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
617
|
+
type: Schema.optional<typeof Schema.String>;
|
|
618
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
619
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
620
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
621
|
+
}>>]>>;
|
|
622
|
+
defaultCategories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
623
|
+
displayName: typeof Schema.String;
|
|
624
|
+
singularName: typeof Schema.String;
|
|
625
|
+
folderName: typeof Schema.String;
|
|
626
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
627
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
628
|
+
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
629
|
+
default: () => true;
|
|
630
|
+
}>;
|
|
631
|
+
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
632
|
+
default: () => true;
|
|
633
|
+
}>;
|
|
634
|
+
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
635
|
+
default: () => number[];
|
|
636
|
+
}>;
|
|
637
|
+
}>>>>>;
|
|
638
|
+
errors: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
639
|
+
example: Schema.optional<Schema.Literal<["suppress", "show"]>>;
|
|
640
|
+
}>>>;
|
|
641
|
+
llmsPlugin: Schema.optional<Schema.Union<[typeof Schema.Boolean, Schema.mutable<Schema.Struct<{
|
|
642
|
+
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
643
|
+
default: () => true;
|
|
644
|
+
}>;
|
|
645
|
+
scopes: Schema.optionalWith<typeof Schema.Boolean, {
|
|
646
|
+
default: () => true;
|
|
647
|
+
}>;
|
|
648
|
+
apiTxt: Schema.optionalWith<typeof Schema.Boolean, {
|
|
649
|
+
default: () => true;
|
|
650
|
+
}>;
|
|
651
|
+
showCopyButton: Schema.optionalWith<typeof Schema.Boolean, {
|
|
652
|
+
default: () => true;
|
|
653
|
+
}>;
|
|
654
|
+
showViewOptions: Schema.optionalWith<typeof Schema.Boolean, {
|
|
655
|
+
default: () => true;
|
|
656
|
+
}>;
|
|
657
|
+
copyButtonText: Schema.optionalWith<typeof Schema.String, {
|
|
658
|
+
default: () => string;
|
|
659
|
+
}>;
|
|
660
|
+
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
661
|
+
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
662
|
+
}>;
|
|
663
|
+
}>>]>>;
|
|
664
|
+
logLevel: Schema.optional<Schema.Literal<["none", "info", "verbose", "debug", "warn", "error"]>>;
|
|
665
|
+
performance: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
666
|
+
thresholds: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
667
|
+
slowCodeBlock: Schema.optionalWith<typeof Schema.Number, {
|
|
668
|
+
default: () => number;
|
|
669
|
+
}>;
|
|
670
|
+
slowPageGeneration: Schema.optionalWith<typeof Schema.Number, {
|
|
671
|
+
default: () => number;
|
|
672
|
+
}>;
|
|
673
|
+
slowApiLoad: Schema.optionalWith<typeof Schema.Number, {
|
|
674
|
+
default: () => number;
|
|
675
|
+
}>;
|
|
676
|
+
slowFileOperation: Schema.optionalWith<typeof Schema.Number, {
|
|
677
|
+
default: () => number;
|
|
678
|
+
}>;
|
|
679
|
+
slowHttpRequest: Schema.optionalWith<typeof Schema.Number, {
|
|
680
|
+
default: () => number;
|
|
681
|
+
}>;
|
|
682
|
+
slowDbOperation: Schema.optionalWith<typeof Schema.Number, {
|
|
683
|
+
default: () => number;
|
|
684
|
+
}>;
|
|
685
|
+
}>>>;
|
|
686
|
+
showInsights: Schema.optionalWith<typeof Schema.Boolean, {
|
|
687
|
+
default: () => true;
|
|
688
|
+
}>;
|
|
689
|
+
trackDetailedMetrics: Schema.optionalWith<typeof Schema.Boolean, {
|
|
690
|
+
default: () => false;
|
|
691
|
+
}>;
|
|
692
|
+
}>>>;
|
|
693
|
+
}>>;
|
|
694
|
+
type PluginOptions = Schema.Schema.Type<typeof PluginOptions>;
|
|
695
|
+
//#endregion
|
|
696
|
+
//#region src/schemas/opengraph.d.ts
|
|
697
|
+
declare const OpenGraphImageMetadata: Schema.mutable<Schema.Struct<{
|
|
698
|
+
url: typeof Schema.String;
|
|
699
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
700
|
+
type: Schema.optional<typeof Schema.String>;
|
|
701
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
702
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
703
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
704
|
+
}>>;
|
|
705
|
+
type OpenGraphImageMetadata = Schema.Schema.Type<typeof OpenGraphImageMetadata>;
|
|
706
|
+
declare const OpenGraphImageConfig: Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
707
|
+
url: typeof Schema.String;
|
|
708
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
709
|
+
type: Schema.optional<typeof Schema.String>;
|
|
710
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
711
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
712
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
713
|
+
}>>]>;
|
|
714
|
+
type OpenGraphImageConfig = Schema.Schema.Type<typeof OpenGraphImageConfig>;
|
|
715
|
+
declare const OpenGraphMetadata: Schema.mutable<Schema.Struct<{
|
|
716
|
+
siteUrl: typeof Schema.String;
|
|
717
|
+
pageRoute: typeof Schema.String;
|
|
718
|
+
description: typeof Schema.String;
|
|
719
|
+
publishedTime: typeof Schema.String;
|
|
720
|
+
modifiedTime: typeof Schema.String;
|
|
721
|
+
section: typeof Schema.String;
|
|
722
|
+
tags: Schema.mutable<Schema.Array$<typeof Schema.String>>;
|
|
723
|
+
ogImage: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
724
|
+
url: typeof Schema.String;
|
|
725
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
726
|
+
type: Schema.optional<typeof Schema.String>;
|
|
727
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
728
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
729
|
+
alt: Schema.optional<typeof Schema.String>;
|
|
730
|
+
}>>>;
|
|
731
|
+
ogType: typeof Schema.String;
|
|
732
|
+
}>>;
|
|
733
|
+
type OpenGraphMetadata = Schema.Schema.Type<typeof OpenGraphMetadata>;
|
|
734
|
+
//#endregion
|
|
735
|
+
//#region src/config-helpers.d.ts
|
|
736
|
+
/** Metadata discovered from a single rslib-builder localPaths package folder. */
|
|
737
|
+
interface DirInfo {
|
|
738
|
+
/** Absolute path to the package folder. */
|
|
739
|
+
dir: string;
|
|
740
|
+
/** Last path segment of `dir`, e.g. "sdk". */
|
|
741
|
+
dirname: string;
|
|
742
|
+
/** package.json "name", e.g. "vitest-agent-sdk" or "\@scope/pkg". */
|
|
743
|
+
packageName: string;
|
|
744
|
+
/** package.json "version" (empty string if absent). */
|
|
745
|
+
version: string;
|
|
746
|
+
/** Absolute path to the resolved *.api.json model. */
|
|
747
|
+
modelPath: string;
|
|
748
|
+
}
|
|
749
|
+
/**
|
|
750
|
+
* How to derive an API's `baseRoute`. One of:
|
|
751
|
+
*
|
|
752
|
+
* - omitted — leaves `baseRoute` unset so the plugin applies its own
|
|
753
|
+
* context-aware default: the API folder root (`/api`) under the single-API
|
|
754
|
+
* `api:` option, or `/{packageName}/api` under the multi-API `apis:` option.
|
|
755
|
+
* - a template string — supports the `{dirname}` and `{packageName}` tokens,
|
|
756
|
+
* e.g. `"reference/{dirname}"`. A leading slash is normalized in.
|
|
757
|
+
* - a callback — `(info) => string` for full control.
|
|
758
|
+
*
|
|
759
|
+
* Note: the `{packageName}` token is interpolated verbatim, so for a scoped
|
|
760
|
+
* package it yields the scope too (e.g. `@scope/bar`), which is rarely what you
|
|
761
|
+
* want inside a URL path. Prefer `{dirname}` (the folder name, which is the
|
|
762
|
+
* unscoped name in the rslib-builder layout) or the callback form.
|
|
763
|
+
*/
|
|
764
|
+
type BaseRoute = string | ((info: DirInfo) => string);
|
|
765
|
+
/** Overrides for `api.fromDir`. Any MultiApiConfig field wins over discovery. */
|
|
766
|
+
type FromDirOptions = Omit<Partial<MultiApiConfig>, "baseRoute"> & {
|
|
767
|
+
baseRoute?: BaseRoute; /** Base for resolving a relative `dir`. Defaults to process.cwd(). */
|
|
768
|
+
cwd?: string;
|
|
769
|
+
};
|
|
770
|
+
/**
|
|
771
|
+
* Build a `MultiApiConfig` by discovering fields from a single package folder
|
|
772
|
+
* produced by `@savvy-web/rslib-builder`'s `localPaths` option. Exposed as
|
|
773
|
+
* `ApiExtractorPlugin.api.fromDir`; the returned config can be passed to the
|
|
774
|
+
* single-API `api:` option or used as an element of the multi-API `apis:` array.
|
|
775
|
+
*
|
|
776
|
+
* `baseRoute` is intentionally left unset unless overridden, so the plugin
|
|
777
|
+
* applies its own context-aware default (`/api` under `api:`,
|
|
778
|
+
* `/{packageName}/api` under `apis:`). See {@link BaseRoute}.
|
|
779
|
+
*/
|
|
780
|
+
declare function fromDir(dir: string, overrides?: FromDirOptions): MultiApiConfig;
|
|
781
|
+
/**
|
|
782
|
+
* Strictly scan a parent directory of package folders and build one
|
|
783
|
+
* `MultiApiConfig` per subfolder. Exposed as `ApiExtractorPlugin.apis.fromDir`;
|
|
784
|
+
* the returned array is intended for the multi-API `apis:` option. Every
|
|
785
|
+
* non-dotfile subdirectory MUST be a valid model folder. `options` (minus
|
|
786
|
+
* `cwd`) is applied as shared defaults to each `api.fromDir` call.
|
|
787
|
+
*/
|
|
788
|
+
declare function fromParentDir(parentDir: string, options?: FromDirOptions): MultiApiConfig[];
|
|
789
|
+
//#endregion
|
|
790
|
+
//#region src/internal-types.d.ts
|
|
791
|
+
/**
|
|
792
|
+
* Result from a model loader function
|
|
793
|
+
*/
|
|
794
|
+
interface LoadedModel {
|
|
795
|
+
/** The API model */
|
|
796
|
+
model: ApiModel;
|
|
797
|
+
/** Optional source config returned by the loader */
|
|
798
|
+
source?: SourceConfig;
|
|
799
|
+
}
|
|
800
|
+
//#endregion
|
|
801
|
+
//#region src/plugin.d.ts
|
|
802
|
+
/**
|
|
803
|
+
* RSPress plugin for generating API documentation from API Extractor model files
|
|
804
|
+
*/
|
|
805
|
+
declare function ApiExtractorPluginImpl(rawOptions: PluginOptions): RspressPlugin;
|
|
806
|
+
/**
|
|
807
|
+
* RSPress plugin for generating API documentation from API Extractor model
|
|
808
|
+
* files. Config helpers are available under `ApiExtractorPlugin.api` (single
|
|
809
|
+
* package → one config for the `api:` option) and `ApiExtractorPlugin.apis`
|
|
810
|
+
* (parent directory → array for the `apis:` option).
|
|
811
|
+
*/
|
|
812
|
+
declare const ApiExtractorPlugin: typeof ApiExtractorPluginImpl & {
|
|
813
|
+
api: {
|
|
814
|
+
fromDir: typeof fromDir;
|
|
815
|
+
};
|
|
816
|
+
apis: {
|
|
817
|
+
fromDir: typeof fromParentDir;
|
|
818
|
+
};
|
|
819
|
+
};
|
|
820
|
+
//#endregion
|
|
821
|
+
//#region src/serve.d.ts
|
|
822
|
+
/** Which RSPress server `serve` runs. */
|
|
823
|
+
type ServeMode = "dev" | "preview";
|
|
824
|
+
/** Options for {@link serve}. All fields are optional with sensible defaults. */
|
|
825
|
+
interface ServeOptions {
|
|
826
|
+
/** Which RSPress server to run. Defaults to `"dev"`. */
|
|
827
|
+
mode?: ServeMode;
|
|
828
|
+
/**
|
|
829
|
+
* Port to serve on. Defaults to `process.env.DEV_PORT` (dev mode only) or
|
|
830
|
+
* `4173`. Preview mode ignores `DEV_PORT` unless `port` is passed explicitly.
|
|
831
|
+
*/
|
|
832
|
+
port?: number;
|
|
833
|
+
/**
|
|
834
|
+
* Open a browser once the server is ready. Defaults to `true`, unless the
|
|
835
|
+
* `NO_OPEN` environment variable is set. Browser opening is best-effort.
|
|
836
|
+
*/
|
|
837
|
+
open?: boolean;
|
|
838
|
+
/** Path to open in the browser, relative to the server root. Defaults to `"/"`. */
|
|
839
|
+
openPath?: string;
|
|
840
|
+
/** Package manager used to invoke the `rspress` CLI. Defaults to `"pnpm"`. */
|
|
841
|
+
packageManager?: string;
|
|
842
|
+
/** Working directory for the server process. Defaults to `process.cwd()`. */
|
|
843
|
+
cwd?: string;
|
|
844
|
+
/**
|
|
845
|
+
* Predicate over combined stdout/stderr deciding when the server is "ready"
|
|
846
|
+
* (and the browser should open). Defaults to a mode-specific heuristic — see
|
|
847
|
+
* {@link isServerReady}.
|
|
848
|
+
*/
|
|
849
|
+
readyWhen?: (output: string) => boolean;
|
|
850
|
+
}
|
|
851
|
+
/** Fully resolved {@link ServeOptions} with defaults applied. */
|
|
852
|
+
interface ResolvedServeConfig {
|
|
853
|
+
mode: ServeMode;
|
|
854
|
+
port: number;
|
|
855
|
+
open: boolean;
|
|
856
|
+
openPath: string;
|
|
857
|
+
packageManager: string;
|
|
858
|
+
cwd: string;
|
|
859
|
+
/** Arguments passed to the package manager, e.g. `["rspress", "dev", "--port", "4173"]`. */
|
|
860
|
+
args: string[];
|
|
861
|
+
/** The fully-qualified URL to open in the browser. */
|
|
862
|
+
url: string;
|
|
863
|
+
/** Resolved readiness predicate. */
|
|
864
|
+
isReady: (output: string) => boolean;
|
|
865
|
+
}
|
|
866
|
+
/**
|
|
867
|
+
* Readiness heuristic over a chunk of server output. Both RSPress `dev` and
|
|
868
|
+
* `preview` print a `Local:` address line once the server is listening, which
|
|
869
|
+
* is the reliable cross-mode signal. `dev` additionally prints a
|
|
870
|
+
* "ready ... built in" line, kept as a fallback in case the address-line format
|
|
871
|
+
* changes. Pure and exported so it can be unit-tested and reused as a
|
|
872
|
+
* {@link ServeOptions.readyWhen} building block.
|
|
873
|
+
*/
|
|
874
|
+
declare function isServerReady(mode: ServeMode, output: string): boolean;
|
|
875
|
+
/**
|
|
876
|
+
* Resolve {@link ServeOptions} into a concrete {@link ResolvedServeConfig},
|
|
877
|
+
* applying all defaults. Pure (modulo reading `process.env`) and exported so
|
|
878
|
+
* the resolution logic can be unit-tested without spawning a server.
|
|
879
|
+
*/
|
|
880
|
+
declare function resolveServeConfig(options?: ServeOptions): ResolvedServeConfig;
|
|
881
|
+
/**
|
|
882
|
+
* Run an RSPress `dev` or `preview` server, freeing the port first and opening a
|
|
883
|
+
* browser once the server is ready. A drop-in replacement for the per-site
|
|
884
|
+
* `dev.mts` / `preview.mts` scripts:
|
|
885
|
+
*
|
|
886
|
+
* ```ts
|
|
887
|
+
* import { serve } from "rspress-plugin-api-extractor";
|
|
888
|
+
*
|
|
889
|
+
* await serve({ mode: "dev", openPath: "/api/" });
|
|
890
|
+
* ```
|
|
891
|
+
*
|
|
892
|
+
* This runs the server for the lifetime of the host process and calls
|
|
893
|
+
* `process.exit` when the server exits (matching a top-level script runner). The
|
|
894
|
+
* returned promise resolves once the server is ready and the browser has been
|
|
895
|
+
* opened; it does not resolve when the server stops. Port-freeing and browser
|
|
896
|
+
* opening are best-effort and never reject.
|
|
897
|
+
*/
|
|
898
|
+
declare function serve(options?: ServeOptions): Promise<void>;
|
|
899
|
+
//#endregion
|
|
900
|
+
export { ApiExtractorPlugin, type PluginOptions as ApiExtractorPluginOptions, type BaseRoute, type CategoryConfig, DEFAULT_CATEGORIES, type DirInfo, type FromDirOptions, type LoadedModel, type LogLevel, type MultiApiConfig, type OpenGraphImageConfig, type OpenGraphImageMetadata, type OpenGraphMetadata, type ResolvedServeConfig, type ServeMode, type ServeOptions, type SingleApiConfig, type SourceConfig, type VersionConfig, isServerReady, resolveServeConfig, serve };
|
|
901
|
+
//# sourceMappingURL=index.d.ts.map
|