@mintlify/validation 0.1.46 → 0.1.47

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