@mintlify/validation 0.1.38 → 0.1.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 (55) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +55 -55
  3. package/dist/index.d.ts +11 -6
  4. package/dist/index.js +1 -1
  5. package/dist/mint-config/common.d.ts +6 -6
  6. package/dist/mint-config/flattenUnionErrorMessages.d.ts +7 -7
  7. package/dist/mint-config/hexadecimalPattern.d.ts +1 -1
  8. package/dist/mint-config/schemas/analytics.d.ts +171 -171
  9. package/dist/mint-config/schemas/anchorColors.d.ts +14 -14
  10. package/dist/mint-config/schemas/anchors.d.ts +46 -46
  11. package/dist/mint-config/schemas/colors.d.ts +61 -61
  12. package/dist/mint-config/schemas/config.d.ts +816 -798
  13. package/dist/mint-config/schemas/favicon.d.ts +2 -2
  14. package/dist/mint-config/schemas/name.d.ts +2 -2
  15. package/dist/mint-config/schemas/navigation.d.ts +3 -3
  16. package/dist/mint-config/schemas/tabs.d.ts +11 -11
  17. package/dist/mint-config/schemas/versions.d.ts +11 -11
  18. package/dist/mint-config/types/analytics.d.ts +3 -3
  19. package/dist/mint-config/types/anchors.d.ts +4 -3
  20. package/dist/mint-config/types/colors.d.ts +3 -3
  21. package/dist/mint-config/types/config.d.ts +3 -3
  22. package/dist/mint-config/types/navigation.d.ts +6 -6
  23. package/dist/mint-config/types/versions.d.ts +3 -3
  24. package/dist/mint-config/validateAnchorsWarnings.d.ts +4 -4
  25. package/dist/mint-config/validateVersionsInNavigation.d.ts +5 -5
  26. package/dist/openapi/convertOpenApi.d.ts +18 -17
  27. package/dist/openapi/convertParameters.d.ts +9 -8
  28. package/dist/openapi/convertSchema.d.ts +11 -11
  29. package/dist/openapi/convertSecurity.d.ts +14 -13
  30. package/dist/openapi/convertServers.d.ts +8 -8
  31. package/dist/openapi/types/endpoint.d.ts +128 -128
  32. package/dist/schemas/analytics.d.ts +171 -0
  33. package/dist/schemas/anchorColors.d.ts +14 -0
  34. package/dist/schemas/anchors.d.ts +46 -0
  35. package/dist/schemas/colors.d.ts +61 -0
  36. package/dist/schemas/config.d.ts +798 -0
  37. package/dist/schemas/favicon.d.ts +2 -0
  38. package/dist/schemas/name.d.ts +2 -0
  39. package/dist/schemas/navigation.d.ts +3 -0
  40. package/dist/schemas/tabs.d.ts +11 -0
  41. package/dist/schemas/versions.d.ts +11 -0
  42. package/dist/types/analytics.d.ts +3 -0
  43. package/dist/types/anchors.d.ts +3 -0
  44. package/dist/types/colors.d.ts +3 -0
  45. package/dist/types/config.d.ts +3 -0
  46. package/dist/types/endpoint.d.ts +125 -0
  47. package/dist/types/navigation.d.ts +6 -0
  48. package/dist/types/versions.d.ts +3 -0
  49. package/dist/utils/common.d.ts +6 -0
  50. package/dist/utils/convertOpenApi.d.ts +43 -0
  51. package/dist/utils/flattenUnionErrorMessages.d.ts +7 -0
  52. package/dist/utils/hexadecimalPattern.d.ts +1 -0
  53. package/dist/utils/validateAnchorsWarnings.d.ts +4 -0
  54. package/dist/utils/validateVersionsInNavigation.d.ts +5 -0
  55. package/package.json +74 -72
@@ -0,0 +1,798 @@
1
+ import { z } from 'zod';
2
+ export declare const configSchema: z.ZodObject<{
3
+ $schema: z.ZodDefault<z.ZodOptional<z.ZodString>>;
4
+ mintlify: z.ZodOptional<z.ZodString>;
5
+ name: z.ZodString;
6
+ logo: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
7
+ light: z.ZodString;
8
+ dark: z.ZodString;
9
+ href: z.ZodOptional<z.ZodString>;
10
+ }, "strip", z.ZodTypeAny, {
11
+ light: string;
12
+ dark: string;
13
+ href?: string | undefined;
14
+ }, {
15
+ light: string;
16
+ dark: string;
17
+ href?: string | undefined;
18
+ }>]>>;
19
+ favicon: z.ZodEffects<z.ZodString, string, string>;
20
+ openapi: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
21
+ api: z.ZodOptional<z.ZodObject<{
22
+ baseUrl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
23
+ auth: z.ZodOptional<z.ZodObject<{
24
+ method: z.ZodOptional<z.ZodEnum<["bearer", "basic", "key"]>>;
25
+ name: z.ZodOptional<z.ZodString>;
26
+ inputPrefix: z.ZodOptional<z.ZodString>;
27
+ }, "strict", z.ZodTypeAny, {
28
+ method?: "bearer" | "basic" | "key" | undefined;
29
+ name?: string | undefined;
30
+ inputPrefix?: string | undefined;
31
+ }, {
32
+ method?: "bearer" | "basic" | "key" | undefined;
33
+ name?: string | undefined;
34
+ inputPrefix?: string | undefined;
35
+ }>>;
36
+ playground: z.ZodOptional<z.ZodObject<{
37
+ mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["show", "simple", "hide"]>>>;
38
+ }, "strip", z.ZodTypeAny, {
39
+ mode: "show" | "simple" | "hide";
40
+ }, {
41
+ mode?: "show" | "simple" | "hide" | undefined;
42
+ }>>;
43
+ request: z.ZodOptional<z.ZodObject<{
44
+ example: z.ZodOptional<z.ZodObject<{
45
+ showOptionalParams: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
46
+ }, "strip", z.ZodTypeAny, {
47
+ showOptionalParams: boolean;
48
+ }, {
49
+ showOptionalParams?: boolean | undefined;
50
+ }>>;
51
+ }, "strip", z.ZodTypeAny, {
52
+ example?: {
53
+ showOptionalParams: boolean;
54
+ } | undefined;
55
+ }, {
56
+ example?: {
57
+ showOptionalParams?: boolean | undefined;
58
+ } | undefined;
59
+ }>>;
60
+ maintainOrder: z.ZodOptional<z.ZodBoolean>;
61
+ }, "strict", z.ZodTypeAny, {
62
+ baseUrl?: string | string[] | undefined;
63
+ auth?: {
64
+ method?: "bearer" | "basic" | "key" | undefined;
65
+ name?: string | undefined;
66
+ inputPrefix?: string | undefined;
67
+ } | undefined;
68
+ playground?: {
69
+ mode: "show" | "simple" | "hide";
70
+ } | undefined;
71
+ request?: {
72
+ example?: {
73
+ showOptionalParams: boolean;
74
+ } | undefined;
75
+ } | undefined;
76
+ maintainOrder?: boolean | undefined;
77
+ }, {
78
+ baseUrl?: string | string[] | undefined;
79
+ auth?: {
80
+ method?: "bearer" | "basic" | "key" | undefined;
81
+ name?: string | undefined;
82
+ inputPrefix?: string | undefined;
83
+ } | undefined;
84
+ playground?: {
85
+ mode?: "show" | "simple" | "hide" | undefined;
86
+ } | undefined;
87
+ request?: {
88
+ example?: {
89
+ showOptionalParams?: boolean | undefined;
90
+ } | undefined;
91
+ } | undefined;
92
+ maintainOrder?: boolean | undefined;
93
+ }>>;
94
+ modeToggle: z.ZodOptional<z.ZodObject<{
95
+ default: z.ZodOptional<z.ZodEnum<["light", "dark"]>>;
96
+ isHidden: z.ZodOptional<z.ZodBoolean>;
97
+ }, "strip", z.ZodTypeAny, {
98
+ default?: "light" | "dark" | undefined;
99
+ isHidden?: boolean | undefined;
100
+ }, {
101
+ default?: "light" | "dark" | undefined;
102
+ isHidden?: boolean | undefined;
103
+ }>>;
104
+ versions: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodObject<{
105
+ name: z.ZodString;
106
+ url: z.ZodString;
107
+ }, "strict", z.ZodTypeAny, {
108
+ name: string;
109
+ url: string;
110
+ }, {
111
+ name: string;
112
+ url: string;
113
+ }>]>, "many">>;
114
+ metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
115
+ colors: z.ZodObject<{
116
+ primary: z.ZodString;
117
+ light: z.ZodOptional<z.ZodString>;
118
+ dark: z.ZodOptional<z.ZodString>;
119
+ background: z.ZodOptional<z.ZodObject<{
120
+ light: z.ZodOptional<z.ZodString>;
121
+ dark: z.ZodOptional<z.ZodString>;
122
+ }, "strip", z.ZodTypeAny, {
123
+ light?: string | undefined;
124
+ dark?: string | undefined;
125
+ }, {
126
+ light?: string | undefined;
127
+ dark?: string | undefined;
128
+ }>>;
129
+ anchors: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
130
+ from: z.ZodString;
131
+ via: z.ZodOptional<z.ZodString>;
132
+ to: z.ZodString;
133
+ }, "strict", z.ZodTypeAny, {
134
+ from: string;
135
+ to: string;
136
+ via?: string | undefined;
137
+ }, {
138
+ from: string;
139
+ to: string;
140
+ via?: string | undefined;
141
+ }>]>>;
142
+ ultraLight: z.ZodOptional<z.ZodAny>;
143
+ ultraDark: z.ZodOptional<z.ZodAny>;
144
+ }, "strict", z.ZodTypeAny, {
145
+ primary: string;
146
+ light?: string | undefined;
147
+ dark?: string | undefined;
148
+ background?: {
149
+ light?: string | undefined;
150
+ dark?: string | undefined;
151
+ } | undefined;
152
+ anchors?: string | {
153
+ from: string;
154
+ to: string;
155
+ via?: string | undefined;
156
+ } | undefined;
157
+ ultraLight?: any;
158
+ ultraDark?: any;
159
+ }, {
160
+ primary: string;
161
+ light?: string | undefined;
162
+ dark?: string | undefined;
163
+ background?: {
164
+ light?: string | undefined;
165
+ dark?: string | undefined;
166
+ } | undefined;
167
+ anchors?: string | {
168
+ from: string;
169
+ to: string;
170
+ via?: string | undefined;
171
+ } | undefined;
172
+ ultraLight?: any;
173
+ ultraDark?: any;
174
+ }>;
175
+ topbarCtaButton: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
176
+ type: z.ZodOptional<z.ZodLiteral<"link">>;
177
+ name: z.ZodString;
178
+ url: z.ZodString;
179
+ }, "strict", z.ZodTypeAny, {
180
+ name: string;
181
+ url: string;
182
+ type?: "link" | undefined;
183
+ }, {
184
+ name: string;
185
+ url: string;
186
+ type?: "link" | undefined;
187
+ }>, z.ZodObject<{
188
+ type: z.ZodLiteral<"github">;
189
+ url: z.ZodString;
190
+ }, "strict", z.ZodTypeAny, {
191
+ type: "github";
192
+ url: string;
193
+ }, {
194
+ type: "github";
195
+ url: string;
196
+ }>]>>;
197
+ topbarLinks: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
198
+ type: z.ZodOptional<z.ZodLiteral<"link">>;
199
+ name: z.ZodString;
200
+ url: z.ZodString;
201
+ }, "strict", z.ZodTypeAny, {
202
+ name: string;
203
+ url: string;
204
+ type?: "link" | undefined;
205
+ }, {
206
+ name: string;
207
+ url: string;
208
+ type?: "link" | undefined;
209
+ }>, z.ZodObject<{
210
+ type: z.ZodLiteral<"github">;
211
+ url: z.ZodString;
212
+ }, "strict", z.ZodTypeAny, {
213
+ type: "github";
214
+ url: string;
215
+ }, {
216
+ type: "github";
217
+ url: string;
218
+ }>]>, "many">>;
219
+ navigation: z.ZodArray<z.ZodType<import("../types/navigation").NavigationType, z.ZodTypeDef, import("../types/navigation").NavigationType>, "many">;
220
+ primaryTab: z.ZodOptional<z.ZodObject<{
221
+ name: z.ZodString;
222
+ }, "strict", z.ZodTypeAny, {
223
+ name: string;
224
+ }, {
225
+ name: string;
226
+ }>>;
227
+ topAnchor: z.ZodOptional<z.ZodObject<{
228
+ name: z.ZodString;
229
+ icon: z.ZodOptional<z.ZodString>;
230
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
231
+ }, "strict", z.ZodTypeAny, {
232
+ name: string;
233
+ icon?: string | undefined;
234
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
235
+ }, {
236
+ name: string;
237
+ icon?: string | undefined;
238
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
239
+ }>>;
240
+ anchors: z.ZodOptional<z.ZodArray<z.ZodObject<{
241
+ name: z.ZodString;
242
+ url: z.ZodString;
243
+ icon: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
244
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
245
+ color: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
246
+ from: z.ZodString;
247
+ via: z.ZodOptional<z.ZodString>;
248
+ to: z.ZodString;
249
+ }, "strict", z.ZodTypeAny, {
250
+ from: string;
251
+ to: string;
252
+ via?: string | undefined;
253
+ }, {
254
+ from: string;
255
+ to: string;
256
+ via?: string | undefined;
257
+ }>]>>;
258
+ isDefaultHidden: z.ZodOptional<z.ZodBoolean>;
259
+ version: z.ZodOptional<z.ZodString>;
260
+ }, "strip", z.ZodTypeAny, {
261
+ name: string;
262
+ url: string;
263
+ icon?: string | undefined;
264
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
265
+ color?: string | {
266
+ from: string;
267
+ to: string;
268
+ via?: string | undefined;
269
+ } | undefined;
270
+ isDefaultHidden?: boolean | undefined;
271
+ version?: string | undefined;
272
+ }, {
273
+ name: string;
274
+ url: string;
275
+ icon?: string | undefined;
276
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
277
+ color?: string | {
278
+ from: string;
279
+ to: string;
280
+ via?: string | undefined;
281
+ } | undefined;
282
+ isDefaultHidden?: boolean | undefined;
283
+ version?: string | undefined;
284
+ }>, "many">>;
285
+ tabs: z.ZodOptional<z.ZodArray<z.ZodObject<{
286
+ name: z.ZodString;
287
+ url: z.ZodString;
288
+ }, "strip", z.ZodTypeAny, {
289
+ name: string;
290
+ url: string;
291
+ }, {
292
+ name: string;
293
+ url: string;
294
+ }>, "many">>;
295
+ footerSocials: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodObject<{
296
+ type: z.ZodString;
297
+ url: z.ZodString;
298
+ }, "strip", z.ZodTypeAny, {
299
+ type: string;
300
+ url: string;
301
+ }, {
302
+ type: string;
303
+ url: string;
304
+ }>, "many">, z.ZodRecord<z.ZodString, z.ZodString>]>>;
305
+ backgroundImage: z.ZodOptional<z.ZodString>;
306
+ feedback: z.ZodOptional<z.ZodObject<{
307
+ suggestEdit: z.ZodOptional<z.ZodBoolean>;
308
+ raiseIssue: z.ZodOptional<z.ZodBoolean>;
309
+ }, "strip", z.ZodTypeAny, {
310
+ suggestEdit?: boolean | undefined;
311
+ raiseIssue?: boolean | undefined;
312
+ }, {
313
+ suggestEdit?: boolean | undefined;
314
+ raiseIssue?: boolean | undefined;
315
+ }>>;
316
+ analytics: z.ZodOptional<z.ZodObject<{
317
+ amplitude: z.ZodOptional<z.ZodObject<{
318
+ apiKey: z.ZodString;
319
+ }, "strip", z.ZodTypeAny, {
320
+ apiKey: string;
321
+ }, {
322
+ apiKey: string;
323
+ }>>;
324
+ clearbit: z.ZodOptional<z.ZodObject<{
325
+ publicApiKey: z.ZodString;
326
+ }, "strip", z.ZodTypeAny, {
327
+ publicApiKey: string;
328
+ }, {
329
+ publicApiKey: string;
330
+ }>>;
331
+ fathom: z.ZodOptional<z.ZodObject<{
332
+ siteId: z.ZodString;
333
+ }, "strip", z.ZodTypeAny, {
334
+ siteId: string;
335
+ }, {
336
+ siteId: string;
337
+ }>>;
338
+ ga4: z.ZodOptional<z.ZodObject<{
339
+ measurementId: z.ZodString;
340
+ }, "strip", z.ZodTypeAny, {
341
+ measurementId: string;
342
+ }, {
343
+ measurementId: string;
344
+ }>>;
345
+ gtm: z.ZodOptional<z.ZodObject<{
346
+ tagId: z.ZodString;
347
+ }, "strip", z.ZodTypeAny, {
348
+ tagId: string;
349
+ }, {
350
+ tagId: string;
351
+ }>>;
352
+ hotjar: z.ZodOptional<z.ZodObject<{
353
+ hjid: z.ZodString;
354
+ hjsv: z.ZodString;
355
+ }, "strip", z.ZodTypeAny, {
356
+ hjid: string;
357
+ hjsv: string;
358
+ }, {
359
+ hjid: string;
360
+ hjsv: string;
361
+ }>>;
362
+ koala: z.ZodOptional<z.ZodObject<{
363
+ publicApiKey: z.ZodEffects<z.ZodString, string, string>;
364
+ }, "strip", z.ZodTypeAny, {
365
+ publicApiKey: string;
366
+ }, {
367
+ publicApiKey: string;
368
+ }>>;
369
+ logrocket: z.ZodOptional<z.ZodObject<{
370
+ appId: z.ZodString;
371
+ }, "strip", z.ZodTypeAny, {
372
+ appId: string;
373
+ }, {
374
+ appId: string;
375
+ }>>;
376
+ mixpanel: z.ZodOptional<z.ZodObject<{
377
+ projectToken: z.ZodString;
378
+ }, "strip", z.ZodTypeAny, {
379
+ projectToken: string;
380
+ }, {
381
+ projectToken: string;
382
+ }>>;
383
+ pirsch: z.ZodOptional<z.ZodObject<{
384
+ id: z.ZodString;
385
+ }, "strip", z.ZodTypeAny, {
386
+ id: string;
387
+ }, {
388
+ id: string;
389
+ }>>;
390
+ posthog: z.ZodOptional<z.ZodObject<{
391
+ apiKey: z.ZodString;
392
+ apiHost: z.ZodOptional<z.ZodString>;
393
+ }, "strip", z.ZodTypeAny, {
394
+ apiKey: string;
395
+ apiHost?: string | undefined;
396
+ }, {
397
+ apiKey: string;
398
+ apiHost?: string | undefined;
399
+ }>>;
400
+ plausible: z.ZodOptional<z.ZodObject<{
401
+ domain: z.ZodEffects<z.ZodString, string, string>;
402
+ }, "strip", z.ZodTypeAny, {
403
+ domain: string;
404
+ }, {
405
+ domain: string;
406
+ }>>;
407
+ }, "strict", z.ZodTypeAny, {
408
+ amplitude?: {
409
+ apiKey: string;
410
+ } | undefined;
411
+ clearbit?: {
412
+ publicApiKey: string;
413
+ } | undefined;
414
+ fathom?: {
415
+ siteId: string;
416
+ } | undefined;
417
+ ga4?: {
418
+ measurementId: string;
419
+ } | undefined;
420
+ gtm?: {
421
+ tagId: string;
422
+ } | undefined;
423
+ hotjar?: {
424
+ hjid: string;
425
+ hjsv: string;
426
+ } | undefined;
427
+ koala?: {
428
+ publicApiKey: string;
429
+ } | undefined;
430
+ logrocket?: {
431
+ appId: string;
432
+ } | undefined;
433
+ mixpanel?: {
434
+ projectToken: string;
435
+ } | undefined;
436
+ pirsch?: {
437
+ id: string;
438
+ } | undefined;
439
+ posthog?: {
440
+ apiKey: string;
441
+ apiHost?: string | undefined;
442
+ } | undefined;
443
+ plausible?: {
444
+ domain: string;
445
+ } | undefined;
446
+ }, {
447
+ amplitude?: {
448
+ apiKey: string;
449
+ } | undefined;
450
+ clearbit?: {
451
+ publicApiKey: string;
452
+ } | undefined;
453
+ fathom?: {
454
+ siteId: string;
455
+ } | undefined;
456
+ ga4?: {
457
+ measurementId: string;
458
+ } | undefined;
459
+ gtm?: {
460
+ tagId: string;
461
+ } | undefined;
462
+ hotjar?: {
463
+ hjid: string;
464
+ hjsv: string;
465
+ } | undefined;
466
+ koala?: {
467
+ publicApiKey: string;
468
+ } | undefined;
469
+ logrocket?: {
470
+ appId: string;
471
+ } | undefined;
472
+ mixpanel?: {
473
+ projectToken: string;
474
+ } | undefined;
475
+ pirsch?: {
476
+ id: string;
477
+ } | undefined;
478
+ posthog?: {
479
+ apiKey: string;
480
+ apiHost?: string | undefined;
481
+ } | undefined;
482
+ plausible?: {
483
+ domain: string;
484
+ } | undefined;
485
+ }>>;
486
+ integrations: z.ZodOptional<z.ZodObject<{
487
+ intercom: z.ZodOptional<z.ZodString>;
488
+ frontchat: z.ZodOptional<z.ZodString>;
489
+ }, "strip", z.ZodTypeAny, {
490
+ intercom?: string | undefined;
491
+ frontchat?: string | undefined;
492
+ }, {
493
+ intercom?: string | undefined;
494
+ frontchat?: string | undefined;
495
+ }>>;
496
+ isWhiteLabeled: z.ZodOptional<z.ZodBoolean>;
497
+ __injected: z.ZodUndefined;
498
+ }, "strip", z.ZodTypeAny, {
499
+ $schema: string;
500
+ name: string;
501
+ favicon: string;
502
+ colors: {
503
+ primary: string;
504
+ light?: string | undefined;
505
+ dark?: string | undefined;
506
+ background?: {
507
+ light?: string | undefined;
508
+ dark?: string | undefined;
509
+ } | undefined;
510
+ anchors?: string | {
511
+ from: string;
512
+ to: string;
513
+ via?: string | undefined;
514
+ } | undefined;
515
+ ultraLight?: any;
516
+ ultraDark?: any;
517
+ };
518
+ navigation: import("../types/navigation").NavigationType[];
519
+ mintlify?: string | undefined;
520
+ logo?: string | {
521
+ light: string;
522
+ dark: string;
523
+ href?: string | undefined;
524
+ } | undefined;
525
+ openapi?: string | string[] | undefined;
526
+ api?: {
527
+ baseUrl?: string | string[] | undefined;
528
+ auth?: {
529
+ method?: "bearer" | "basic" | "key" | undefined;
530
+ name?: string | undefined;
531
+ inputPrefix?: string | undefined;
532
+ } | undefined;
533
+ playground?: {
534
+ mode: "show" | "simple" | "hide";
535
+ } | undefined;
536
+ request?: {
537
+ example?: {
538
+ showOptionalParams: boolean;
539
+ } | undefined;
540
+ } | undefined;
541
+ maintainOrder?: boolean | undefined;
542
+ } | undefined;
543
+ modeToggle?: {
544
+ default?: "light" | "dark" | undefined;
545
+ isHidden?: boolean | undefined;
546
+ } | undefined;
547
+ versions?: (string | {
548
+ name: string;
549
+ url: string;
550
+ })[] | undefined;
551
+ metadata?: Record<string, string> | undefined;
552
+ topbarCtaButton?: {
553
+ name: string;
554
+ url: string;
555
+ type?: "link" | undefined;
556
+ } | {
557
+ type: "github";
558
+ url: string;
559
+ } | undefined;
560
+ topbarLinks?: ({
561
+ name: string;
562
+ url: string;
563
+ type?: "link" | undefined;
564
+ } | {
565
+ type: "github";
566
+ url: string;
567
+ })[] | undefined;
568
+ primaryTab?: {
569
+ name: string;
570
+ } | undefined;
571
+ topAnchor?: {
572
+ name: string;
573
+ icon?: string | undefined;
574
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
575
+ } | undefined;
576
+ anchors?: {
577
+ name: string;
578
+ url: string;
579
+ icon?: string | undefined;
580
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
581
+ color?: string | {
582
+ from: string;
583
+ to: string;
584
+ via?: string | undefined;
585
+ } | undefined;
586
+ isDefaultHidden?: boolean | undefined;
587
+ version?: string | undefined;
588
+ }[] | undefined;
589
+ tabs?: {
590
+ name: string;
591
+ url: string;
592
+ }[] | undefined;
593
+ footerSocials?: Record<string, string> | {
594
+ type: string;
595
+ url: string;
596
+ }[] | undefined;
597
+ backgroundImage?: string | undefined;
598
+ feedback?: {
599
+ suggestEdit?: boolean | undefined;
600
+ raiseIssue?: boolean | undefined;
601
+ } | undefined;
602
+ analytics?: {
603
+ amplitude?: {
604
+ apiKey: string;
605
+ } | undefined;
606
+ clearbit?: {
607
+ publicApiKey: string;
608
+ } | undefined;
609
+ fathom?: {
610
+ siteId: string;
611
+ } | undefined;
612
+ ga4?: {
613
+ measurementId: string;
614
+ } | undefined;
615
+ gtm?: {
616
+ tagId: string;
617
+ } | undefined;
618
+ hotjar?: {
619
+ hjid: string;
620
+ hjsv: string;
621
+ } | undefined;
622
+ koala?: {
623
+ publicApiKey: string;
624
+ } | undefined;
625
+ logrocket?: {
626
+ appId: string;
627
+ } | undefined;
628
+ mixpanel?: {
629
+ projectToken: string;
630
+ } | undefined;
631
+ pirsch?: {
632
+ id: string;
633
+ } | undefined;
634
+ posthog?: {
635
+ apiKey: string;
636
+ apiHost?: string | undefined;
637
+ } | undefined;
638
+ plausible?: {
639
+ domain: string;
640
+ } | undefined;
641
+ } | undefined;
642
+ integrations?: {
643
+ intercom?: string | undefined;
644
+ frontchat?: string | undefined;
645
+ } | undefined;
646
+ isWhiteLabeled?: boolean | undefined;
647
+ __injected?: undefined;
648
+ }, {
649
+ name: string;
650
+ favicon: string;
651
+ colors: {
652
+ primary: string;
653
+ light?: string | undefined;
654
+ dark?: string | undefined;
655
+ background?: {
656
+ light?: string | undefined;
657
+ dark?: string | undefined;
658
+ } | undefined;
659
+ anchors?: string | {
660
+ from: string;
661
+ to: string;
662
+ via?: string | undefined;
663
+ } | undefined;
664
+ ultraLight?: any;
665
+ ultraDark?: any;
666
+ };
667
+ navigation: import("../types/navigation").NavigationType[];
668
+ $schema?: string | undefined;
669
+ mintlify?: string | undefined;
670
+ logo?: string | {
671
+ light: string;
672
+ dark: string;
673
+ href?: string | undefined;
674
+ } | undefined;
675
+ openapi?: string | string[] | undefined;
676
+ api?: {
677
+ baseUrl?: string | string[] | undefined;
678
+ auth?: {
679
+ method?: "bearer" | "basic" | "key" | undefined;
680
+ name?: string | undefined;
681
+ inputPrefix?: string | undefined;
682
+ } | undefined;
683
+ playground?: {
684
+ mode?: "show" | "simple" | "hide" | undefined;
685
+ } | undefined;
686
+ request?: {
687
+ example?: {
688
+ showOptionalParams?: boolean | undefined;
689
+ } | undefined;
690
+ } | undefined;
691
+ maintainOrder?: boolean | undefined;
692
+ } | undefined;
693
+ modeToggle?: {
694
+ default?: "light" | "dark" | undefined;
695
+ isHidden?: boolean | undefined;
696
+ } | undefined;
697
+ versions?: (string | {
698
+ name: string;
699
+ url: string;
700
+ })[] | undefined;
701
+ metadata?: Record<string, string> | undefined;
702
+ topbarCtaButton?: {
703
+ name: string;
704
+ url: string;
705
+ type?: "link" | undefined;
706
+ } | {
707
+ type: "github";
708
+ url: string;
709
+ } | undefined;
710
+ topbarLinks?: ({
711
+ name: string;
712
+ url: string;
713
+ type?: "link" | undefined;
714
+ } | {
715
+ type: "github";
716
+ url: string;
717
+ })[] | undefined;
718
+ primaryTab?: {
719
+ name: string;
720
+ } | undefined;
721
+ topAnchor?: {
722
+ name: string;
723
+ icon?: string | undefined;
724
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
725
+ } | undefined;
726
+ anchors?: {
727
+ name: string;
728
+ url: string;
729
+ icon?: string | undefined;
730
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
731
+ color?: string | {
732
+ from: string;
733
+ to: string;
734
+ via?: string | undefined;
735
+ } | undefined;
736
+ isDefaultHidden?: boolean | undefined;
737
+ version?: string | undefined;
738
+ }[] | undefined;
739
+ tabs?: {
740
+ name: string;
741
+ url: string;
742
+ }[] | undefined;
743
+ footerSocials?: Record<string, string> | {
744
+ type: string;
745
+ url: string;
746
+ }[] | undefined;
747
+ backgroundImage?: string | undefined;
748
+ feedback?: {
749
+ suggestEdit?: boolean | undefined;
750
+ raiseIssue?: boolean | undefined;
751
+ } | undefined;
752
+ analytics?: {
753
+ amplitude?: {
754
+ apiKey: string;
755
+ } | undefined;
756
+ clearbit?: {
757
+ publicApiKey: string;
758
+ } | undefined;
759
+ fathom?: {
760
+ siteId: string;
761
+ } | undefined;
762
+ ga4?: {
763
+ measurementId: string;
764
+ } | undefined;
765
+ gtm?: {
766
+ tagId: string;
767
+ } | undefined;
768
+ hotjar?: {
769
+ hjid: string;
770
+ hjsv: string;
771
+ } | undefined;
772
+ koala?: {
773
+ publicApiKey: string;
774
+ } | undefined;
775
+ logrocket?: {
776
+ appId: string;
777
+ } | undefined;
778
+ mixpanel?: {
779
+ projectToken: string;
780
+ } | undefined;
781
+ pirsch?: {
782
+ id: string;
783
+ } | undefined;
784
+ posthog?: {
785
+ apiKey: string;
786
+ apiHost?: string | undefined;
787
+ } | undefined;
788
+ plausible?: {
789
+ domain: string;
790
+ } | undefined;
791
+ } | undefined;
792
+ integrations?: {
793
+ intercom?: string | undefined;
794
+ frontchat?: string | undefined;
795
+ } | undefined;
796
+ isWhiteLabeled?: boolean | undefined;
797
+ __injected?: undefined;
798
+ }>;