@mintlify/validation 0.1.825 → 0.1.826
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/dist/editor-navigation/conversion/common.d.ts +4 -3
- package/dist/editor-navigation/conversion/common.js +9 -1
- package/dist/editor-navigation/conversion/docsjson-to-tree.js +3 -1
- package/dist/editor-navigation/types.d.ts +7 -3
- package/dist/mint-config/schemas/v2/index.d.ts +480 -360
- package/dist/mint-config/schemas/v2/properties/navigation/anchors.d.ts +4 -4
- package/dist/mint-config/schemas/v2/properties/navigation/divisionNav.d.ts +4 -2
- package/dist/mint-config/schemas/v2/properties/navigation/dropdown.d.ts +4 -4
- package/dist/mint-config/schemas/v2/properties/navigation/groups.d.ts +15 -12
- package/dist/mint-config/schemas/v2/properties/navigation/groups.js +2 -1
- package/dist/mint-config/schemas/v2/properties/navigation/index.d.ts +100 -40
- package/dist/mint-config/schemas/v2/properties/navigation/languages.d.ts +4 -4
- package/dist/mint-config/schemas/v2/properties/navigation/menu.d.ts +4 -4
- package/dist/mint-config/schemas/v2/properties/navigation/pages.d.ts +38 -10
- package/dist/mint-config/schemas/v2/properties/navigation/products.d.ts +4 -4
- package/dist/mint-config/schemas/v2/properties/navigation/tabs.d.ts +2 -2
- package/dist/mint-config/schemas/v2/properties/navigation/version.d.ts +4 -4
- package/dist/mint-config/schemas/v2/properties/reusable/page.d.ts +39 -0
- package/dist/mint-config/schemas/v2/properties/reusable/page.js +7 -0
- package/dist/mint-config/schemas/v2/properties/reusable/sdk.d.ts +2 -1
- package/dist/mint-config/schemas/v2/properties/reusable/sdk.js +2 -1
- package/dist/mint-config/schemas/v2/themes/almond.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/aspen.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/linden.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/luma.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/maple.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/mint.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/palm.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/reusable/index.d.ts +32 -24
- package/dist/mint-config/schemas/v2/themes/sequoia.d.ts +48 -36
- package/dist/mint-config/schemas/v2/themes/willow.d.ts +48 -36
- package/dist/mint-config/validateConfig.d.ts +144 -108
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +3 -3
|
@@ -41,8 +41,8 @@ export declare const baseAnchorSchema: z.ZodObject<{
|
|
|
41
41
|
dark?: string | undefined;
|
|
42
42
|
} | undefined;
|
|
43
43
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
44
|
-
hidden?: boolean | undefined;
|
|
45
44
|
graphql?: undefined;
|
|
45
|
+
hidden?: boolean | undefined;
|
|
46
46
|
sdk?: undefined;
|
|
47
47
|
}, {
|
|
48
48
|
anchor: string;
|
|
@@ -56,8 +56,8 @@ export declare const baseAnchorSchema: z.ZodObject<{
|
|
|
56
56
|
dark?: string | undefined;
|
|
57
57
|
} | undefined;
|
|
58
58
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
59
|
-
hidden?: boolean | undefined;
|
|
60
59
|
graphql?: undefined;
|
|
60
|
+
hidden?: boolean | undefined;
|
|
61
61
|
sdk?: undefined;
|
|
62
62
|
}>;
|
|
63
63
|
export type BaseAnchorSchema = z.infer<typeof baseAnchorSchema>;
|
|
@@ -105,8 +105,8 @@ export declare const nonRecursiveAnchorSchema: z.ZodObject<{
|
|
|
105
105
|
dark?: string | undefined;
|
|
106
106
|
} | undefined;
|
|
107
107
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
108
|
-
hidden?: boolean | undefined;
|
|
109
108
|
graphql?: undefined;
|
|
109
|
+
hidden?: boolean | undefined;
|
|
110
110
|
sdk?: undefined;
|
|
111
111
|
}, {
|
|
112
112
|
href: string;
|
|
@@ -121,8 +121,8 @@ export declare const nonRecursiveAnchorSchema: z.ZodObject<{
|
|
|
121
121
|
dark?: string | undefined;
|
|
122
122
|
} | undefined;
|
|
123
123
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
124
|
-
hidden?: boolean | undefined;
|
|
125
124
|
graphql?: undefined;
|
|
125
|
+
hidden?: boolean | undefined;
|
|
126
126
|
sdk?: undefined;
|
|
127
127
|
}>;
|
|
128
128
|
export declare const anchorSchema: z.ZodType<AnchorNavigation<'default'>>;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
import { Division } from '../reusable/divisions.js';
|
|
3
3
|
import { DecoratedPageConfig } from '../reusable/page.js';
|
|
4
|
+
import { sdkSchema } from '../reusable/sdk.js';
|
|
4
5
|
import { BaseAnchorSchema } from './anchors.js';
|
|
5
6
|
import { BaseDropdownSchema } from './dropdown.js';
|
|
6
7
|
import { BaseGroupSchema } from './groups.js';
|
|
@@ -114,9 +115,10 @@ export type GlobalNavigation = {
|
|
|
114
115
|
};
|
|
115
116
|
export type PageNavigation<T extends NavigationType> = T extends 'default' ? string : DecoratedPageConfig;
|
|
116
117
|
export type PageOrGroupNavigation<T extends NavigationType> = T extends 'default' ? PageNavigation<'default'> | GroupNavigation<'default'> : PageNavigation<'decorated'> | GroupNavigation<'decorated'>;
|
|
117
|
-
export type GroupNavigation<T extends NavigationType> = T extends 'default' ? BaseGroupSchema & z.infer<typeof SomeApiSchema> & {
|
|
118
|
+
export type GroupNavigation<T extends NavigationType> = T extends 'default' ? Omit<BaseGroupSchema, 'sdk'> & z.infer<typeof SomeApiSchema> & {
|
|
119
|
+
sdk?: z.infer<typeof sdkSchema>;
|
|
118
120
|
pages?: PageOrGroupNavigation<'default'>[];
|
|
119
|
-
} : Omit<BaseGroupSchema, 'root'> & {
|
|
121
|
+
} : Omit<BaseGroupSchema, 'root' | 'sdk'> & {
|
|
120
122
|
pages: PageOrGroupNavigation<'decorated'>[];
|
|
121
123
|
root?: DecoratedPageConfig;
|
|
122
124
|
};
|
|
@@ -43,8 +43,8 @@ export declare const baseDropdownSchema: z.ZodObject<{
|
|
|
43
43
|
} | undefined;
|
|
44
44
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
45
45
|
description?: string | undefined;
|
|
46
|
-
hidden?: boolean | undefined;
|
|
47
46
|
graphql?: undefined;
|
|
47
|
+
hidden?: boolean | undefined;
|
|
48
48
|
sdk?: undefined;
|
|
49
49
|
}, {
|
|
50
50
|
dropdown: string;
|
|
@@ -59,8 +59,8 @@ export declare const baseDropdownSchema: z.ZodObject<{
|
|
|
59
59
|
} | undefined;
|
|
60
60
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
61
61
|
description?: string | undefined;
|
|
62
|
-
hidden?: boolean | undefined;
|
|
63
62
|
graphql?: undefined;
|
|
63
|
+
hidden?: boolean | undefined;
|
|
64
64
|
sdk?: undefined;
|
|
65
65
|
}>;
|
|
66
66
|
export type BaseDropdownSchema = z.infer<typeof baseDropdownSchema>;
|
|
@@ -110,8 +110,8 @@ export declare const nonRecursiveDropdownSchema: z.ZodObject<{
|
|
|
110
110
|
} | undefined;
|
|
111
111
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
112
112
|
description?: string | undefined;
|
|
113
|
-
hidden?: boolean | undefined;
|
|
114
113
|
graphql?: undefined;
|
|
114
|
+
hidden?: boolean | undefined;
|
|
115
115
|
sdk?: undefined;
|
|
116
116
|
}, {
|
|
117
117
|
href: string;
|
|
@@ -127,8 +127,8 @@ export declare const nonRecursiveDropdownSchema: z.ZodObject<{
|
|
|
127
127
|
} | undefined;
|
|
128
128
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
129
129
|
description?: string | undefined;
|
|
130
|
-
hidden?: boolean | undefined;
|
|
131
130
|
graphql?: undefined;
|
|
131
|
+
hidden?: boolean | undefined;
|
|
132
132
|
sdk?: undefined;
|
|
133
133
|
}>;
|
|
134
134
|
export declare const dropdownSchema: z.ZodType<DropdownNavigation<'default'>>;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
+
import { sdkSchema } from '../reusable/sdk.js';
|
|
2
3
|
import { GroupNavigation } from './divisionNav.js';
|
|
3
4
|
/** How automatic directory UI is shown for group roots under this navigation node. Inherits through `navigation`. */
|
|
4
5
|
export declare const NAVIGATION_DIRECTORY: readonly ["none", "accordion", "card"];
|
|
@@ -41,11 +42,11 @@ export declare const baseGroupSchema: z.ZodObject<{
|
|
|
41
42
|
expanded?: boolean | undefined;
|
|
42
43
|
public?: boolean | undefined;
|
|
43
44
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
45
|
+
graphql?: undefined;
|
|
44
46
|
tag?: string | undefined;
|
|
45
47
|
searchable?: boolean | undefined;
|
|
46
48
|
boost?: number | undefined;
|
|
47
49
|
hidden?: boolean | undefined;
|
|
48
|
-
graphql?: undefined;
|
|
49
50
|
sdk?: undefined;
|
|
50
51
|
root?: string | undefined;
|
|
51
52
|
}, {
|
|
@@ -58,18 +59,18 @@ export declare const baseGroupSchema: z.ZodObject<{
|
|
|
58
59
|
expanded?: boolean | undefined;
|
|
59
60
|
public?: boolean | undefined;
|
|
60
61
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
62
|
+
graphql?: undefined;
|
|
61
63
|
tag?: string | undefined;
|
|
62
64
|
searchable?: boolean | undefined;
|
|
63
65
|
boost?: number | undefined;
|
|
64
66
|
hidden?: boolean | undefined;
|
|
65
|
-
graphql?: undefined;
|
|
66
67
|
sdk?: undefined;
|
|
67
68
|
root?: string | undefined;
|
|
68
69
|
}>;
|
|
69
70
|
export type BaseGroupSchema = z.infer<typeof baseGroupSchema>;
|
|
70
71
|
export declare const groupSchema: z.ZodType<GroupNavigation<'default'>>;
|
|
71
72
|
export declare const decoratedGroupSchema: z.ZodType<GroupNavigation<'decorated'>>;
|
|
72
|
-
export declare const groupsSchema: z.ZodArray<z.ZodType<{
|
|
73
|
+
export declare const groupsSchema: z.ZodArray<z.ZodType<Omit<{
|
|
73
74
|
group: string;
|
|
74
75
|
icon?: string | {
|
|
75
76
|
name: string;
|
|
@@ -79,14 +80,14 @@ export declare const groupsSchema: z.ZodArray<z.ZodType<{
|
|
|
79
80
|
expanded?: boolean | undefined;
|
|
80
81
|
public?: boolean | undefined;
|
|
81
82
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
83
|
+
graphql?: undefined;
|
|
82
84
|
tag?: string | undefined;
|
|
83
85
|
searchable?: boolean | undefined;
|
|
84
86
|
boost?: number | undefined;
|
|
85
87
|
hidden?: boolean | undefined;
|
|
86
|
-
graphql?: undefined;
|
|
87
88
|
sdk?: undefined;
|
|
88
89
|
root?: string | undefined;
|
|
89
|
-
} & {
|
|
90
|
+
}, "sdk"> & {
|
|
90
91
|
openapi?: string | string[] | {
|
|
91
92
|
source: string;
|
|
92
93
|
directory?: string | undefined;
|
|
@@ -96,8 +97,9 @@ export declare const groupsSchema: z.ZodArray<z.ZodType<{
|
|
|
96
97
|
directory?: string | undefined;
|
|
97
98
|
} | undefined;
|
|
98
99
|
} & {
|
|
100
|
+
sdk?: z.infer<typeof sdkSchema>;
|
|
99
101
|
pages?: import("./divisionNav.js").PageOrGroupNavigation<"default">[];
|
|
100
|
-
}, z.ZodTypeDef, {
|
|
102
|
+
}, z.ZodTypeDef, Omit<{
|
|
101
103
|
group: string;
|
|
102
104
|
icon?: string | {
|
|
103
105
|
name: string;
|
|
@@ -107,14 +109,14 @@ export declare const groupsSchema: z.ZodArray<z.ZodType<{
|
|
|
107
109
|
expanded?: boolean | undefined;
|
|
108
110
|
public?: boolean | undefined;
|
|
109
111
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
112
|
+
graphql?: undefined;
|
|
110
113
|
tag?: string | undefined;
|
|
111
114
|
searchable?: boolean | undefined;
|
|
112
115
|
boost?: number | undefined;
|
|
113
116
|
hidden?: boolean | undefined;
|
|
114
|
-
graphql?: undefined;
|
|
115
117
|
sdk?: undefined;
|
|
116
118
|
root?: string | undefined;
|
|
117
|
-
} & {
|
|
119
|
+
}, "sdk"> & {
|
|
118
120
|
openapi?: string | string[] | {
|
|
119
121
|
source: string;
|
|
120
122
|
directory?: string | undefined;
|
|
@@ -124,6 +126,7 @@ export declare const groupsSchema: z.ZodArray<z.ZodType<{
|
|
|
124
126
|
directory?: string | undefined;
|
|
125
127
|
} | undefined;
|
|
126
128
|
} & {
|
|
129
|
+
sdk?: z.infer<typeof sdkSchema>;
|
|
127
130
|
pages?: import("./divisionNav.js").PageOrGroupNavigation<"default">[];
|
|
128
131
|
}>, "many">;
|
|
129
132
|
export declare const decoratedGroupsSchema: z.ZodArray<z.ZodType<Omit<{
|
|
@@ -136,14 +139,14 @@ export declare const decoratedGroupsSchema: z.ZodArray<z.ZodType<Omit<{
|
|
|
136
139
|
expanded?: boolean | undefined;
|
|
137
140
|
public?: boolean | undefined;
|
|
138
141
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
142
|
+
graphql?: undefined;
|
|
139
143
|
tag?: string | undefined;
|
|
140
144
|
searchable?: boolean | undefined;
|
|
141
145
|
boost?: number | undefined;
|
|
142
146
|
hidden?: boolean | undefined;
|
|
143
|
-
graphql?: undefined;
|
|
144
147
|
sdk?: undefined;
|
|
145
148
|
root?: string | undefined;
|
|
146
|
-
}, "root"> & {
|
|
149
|
+
}, "sdk" | "root"> & {
|
|
147
150
|
pages: import("./divisionNav.js").PageOrGroupNavigation<"decorated">[];
|
|
148
151
|
root?: import("../reusable/page.js").DecoratedPageConfig;
|
|
149
152
|
}, z.ZodTypeDef, Omit<{
|
|
@@ -156,14 +159,14 @@ export declare const decoratedGroupsSchema: z.ZodArray<z.ZodType<Omit<{
|
|
|
156
159
|
expanded?: boolean | undefined;
|
|
157
160
|
public?: boolean | undefined;
|
|
158
161
|
directory?: "none" | "card" | "accordion" | undefined;
|
|
162
|
+
graphql?: undefined;
|
|
159
163
|
tag?: string | undefined;
|
|
160
164
|
searchable?: boolean | undefined;
|
|
161
165
|
boost?: number | undefined;
|
|
162
166
|
hidden?: boolean | undefined;
|
|
163
|
-
graphql?: undefined;
|
|
164
167
|
sdk?: undefined;
|
|
165
168
|
root?: string | undefined;
|
|
166
|
-
}, "root"> & {
|
|
169
|
+
}, "sdk" | "root"> & {
|
|
167
170
|
pages: import("./divisionNav.js").PageOrGroupNavigation<"decorated">[];
|
|
168
171
|
root?: import("../reusable/page.js").DecoratedPageConfig;
|
|
169
172
|
}>, "many">;
|
|
@@ -16,7 +16,7 @@ import { hiddenSchema } from '../reusable/hidden.js';
|
|
|
16
16
|
import { iconSchema } from '../reusable/icon.js';
|
|
17
17
|
import { openApiSchema } from '../reusable/openapi.js';
|
|
18
18
|
import { decoratedPageSchema, pageSchema } from '../reusable/page.js';
|
|
19
|
-
import { sdkNotSupportedSchema } from '../reusable/sdk.js';
|
|
19
|
+
import { sdkNotSupportedSchema, sdkSchema } from '../reusable/sdk.js';
|
|
20
20
|
import { searchableSchema } from '../reusable/searchable.js';
|
|
21
21
|
import { decoratedPagesSchema, pagesSchema } from './pages.js';
|
|
22
22
|
/** How automatic directory UI is shown for group roots under this navigation node. Inherits through `navigation`. */
|
|
@@ -37,6 +37,7 @@ const silentlyDropInvalid = (schema) =>
|
|
|
37
37
|
schema.optional().catch(undefined);
|
|
38
38
|
export const groupSchema = baseGroupSchema
|
|
39
39
|
.extend({
|
|
40
|
+
sdk: sdkSchema.optional(),
|
|
40
41
|
openapi: silentlyDropInvalid(openApiSchema),
|
|
41
42
|
asyncapi: silentlyDropInvalid(asyncApiSchema).describe('A string or an array of strings of absolute or relative urls pointing to the AsyncAPI file(s). Ignored when openapi is also set'),
|
|
42
43
|
pages: z.lazy(() => pagesSchema).default([]),
|