@mintlify/validation 0.1.10 → 0.1.12

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 (22) hide show
  1. package/dist/index.d.ts +4 -0
  2. package/dist/schemas/analytics.d.ts +158 -0
  3. package/dist/schemas/anchorColors.d.ts +14 -0
  4. package/dist/schemas/anchors.d.ts +46 -0
  5. package/dist/schemas/colors.d.ts +61 -0
  6. package/dist/schemas/config.d.ts +651 -0
  7. package/dist/schemas/favicon.d.ts +2 -0
  8. package/dist/schemas/name.d.ts +2 -0
  9. package/dist/schemas/navigation.d.ts +3 -0
  10. package/dist/schemas/versions.d.ts +2 -0
  11. package/dist/types/analytics.d.ts +3 -0
  12. package/dist/types/anchors.d.ts +3 -0
  13. package/dist/types/colors.d.ts +3 -0
  14. package/dist/types/config.d.ts +3 -0
  15. package/dist/types/navigation.d.ts +6 -0
  16. package/dist/types/versions.d.ts +3 -0
  17. package/dist/utils/common.d.ts +6 -0
  18. package/dist/utils/flattenUnionErrorMessages.d.ts +7 -0
  19. package/dist/utils/hexadecimalPattern.d.ts +1 -0
  20. package/dist/utils/validateAnchorsWarnings.d.ts +4 -0
  21. package/dist/utils/validateVersionsInNavigation.d.ts +5 -0
  22. package/package.json +1 -1
package/dist/index.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ import { ConfigType } from "./types/config";
2
+ import { MintValidationResults } from "./utils/common";
3
+ export declare function validateMintConfig(config: ConfigType): MintValidationResults;
4
+ export declare const mintConfigSchema: any;
package/dist/schemas/analytics.d.ts ADDED
@@ -0,0 +1,158 @@
1
+ import { z } from "zod";
2
+ export declare const analyticsSchema: z.ZodObject<{
3
+ amplitude: z.ZodOptional<z.ZodObject<{
4
+ apiKey: z.ZodString;
5
+ }, "strip", z.ZodTypeAny, {
6
+ apiKey: string;
7
+ }, {
8
+ apiKey: string;
9
+ }>>;
10
+ fathom: z.ZodOptional<z.ZodObject<{
11
+ siteId: z.ZodString;
12
+ }, "strip", z.ZodTypeAny, {
13
+ siteId: string;
14
+ }, {
15
+ siteId: string;
16
+ }>>;
17
+ ga4: z.ZodOptional<z.ZodObject<{
18
+ measurementId: z.ZodString;
19
+ }, "strip", z.ZodTypeAny, {
20
+ measurementId: string;
21
+ }, {
22
+ measurementId: string;
23
+ }>>;
24
+ gtm: z.ZodOptional<z.ZodObject<{
25
+ tagId: z.ZodString;
26
+ }, "strip", z.ZodTypeAny, {
27
+ tagId: string;
28
+ }, {
29
+ tagId: string;
30
+ }>>;
31
+ hotjar: z.ZodOptional<z.ZodObject<{
32
+ hjid: z.ZodString;
33
+ hjsv: z.ZodString;
34
+ }, "strip", z.ZodTypeAny, {
35
+ hjid: string;
36
+ hjsv: string;
37
+ }, {
38
+ hjid: string;
39
+ hjsv: string;
40
+ }>>;
41
+ koala: z.ZodOptional<z.ZodObject<{
42
+ publicApiKey: z.ZodEffects<z.ZodString, string, string>;
43
+ }, "strip", z.ZodTypeAny, {
44
+ publicApiKey: string;
45
+ }, {
46
+ publicApiKey: string;
47
+ }>>;
48
+ logrocket: z.ZodOptional<z.ZodObject<{
49
+ appId: z.ZodString;
50
+ }, "strip", z.ZodTypeAny, {
51
+ appId: string;
52
+ }, {
53
+ appId: string;
54
+ }>>;
55
+ mixpanel: z.ZodOptional<z.ZodObject<{
56
+ projectToken: z.ZodString;
57
+ }, "strip", z.ZodTypeAny, {
58
+ projectToken: string;
59
+ }, {
60
+ projectToken: string;
61
+ }>>;
62
+ pirsch: z.ZodOptional<z.ZodObject<{
63
+ id: z.ZodString;
64
+ }, "strip", z.ZodTypeAny, {
65
+ id: string;
66
+ }, {
67
+ id: string;
68
+ }>>;
69
+ posthog: z.ZodOptional<z.ZodObject<{
70
+ apiKey: z.ZodString;
71
+ apiHost: z.ZodOptional<z.ZodString>;
72
+ }, "strip", z.ZodTypeAny, {
73
+ apiHost?: string | undefined;
74
+ apiKey: string;
75
+ }, {
76
+ apiHost?: string | undefined;
77
+ apiKey: string;
78
+ }>>;
79
+ plausible: z.ZodOptional<z.ZodObject<{
80
+ domain: z.ZodEffects<z.ZodString, string, string>;
81
+ }, "strip", z.ZodTypeAny, {
82
+ domain: string;
83
+ }, {
84
+ domain: string;
85
+ }>>;
86
+ }, "strict", z.ZodTypeAny, {
87
+ amplitude?: {
88
+ apiKey: string;
89
+ } | undefined;
90
+ fathom?: {
91
+ siteId: string;
92
+ } | undefined;
93
+ ga4?: {
94
+ measurementId: string;
95
+ } | undefined;
96
+ gtm?: {
97
+ tagId: string;
98
+ } | undefined;
99
+ hotjar?: {
100
+ hjid: string;
101
+ hjsv: string;
102
+ } | undefined;
103
+ koala?: {
104
+ publicApiKey: string;
105
+ } | undefined;
106
+ logrocket?: {
107
+ appId: string;
108
+ } | undefined;
109
+ mixpanel?: {
110
+ projectToken: string;
111
+ } | undefined;
112
+ pirsch?: {
113
+ id: string;
114
+ } | undefined;
115
+ posthog?: {
116
+ apiHost?: string | undefined;
117
+ apiKey: string;
118
+ } | undefined;
119
+ plausible?: {
120
+ domain: string;
121
+ } | undefined;
122
+ }, {
123
+ amplitude?: {
124
+ apiKey: string;
125
+ } | undefined;
126
+ fathom?: {
127
+ siteId: string;
128
+ } | undefined;
129
+ ga4?: {
130
+ measurementId: string;
131
+ } | undefined;
132
+ gtm?: {
133
+ tagId: string;
134
+ } | undefined;
135
+ hotjar?: {
136
+ hjid: string;
137
+ hjsv: string;
138
+ } | undefined;
139
+ koala?: {
140
+ publicApiKey: string;
141
+ } | undefined;
142
+ logrocket?: {
143
+ appId: string;
144
+ } | undefined;
145
+ mixpanel?: {
146
+ projectToken: string;
147
+ } | undefined;
148
+ pirsch?: {
149
+ id: string;
150
+ } | undefined;
151
+ posthog?: {
152
+ apiHost?: string | undefined;
153
+ apiKey: string;
154
+ } | undefined;
155
+ plausible?: {
156
+ domain: string;
157
+ } | undefined;
158
+ }>;
package/dist/schemas/anchorColors.d.ts ADDED
@@ -0,0 +1,14 @@
1
+ import { z } from "zod";
2
+ export declare const anchorColorSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
3
+ from: z.ZodString;
4
+ via: z.ZodOptional<z.ZodString>;
5
+ to: z.ZodString;
6
+ }, "strict", z.ZodTypeAny, {
7
+ via?: string | undefined;
8
+ from: string;
9
+ to: string;
10
+ }, {
11
+ via?: string | undefined;
12
+ from: string;
13
+ to: string;
14
+ }>]>;
package/dist/schemas/anchors.d.ts ADDED
@@ -0,0 +1,46 @@
1
+ import { z } from "zod";
2
+ export declare const anchorsSchema: z.ZodArray<z.ZodObject<{
3
+ name: z.ZodString;
4
+ url: z.ZodString;
5
+ icon: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
6
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
7
+ color: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
8
+ from: z.ZodString;
9
+ via: z.ZodOptional<z.ZodString>;
10
+ to: z.ZodString;
11
+ }, "strict", z.ZodTypeAny, {
12
+ via?: string | undefined;
13
+ from: string;
14
+ to: string;
15
+ }, {
16
+ via?: string | undefined;
17
+ from: string;
18
+ to: string;
19
+ }>]>>;
20
+ isDefaultHidden: z.ZodOptional<z.ZodBoolean>;
21
+ version: z.ZodOptional<z.ZodString>;
22
+ }, "strip", z.ZodTypeAny, {
23
+ icon?: string | undefined;
24
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
25
+ color?: string | {
26
+ via?: string | undefined;
27
+ from: string;
28
+ to: string;
29
+ } | undefined;
30
+ isDefaultHidden?: boolean | undefined;
31
+ version?: string | undefined;
32
+ name: string;
33
+ url: string;
34
+ }, {
35
+ icon?: string | undefined;
36
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
37
+ color?: string | {
38
+ via?: string | undefined;
39
+ from: string;
40
+ to: string;
41
+ } | undefined;
42
+ isDefaultHidden?: boolean | undefined;
43
+ version?: string | undefined;
44
+ name: string;
45
+ url: string;
46
+ }>, "many">;
package/dist/schemas/colors.d.ts ADDED
@@ -0,0 +1,61 @@
1
+ import { z } from "zod";
2
+ export declare const colorsSchema: z.ZodObject<{
3
+ primary: z.ZodString;
4
+ light: z.ZodOptional<z.ZodString>;
5
+ dark: z.ZodOptional<z.ZodString>;
6
+ background: z.ZodOptional<z.ZodObject<{
7
+ light: z.ZodOptional<z.ZodString>;
8
+ dark: z.ZodOptional<z.ZodString>;
9
+ }, "strip", z.ZodTypeAny, {
10
+ light?: string | undefined;
11
+ dark?: string | undefined;
12
+ }, {
13
+ light?: string | undefined;
14
+ dark?: string | undefined;
15
+ }>>;
16
+ anchors: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
17
+ from: z.ZodString;
18
+ via: z.ZodOptional<z.ZodString>;
19
+ to: z.ZodString;
20
+ }, "strict", z.ZodTypeAny, {
21
+ via?: string | undefined;
22
+ from: string;
23
+ to: string;
24
+ }, {
25
+ via?: string | undefined;
26
+ from: string;
27
+ to: string;
28
+ }>]>>;
29
+ ultraLight: z.ZodOptional<z.ZodAny>;
30
+ ultraDark: z.ZodOptional<z.ZodAny>;
31
+ }, "strict", z.ZodTypeAny, {
32
+ light?: string | undefined;
33
+ dark?: string | undefined;
34
+ background?: {
35
+ light?: string | undefined;
36
+ dark?: string | undefined;
37
+ } | undefined;
38
+ anchors?: string | {
39
+ via?: string | undefined;
40
+ from: string;
41
+ to: string;
42
+ } | undefined;
43
+ ultraLight?: any;
44
+ ultraDark?: any;
45
+ primary: string;
46
+ }, {
47
+ light?: string | undefined;
48
+ dark?: string | undefined;
49
+ background?: {
50
+ light?: string | undefined;
51
+ dark?: string | undefined;
52
+ } | undefined;
53
+ anchors?: string | {
54
+ via?: string | undefined;
55
+ from: string;
56
+ to: string;
57
+ } | undefined;
58
+ ultraLight?: any;
59
+ ultraDark?: any;
60
+ primary: string;
61
+ }>;
package/dist/schemas/config.d.ts ADDED
@@ -0,0 +1,651 @@
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
+ href?: string | undefined;
12
+ light: string;
13
+ dark: string;
14
+ }, {
15
+ href?: string | undefined;
16
+ light: string;
17
+ dark: string;
18
+ }>]>>;
19
+ favicon: z.ZodEffects<z.ZodString, string, string>;
20
+ openApi: z.ZodOptional<z.ZodString>;
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.ZodEffects<z.ZodString, string, string>>;
25
+ name: z.ZodOptional<z.ZodString>;
26
+ inputPrefix: z.ZodOptional<z.ZodString>;
27
+ }, "strict", z.ZodTypeAny, {
28
+ name?: string | undefined;
29
+ method?: string | undefined;
30
+ inputPrefix?: string | undefined;
31
+ }, {
32
+ name?: string | undefined;
33
+ method?: string | undefined;
34
+ inputPrefix?: string | undefined;
35
+ }>>;
36
+ hidePlayground: z.ZodOptional<z.ZodBoolean>;
37
+ }, "strict", z.ZodTypeAny, {
38
+ baseUrl?: string | string[] | undefined;
39
+ auth?: {
40
+ name?: string | undefined;
41
+ method?: string | undefined;
42
+ inputPrefix?: string | undefined;
43
+ } | undefined;
44
+ hidePlayground?: boolean | undefined;
45
+ }, {
46
+ baseUrl?: string | string[] | undefined;
47
+ auth?: {
48
+ name?: string | undefined;
49
+ method?: string | undefined;
50
+ inputPrefix?: string | undefined;
51
+ } | undefined;
52
+ hidePlayground?: boolean | undefined;
53
+ }>>;
54
+ modeToggle: z.ZodOptional<z.ZodObject<{
55
+ default: z.ZodOptional<z.ZodString>;
56
+ isHidden: z.ZodOptional<z.ZodBoolean>;
57
+ }, "strip", z.ZodTypeAny, {
58
+ default?: string | undefined;
59
+ isHidden?: boolean | undefined;
60
+ }, {
61
+ default?: string | undefined;
62
+ isHidden?: boolean | undefined;
63
+ }>>;
64
+ versions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
65
+ metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
66
+ colors: z.ZodObject<{
67
+ primary: z.ZodString;
68
+ light: z.ZodOptional<z.ZodString>;
69
+ dark: z.ZodOptional<z.ZodString>;
70
+ background: z.ZodOptional<z.ZodObject<{
71
+ light: z.ZodOptional<z.ZodString>;
72
+ dark: z.ZodOptional<z.ZodString>;
73
+ }, "strip", z.ZodTypeAny, {
74
+ light?: string | undefined;
75
+ dark?: string | undefined;
76
+ }, {
77
+ light?: string | undefined;
78
+ dark?: string | undefined;
79
+ }>>;
80
+ anchors: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
81
+ from: z.ZodString;
82
+ via: z.ZodOptional<z.ZodString>;
83
+ to: z.ZodString;
84
+ }, "strict", z.ZodTypeAny, {
85
+ via?: string | undefined;
86
+ from: string;
87
+ to: string;
88
+ }, {
89
+ via?: string | undefined;
90
+ from: string;
91
+ to: string;
92
+ }>]>>;
93
+ ultraLight: z.ZodOptional<z.ZodAny>;
94
+ ultraDark: z.ZodOptional<z.ZodAny>;
95
+ }, "strict", z.ZodTypeAny, {
96
+ light?: string | undefined;
97
+ dark?: string | undefined;
98
+ background?: {
99
+ light?: string | undefined;
100
+ dark?: string | undefined;
101
+ } | undefined;
102
+ anchors?: string | {
103
+ via?: string | undefined;
104
+ from: string;
105
+ to: string;
106
+ } | undefined;
107
+ ultraLight?: any;
108
+ ultraDark?: any;
109
+ primary: string;
110
+ }, {
111
+ light?: string | undefined;
112
+ dark?: string | undefined;
113
+ background?: {
114
+ light?: string | undefined;
115
+ dark?: string | undefined;
116
+ } | undefined;
117
+ anchors?: string | {
118
+ via?: string | undefined;
119
+ from: string;
120
+ to: string;
121
+ } | undefined;
122
+ ultraLight?: any;
123
+ ultraDark?: any;
124
+ primary: string;
125
+ }>;
126
+ topbarCtaButton: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
127
+ type: z.ZodOptional<z.ZodLiteral<"link">>;
128
+ name: z.ZodString;
129
+ url: z.ZodString;
130
+ }, "strict", z.ZodTypeAny, {
131
+ type?: "link" | undefined;
132
+ name: string;
133
+ url: string;
134
+ }, {
135
+ type?: "link" | undefined;
136
+ name: string;
137
+ url: string;
138
+ }>, z.ZodObject<{
139
+ type: z.ZodLiteral<"github">;
140
+ url: z.ZodString;
141
+ }, "strict", z.ZodTypeAny, {
142
+ type: "github";
143
+ url: string;
144
+ }, {
145
+ type: "github";
146
+ url: string;
147
+ }>]>>;
148
+ topbarLinks: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
149
+ type: z.ZodOptional<z.ZodLiteral<"link">>;
150
+ name: z.ZodString;
151
+ url: z.ZodString;
152
+ }, "strict", z.ZodTypeAny, {
153
+ type?: "link" | undefined;
154
+ name: string;
155
+ url: string;
156
+ }, {
157
+ type?: "link" | undefined;
158
+ name: string;
159
+ url: string;
160
+ }>, z.ZodObject<{
161
+ type: z.ZodLiteral<"github">;
162
+ url: z.ZodString;
163
+ }, "strict", z.ZodTypeAny, {
164
+ type: "github";
165
+ url: string;
166
+ }, {
167
+ type: "github";
168
+ url: string;
169
+ }>]>, "many">>;
170
+ navigation: z.ZodArray<z.ZodType<import("../types/navigation").NavigationType, z.ZodTypeDef, import("../types/navigation").NavigationType>, "many">;
171
+ topAnchor: z.ZodOptional<z.ZodObject<{
172
+ name: z.ZodString;
173
+ icon: z.ZodOptional<z.ZodString>;
174
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
175
+ }, "strict", z.ZodTypeAny, {
176
+ icon?: string | undefined;
177
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
178
+ name: string;
179
+ }, {
180
+ icon?: string | undefined;
181
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
182
+ name: string;
183
+ }>>;
184
+ anchors: z.ZodOptional<z.ZodArray<z.ZodObject<{
185
+ name: z.ZodString;
186
+ url: z.ZodString;
187
+ icon: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
188
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
189
+ color: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
190
+ from: z.ZodString;
191
+ via: z.ZodOptional<z.ZodString>;
192
+ to: z.ZodString;
193
+ }, "strict", z.ZodTypeAny, {
194
+ via?: string | undefined;
195
+ from: string;
196
+ to: string;
197
+ }, {
198
+ via?: string | undefined;
199
+ from: string;
200
+ to: string;
201
+ }>]>>;
202
+ isDefaultHidden: z.ZodOptional<z.ZodBoolean>;
203
+ version: z.ZodOptional<z.ZodString>;
204
+ }, "strip", z.ZodTypeAny, {
205
+ icon?: string | undefined;
206
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
207
+ color?: string | {
208
+ via?: string | undefined;
209
+ from: string;
210
+ to: string;
211
+ } | undefined;
212
+ isDefaultHidden?: boolean | undefined;
213
+ version?: string | undefined;
214
+ name: string;
215
+ url: string;
216
+ }, {
217
+ icon?: string | undefined;
218
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
219
+ color?: string | {
220
+ via?: string | undefined;
221
+ from: string;
222
+ to: string;
223
+ } | undefined;
224
+ isDefaultHidden?: boolean | undefined;
225
+ version?: string | undefined;
226
+ name: string;
227
+ url: string;
228
+ }>, "many">>;
229
+ footerSocials: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodObject<{
230
+ type: z.ZodString;
231
+ url: z.ZodString;
232
+ }, "strip", z.ZodTypeAny, {
233
+ type: string;
234
+ url: string;
235
+ }, {
236
+ type: string;
237
+ url: string;
238
+ }>, "many">, z.ZodRecord<z.ZodString, z.ZodString>]>>;
239
+ backgroundImage: z.ZodOptional<z.ZodString>;
240
+ analytics: z.ZodOptional<z.ZodObject<{
241
+ amplitude: z.ZodOptional<z.ZodObject<{
242
+ apiKey: z.ZodString;
243
+ }, "strip", z.ZodTypeAny, {
244
+ apiKey: string;
245
+ }, {
246
+ apiKey: string;
247
+ }>>;
248
+ fathom: z.ZodOptional<z.ZodObject<{
249
+ siteId: z.ZodString;
250
+ }, "strip", z.ZodTypeAny, {
251
+ siteId: string;
252
+ }, {
253
+ siteId: string;
254
+ }>>;
255
+ ga4: z.ZodOptional<z.ZodObject<{
256
+ measurementId: z.ZodString;
257
+ }, "strip", z.ZodTypeAny, {
258
+ measurementId: string;
259
+ }, {
260
+ measurementId: string;
261
+ }>>;
262
+ gtm: z.ZodOptional<z.ZodObject<{
263
+ tagId: z.ZodString;
264
+ }, "strip", z.ZodTypeAny, {
265
+ tagId: string;
266
+ }, {
267
+ tagId: string;
268
+ }>>;
269
+ hotjar: z.ZodOptional<z.ZodObject<{
270
+ hjid: z.ZodString;
271
+ hjsv: z.ZodString;
272
+ }, "strip", z.ZodTypeAny, {
273
+ hjid: string;
274
+ hjsv: string;
275
+ }, {
276
+ hjid: string;
277
+ hjsv: string;
278
+ }>>;
279
+ koala: z.ZodOptional<z.ZodObject<{
280
+ publicApiKey: z.ZodEffects<z.ZodString, string, string>;
281
+ }, "strip", z.ZodTypeAny, {
282
+ publicApiKey: string;
283
+ }, {
284
+ publicApiKey: string;
285
+ }>>;
286
+ logrocket: z.ZodOptional<z.ZodObject<{
287
+ appId: z.ZodString;
288
+ }, "strip", z.ZodTypeAny, {
289
+ appId: string;
290
+ }, {
291
+ appId: string;
292
+ }>>;
293
+ mixpanel: z.ZodOptional<z.ZodObject<{
294
+ projectToken: z.ZodString;
295
+ }, "strip", z.ZodTypeAny, {
296
+ projectToken: string;
297
+ }, {
298
+ projectToken: string;
299
+ }>>;
300
+ pirsch: z.ZodOptional<z.ZodObject<{
301
+ id: z.ZodString;
302
+ }, "strip", z.ZodTypeAny, {
303
+ id: string;
304
+ }, {
305
+ id: string;
306
+ }>>;
307
+ posthog: z.ZodOptional<z.ZodObject<{
308
+ apiKey: z.ZodString;
309
+ apiHost: z.ZodOptional<z.ZodString>;
310
+ }, "strip", z.ZodTypeAny, {
311
+ apiHost?: string | undefined;
312
+ apiKey: string;
313
+ }, {
314
+ apiHost?: string | undefined;
315
+ apiKey: string;
316
+ }>>;
317
+ plausible: z.ZodOptional<z.ZodObject<{
318
+ domain: z.ZodEffects<z.ZodString, string, string>;
319
+ }, "strip", z.ZodTypeAny, {
320
+ domain: string;
321
+ }, {
322
+ domain: string;
323
+ }>>;
324
+ }, "strict", z.ZodTypeAny, {
325
+ amplitude?: {
326
+ apiKey: string;
327
+ } | undefined;
328
+ fathom?: {
329
+ siteId: string;
330
+ } | undefined;
331
+ ga4?: {
332
+ measurementId: string;
333
+ } | undefined;
334
+ gtm?: {
335
+ tagId: string;
336
+ } | undefined;
337
+ hotjar?: {
338
+ hjid: string;
339
+ hjsv: string;
340
+ } | undefined;
341
+ koala?: {
342
+ publicApiKey: string;
343
+ } | undefined;
344
+ logrocket?: {
345
+ appId: string;
346
+ } | undefined;
347
+ mixpanel?: {
348
+ projectToken: string;
349
+ } | undefined;
350
+ pirsch?: {
351
+ id: string;
352
+ } | undefined;
353
+ posthog?: {
354
+ apiHost?: string | undefined;
355
+ apiKey: string;
356
+ } | undefined;
357
+ plausible?: {
358
+ domain: string;
359
+ } | undefined;
360
+ }, {
361
+ amplitude?: {
362
+ apiKey: string;
363
+ } | undefined;
364
+ fathom?: {
365
+ siteId: string;
366
+ } | undefined;
367
+ ga4?: {
368
+ measurementId: string;
369
+ } | undefined;
370
+ gtm?: {
371
+ tagId: string;
372
+ } | undefined;
373
+ hotjar?: {
374
+ hjid: string;
375
+ hjsv: string;
376
+ } | undefined;
377
+ koala?: {
378
+ publicApiKey: string;
379
+ } | undefined;
380
+ logrocket?: {
381
+ appId: string;
382
+ } | undefined;
383
+ mixpanel?: {
384
+ projectToken: string;
385
+ } | undefined;
386
+ pirsch?: {
387
+ id: string;
388
+ } | undefined;
389
+ posthog?: {
390
+ apiHost?: string | undefined;
391
+ apiKey: string;
392
+ } | undefined;
393
+ plausible?: {
394
+ domain: string;
395
+ } | undefined;
396
+ }>>;
397
+ integrations: z.ZodOptional<z.ZodObject<{
398
+ intercom: z.ZodOptional<z.ZodString>;
399
+ }, "strip", z.ZodTypeAny, {
400
+ intercom?: string | undefined;
401
+ }, {
402
+ intercom?: string | undefined;
403
+ }>>;
404
+ __injected: z.ZodUndefined;
405
+ }, "strip", z.ZodTypeAny, {
406
+ mintlify?: string | undefined;
407
+ logo?: string | {
408
+ href?: string | undefined;
409
+ light: string;
410
+ dark: string;
411
+ } | undefined;
412
+ openApi?: string | undefined;
413
+ api?: {
414
+ baseUrl?: string | string[] | undefined;
415
+ auth?: {
416
+ name?: string | undefined;
417
+ method?: string | undefined;
418
+ inputPrefix?: string | undefined;
419
+ } | undefined;
420
+ hidePlayground?: boolean | undefined;
421
+ } | undefined;
422
+ modeToggle?: {
423
+ default?: string | undefined;
424
+ isHidden?: boolean | undefined;
425
+ } | undefined;
426
+ versions?: string[] | undefined;
427
+ metadata?: Record<string, string> | undefined;
428
+ anchors?: {
429
+ icon?: string | undefined;
430
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
431
+ color?: string | {
432
+ via?: string | undefined;
433
+ from: string;
434
+ to: string;
435
+ } | undefined;
436
+ isDefaultHidden?: boolean | undefined;
437
+ version?: string | undefined;
438
+ name: string;
439
+ url: string;
440
+ }[] | undefined;
441
+ topbarCtaButton?: {
442
+ type?: "link" | undefined;
443
+ name: string;
444
+ url: string;
445
+ } | {
446
+ type: "github";
447
+ url: string;
448
+ } | undefined;
449
+ topbarLinks?: ({
450
+ type?: "link" | undefined;
451
+ name: string;
452
+ url: string;
453
+ } | {
454
+ type: "github";
455
+ url: string;
456
+ })[] | undefined;
457
+ topAnchor?: {
458
+ icon?: string | undefined;
459
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
460
+ name: string;
461
+ } | undefined;
462
+ footerSocials?: Record<string, string> | {
463
+ type: string;
464
+ url: string;
465
+ }[] | undefined;
466
+ backgroundImage?: string | undefined;
467
+ analytics?: {
468
+ amplitude?: {
469
+ apiKey: string;
470
+ } | undefined;
471
+ fathom?: {
472
+ siteId: string;
473
+ } | undefined;
474
+ ga4?: {
475
+ measurementId: string;
476
+ } | undefined;
477
+ gtm?: {
478
+ tagId: string;
479
+ } | undefined;
480
+ hotjar?: {
481
+ hjid: string;
482
+ hjsv: string;
483
+ } | undefined;
484
+ koala?: {
485
+ publicApiKey: string;
486
+ } | undefined;
487
+ logrocket?: {
488
+ appId: string;
489
+ } | undefined;
490
+ mixpanel?: {
491
+ projectToken: string;
492
+ } | undefined;
493
+ pirsch?: {
494
+ id: string;
495
+ } | undefined;
496
+ posthog?: {
497
+ apiHost?: string | undefined;
498
+ apiKey: string;
499
+ } | undefined;
500
+ plausible?: {
501
+ domain: string;
502
+ } | undefined;
503
+ } | undefined;
504
+ integrations?: {
505
+ intercom?: string | undefined;
506
+ } | undefined;
507
+ __injected?: undefined;
508
+ $schema: string;
509
+ name: string;
510
+ favicon: string;
511
+ colors: {
512
+ light?: string | undefined;
513
+ dark?: string | undefined;
514
+ background?: {
515
+ light?: string | undefined;
516
+ dark?: string | undefined;
517
+ } | undefined;
518
+ anchors?: string | {
519
+ via?: string | undefined;
520
+ from: string;
521
+ to: string;
522
+ } | undefined;
523
+ ultraLight?: any;
524
+ ultraDark?: any;
525
+ primary: string;
526
+ };
527
+ navigation: import("../types/navigation").NavigationType[];
528
+ }, {
529
+ $schema?: string | undefined;
530
+ mintlify?: string | undefined;
531
+ logo?: string | {
532
+ href?: string | undefined;
533
+ light: string;
534
+ dark: string;
535
+ } | undefined;
536
+ openApi?: string | undefined;
537
+ api?: {
538
+ baseUrl?: string | string[] | undefined;
539
+ auth?: {
540
+ name?: string | undefined;
541
+ method?: string | undefined;
542
+ inputPrefix?: string | undefined;
543
+ } | undefined;
544
+ hidePlayground?: boolean | undefined;
545
+ } | undefined;
546
+ modeToggle?: {
547
+ default?: string | undefined;
548
+ isHidden?: boolean | undefined;
549
+ } | undefined;
550
+ versions?: string[] | undefined;
551
+ metadata?: Record<string, string> | undefined;
552
+ anchors?: {
553
+ icon?: string | undefined;
554
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
555
+ color?: string | {
556
+ via?: string | undefined;
557
+ from: string;
558
+ to: string;
559
+ } | undefined;
560
+ isDefaultHidden?: boolean | undefined;
561
+ version?: string | undefined;
562
+ name: string;
563
+ url: string;
564
+ }[] | undefined;
565
+ topbarCtaButton?: {
566
+ type?: "link" | undefined;
567
+ name: string;
568
+ url: string;
569
+ } | {
570
+ type: "github";
571
+ url: string;
572
+ } | undefined;
573
+ topbarLinks?: ({
574
+ type?: "link" | undefined;
575
+ name: string;
576
+ url: string;
577
+ } | {
578
+ type: "github";
579
+ url: string;
580
+ })[] | undefined;
581
+ topAnchor?: {
582
+ icon?: string | undefined;
583
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
584
+ name: string;
585
+ } | undefined;
586
+ footerSocials?: Record<string, string> | {
587
+ type: string;
588
+ url: string;
589
+ }[] | undefined;
590
+ backgroundImage?: string | undefined;
591
+ analytics?: {
592
+ amplitude?: {
593
+ apiKey: string;
594
+ } | undefined;
595
+ fathom?: {
596
+ siteId: string;
597
+ } | undefined;
598
+ ga4?: {
599
+ measurementId: string;
600
+ } | undefined;
601
+ gtm?: {
602
+ tagId: string;
603
+ } | undefined;
604
+ hotjar?: {
605
+ hjid: string;
606
+ hjsv: string;
607
+ } | undefined;
608
+ koala?: {
609
+ publicApiKey: string;
610
+ } | undefined;
611
+ logrocket?: {
612
+ appId: string;
613
+ } | undefined;
614
+ mixpanel?: {
615
+ projectToken: string;
616
+ } | undefined;
617
+ pirsch?: {
618
+ id: string;
619
+ } | undefined;
620
+ posthog?: {
621
+ apiHost?: string | undefined;
622
+ apiKey: string;
623
+ } | undefined;
624
+ plausible?: {
625
+ domain: string;
626
+ } | undefined;
627
+ } | undefined;
628
+ integrations?: {
629
+ intercom?: string | undefined;
630
+ } | undefined;
631
+ __injected?: undefined;
632
+ name: string;
633
+ favicon: string;
634
+ colors: {
635
+ light?: string | undefined;
636
+ dark?: string | undefined;
637
+ background?: {
638
+ light?: string | undefined;
639
+ dark?: string | undefined;
640
+ } | undefined;
641
+ anchors?: string | {
642
+ via?: string | undefined;
643
+ from: string;
644
+ to: string;
645
+ } | undefined;
646
+ ultraLight?: any;
647
+ ultraDark?: any;
648
+ primary: string;
649
+ };
650
+ navigation: import("../types/navigation").NavigationType[];
651
+ }>;
package/dist/schemas/favicon.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { z } from "zod";
2
+ export declare const faviconSchema: z.ZodEffects<z.ZodString, string, string>;
package/dist/schemas/name.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { z } from "zod";
2
+ export declare const nameSchema: z.ZodString;
package/dist/schemas/navigation.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ import { z } from "zod";
2
+ import { NavigationType } from "../types/navigation";
3
+ export declare const navigationConfigSchema: z.ZodArray<z.ZodType<NavigationType, z.ZodTypeDef, NavigationType>, "many">;
package/dist/schemas/versions.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { z } from "zod";
2
+ export declare const versionsSchema: z.ZodArray<z.ZodString, "many">;
package/dist/types/analytics.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ import { z } from "zod";
2
+ import { analyticsSchema } from "../schemas/analytics";
3
+ export type AnalyticsType = z.infer<typeof analyticsSchema>;
package/dist/types/anchors.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ import { z } from "zod";
2
+ import { anchorsSchema } from "../schemas/anchors";
3
+ export type AnchorsType = z.infer<typeof anchorsSchema>;
package/dist/types/colors.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ import { z } from "zod";
2
+ import { colorsSchema } from "../schemas/colors";
3
+ export type ColorsType = z.infer<typeof colorsSchema>;
package/dist/types/config.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ import { z } from "zod";
2
+ import { configSchema } from "../schemas/config";
3
+ export type ConfigType = z.infer<typeof configSchema>;
package/dist/types/navigation.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ export type NavigationEntry = string | NavigationType;
2
+ export type NavigationType = {
3
+ group: string;
4
+ pages: NavigationEntry[];
5
+ version?: string;
6
+ };
package/dist/types/versions.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ import { z } from "zod";
2
+ import { versionsSchema } from "../schemas/versions";
3
+ export type VersionsType = z.infer<typeof versionsSchema>;
package/dist/utils/common.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ export declare class MintValidationResults {
2
+ status: "error" | "success";
3
+ errors: string[];
4
+ warnings: string[];
5
+ constructor();
6
+ }
package/dist/utils/flattenUnionErrorMessages.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ type UnionError = {
2
+ message: string;
3
+ code?: string;
4
+ unionErrors?: UnionError[];
5
+ };
6
+ export declare function flattenUnionErrorMessages(unionErrors: UnionError[]): string[];
7
+ export {};
package/dist/utils/hexadecimalPattern.d.ts ADDED
@@ -0,0 +1 @@
1
+ export declare const hexadecimalPattern: RegExp;
package/dist/utils/validateAnchorsWarnings.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ import { NavigationType } from "../types/navigation";
2
+ import { AnchorsType } from "../types/anchors";
3
+ import { MintValidationResults } from "./common";
4
+ export declare function validateAnchorsWarnings(anchors: AnchorsType | undefined, navigation: NavigationType[] | undefined): MintValidationResults;
package/dist/utils/validateVersionsInNavigation.d.ts ADDED
@@ -0,0 +1,5 @@
1
+ import { NavigationEntry, NavigationType } from "../types/navigation";
2
+ import { VersionsType } from "../types/versions";
3
+ import { MintValidationResults } from "./common";
4
+ export declare function flattenNavigationVersions(nav: NavigationEntry[], versions?: string[]): string[];
5
+ export declare function validateVersionsInNavigation(navigation: NavigationType[] | undefined, versions?: VersionsType | undefined): MintValidationResults;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mintlify/validation",
3
- "version": "0.1.10",
3
+ "version": "0.1.12",
4
4
  "description": "Validates mint.json files",
5
5
  "author": "Mintlify, Inc.",
6
6
  "repository": {