@mintlify/validation 0.1.585 → 0.1.587

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 (30) hide show
  1. package/dist/index.js +2 -1
  2. package/dist/mint-config/schemas/v2/index.d.ts +3384 -1895
  3. package/dist/mint-config/schemas/v2/index.js +2 -0
  4. package/dist/mint-config/schemas/v2/properties/contextual.d.ts +12 -6
  5. package/dist/mint-config/schemas/v2/properties/contextual.js +7 -0
  6. package/dist/mint-config/schemas/v2/properties/navigation/divisionNav.d.ts +12 -4
  7. package/dist/mint-config/schemas/v2/properties/navigation/groups.d.ts +24 -717
  8. package/dist/mint-config/schemas/v2/properties/navigation/index.d.ts +362 -429
  9. package/dist/mint-config/schemas/v2/properties/navigation/index.js +1 -1
  10. package/dist/mint-config/schemas/v2/properties/navigation/pages.d.ts +177 -4
  11. package/dist/mint-config/schemas/v2/properties/navigation/tabs.d.ts +8 -0
  12. package/dist/mint-config/schemas/v2/properties/navigation/tabs.js +2 -0
  13. package/dist/mint-config/schemas/v2/properties/reusable/page.d.ts +101 -55
  14. package/dist/mint-config/schemas/v2/properties/reusable/page.js +12 -0
  15. package/dist/mint-config/schemas/v2/themes/almond.d.ts +152 -239
  16. package/dist/mint-config/schemas/v2/themes/aspen.d.ts +152 -239
  17. package/dist/mint-config/schemas/v2/themes/linden.d.ts +152 -239
  18. package/dist/mint-config/schemas/v2/themes/maple.d.ts +152 -239
  19. package/dist/mint-config/schemas/v2/themes/mint.d.ts +152 -239
  20. package/dist/mint-config/schemas/v2/themes/palm.d.ts +152 -239
  21. package/dist/mint-config/schemas/v2/themes/reusable/index.d.ts +100 -187
  22. package/dist/mint-config/schemas/v2/themes/sequoia.d.ts +2187 -0
  23. package/dist/mint-config/schemas/v2/themes/sequoia.js +4 -0
  24. package/dist/mint-config/schemas/v2/themes/themes.d.ts +2 -2
  25. package/dist/mint-config/schemas/v2/themes/themes.js +10 -1
  26. package/dist/mint-config/schemas/v2/themes/willow.d.ts +152 -239
  27. package/dist/mint-config/upgrades/convertMintDecoratedNavToDocsDecoratedNav.js +7 -3
  28. package/dist/mint-config/validateConfig.d.ts +1072 -380
  29. package/dist/tsconfig.build.tsbuildinfo +1 -1
  30. package/package.json +3 -3
@@ -6,7 +6,7 @@ import { decoratedGroupsSchema, groupsSchema, } from './groups.js';
6
6
  import { decoratedLanguagesSchema, languagesSchema, } from './languages.js';
7
7
  import { decoratedPagesSchema, pagesSchema } from './pages.js';
8
8
  import { decoratedProductsSchema, productsSchema, } from './products.js';
9
- import { decoratedTabsSchema, tabsSchema } from './tabs.js';
9
+ import { decoratedTabsSchema, tabsSchema, } from './tabs.js';
10
10
  import { decoratedVersionsSchema, versionsSchema, } from './version.js';
11
11
  const baseNavigationSchema = z.object({ global: globalSchema.optional() });
12
12
  export const navigationSchema = z
@@ -1,9 +1,182 @@
1
1
  import { z } from 'zod';
2
2
  import { pageSchema } from '../reusable/page.js';
3
- export declare const pageOrGroupSchema: z.ZodType;
4
- export declare const decoratedPageOrGroupSchema: z.ZodType;
5
- export declare const pagesSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">;
6
- export declare const decoratedPagesSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">;
3
+ import { PageOrGroupNavigation } from './divisionNav.js';
4
+ export declare const pageOrGroupSchema: z.ZodType<PageOrGroupNavigation<'default'>>;
5
+ export declare const decoratedPageOrGroupSchema: z.ZodType<PageOrGroupNavigation<'decorated'>>;
6
+ export declare const pagesSchema: z.ZodArray<z.ZodType<string | ({
7
+ group: string;
8
+ icon?: string | {
9
+ name: string;
10
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
11
+ library?: "fontawesome" | "lucide" | undefined;
12
+ } | undefined;
13
+ expanded?: boolean | undefined;
14
+ public?: boolean | undefined;
15
+ tag?: string | undefined;
16
+ hidden?: boolean | undefined;
17
+ root?: string | undefined;
18
+ } & {
19
+ openapi?: string | string[] | {
20
+ source: string;
21
+ directory?: string | undefined;
22
+ } | undefined;
23
+ asyncapi?: string | string[] | {
24
+ source: string;
25
+ directory?: string | undefined;
26
+ } | undefined;
27
+ } & {
28
+ pages?: PageOrGroupNavigation<"default">[];
29
+ }), z.ZodTypeDef, string | ({
30
+ group: string;
31
+ icon?: string | {
32
+ name: string;
33
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
34
+ library?: "fontawesome" | "lucide" | undefined;
35
+ } | undefined;
36
+ expanded?: boolean | undefined;
37
+ public?: boolean | undefined;
38
+ tag?: string | undefined;
39
+ hidden?: boolean | undefined;
40
+ root?: string | undefined;
41
+ } & {
42
+ openapi?: string | string[] | {
43
+ source: string;
44
+ directory?: string | undefined;
45
+ } | undefined;
46
+ asyncapi?: string | string[] | {
47
+ source: string;
48
+ directory?: string | undefined;
49
+ } | undefined;
50
+ } & {
51
+ pages?: PageOrGroupNavigation<"default">[];
52
+ })>, "many">;
53
+ export declare const decoratedPagesSchema: z.ZodArray<z.ZodType<z.objectOutputType<{
54
+ href: z.ZodString;
55
+ title: z.ZodString;
56
+ sidebarTitle: z.ZodOptional<z.ZodString>;
57
+ description: z.ZodOptional<z.ZodString>;
58
+ canonical: z.ZodOptional<z.ZodString>;
59
+ 'og:title': z.ZodOptional<z.ZodString>;
60
+ 'og:url': z.ZodOptional<z.ZodString>;
61
+ api: z.ZodOptional<z.ZodString>;
62
+ openapi: z.ZodOptional<z.ZodString>;
63
+ asyncapi: z.ZodOptional<z.ZodString>;
64
+ contentType: z.ZodOptional<z.ZodString>;
65
+ authMethod: z.ZodOptional<z.ZodString>;
66
+ auth: z.ZodOptional<z.ZodString>;
67
+ version: z.ZodOptional<z.ZodString>;
68
+ mode: z.ZodOptional<z.ZodString>;
69
+ hideFooterPagination: z.ZodOptional<z.ZodBoolean>;
70
+ authors: z.ZodOptional<z.ZodUnknown>;
71
+ lastUpdatedDate: z.ZodOptional<z.ZodString>;
72
+ createdDate: z.ZodOptional<z.ZodString>;
73
+ 'openapi-schema': z.ZodOptional<z.ZodString>;
74
+ icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
75
+ style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
76
+ name: z.ZodEffects<z.ZodString, string, string>;
77
+ library: z.ZodOptional<z.ZodEnum<["fontawesome", "lucide"]>>;
78
+ }, "strip", z.ZodTypeAny, {
79
+ name: string;
80
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
81
+ library?: "fontawesome" | "lucide" | undefined;
82
+ }, {
83
+ name: string;
84
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
85
+ library?: "fontawesome" | "lucide" | undefined;
86
+ }>]>>;
87
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
88
+ tag: z.ZodOptional<z.ZodString>;
89
+ url: z.ZodOptional<z.ZodString>;
90
+ hideApiMarker: z.ZodOptional<z.ZodBoolean>;
91
+ noindex: z.ZodOptional<z.ZodBoolean>;
92
+ isPublic: z.ZodOptional<z.ZodBoolean>;
93
+ public: z.ZodOptional<z.ZodBoolean>;
94
+ deprecated: z.ZodOptional<z.ZodBoolean>;
95
+ hidden: z.ZodOptional<z.ZodBoolean>;
96
+ groups: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
97
+ robots: z.ZodOptional<z.ZodString>;
98
+ playground: z.ZodOptional<z.ZodEnum<["interactive", "simple", "none", "auth"]>>;
99
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
100
+ timestamp: z.ZodOptional<z.ZodBoolean>;
101
+ }, z.ZodTypeAny, "passthrough"> | (Omit<{
102
+ group: string;
103
+ icon?: string | {
104
+ name: string;
105
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
106
+ library?: "fontawesome" | "lucide" | undefined;
107
+ } | undefined;
108
+ expanded?: boolean | undefined;
109
+ public?: boolean | undefined;
110
+ tag?: string | undefined;
111
+ hidden?: boolean | undefined;
112
+ root?: string | undefined;
113
+ }, "root"> & {
114
+ pages: PageOrGroupNavigation<"decorated">[];
115
+ root?: import("../reusable/page.js").DecoratedPageConfig;
116
+ }), z.ZodTypeDef, z.objectOutputType<{
117
+ href: z.ZodString;
118
+ title: z.ZodString;
119
+ sidebarTitle: z.ZodOptional<z.ZodString>;
120
+ description: z.ZodOptional<z.ZodString>;
121
+ canonical: z.ZodOptional<z.ZodString>;
122
+ 'og:title': z.ZodOptional<z.ZodString>;
123
+ 'og:url': z.ZodOptional<z.ZodString>;
124
+ api: z.ZodOptional<z.ZodString>;
125
+ openapi: z.ZodOptional<z.ZodString>;
126
+ asyncapi: z.ZodOptional<z.ZodString>;
127
+ contentType: z.ZodOptional<z.ZodString>;
128
+ authMethod: z.ZodOptional<z.ZodString>;
129
+ auth: z.ZodOptional<z.ZodString>;
130
+ version: z.ZodOptional<z.ZodString>;
131
+ mode: z.ZodOptional<z.ZodString>;
132
+ hideFooterPagination: z.ZodOptional<z.ZodBoolean>;
133
+ authors: z.ZodOptional<z.ZodUnknown>;
134
+ lastUpdatedDate: z.ZodOptional<z.ZodString>;
135
+ createdDate: z.ZodOptional<z.ZodString>;
136
+ 'openapi-schema': z.ZodOptional<z.ZodString>;
137
+ icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
138
+ style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
139
+ name: z.ZodEffects<z.ZodString, string, string>;
140
+ library: z.ZodOptional<z.ZodEnum<["fontawesome", "lucide"]>>;
141
+ }, "strip", z.ZodTypeAny, {
142
+ name: string;
143
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
144
+ library?: "fontawesome" | "lucide" | undefined;
145
+ }, {
146
+ name: string;
147
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
148
+ library?: "fontawesome" | "lucide" | undefined;
149
+ }>]>>;
150
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
151
+ tag: z.ZodOptional<z.ZodString>;
152
+ url: z.ZodOptional<z.ZodString>;
153
+ hideApiMarker: z.ZodOptional<z.ZodBoolean>;
154
+ noindex: z.ZodOptional<z.ZodBoolean>;
155
+ isPublic: z.ZodOptional<z.ZodBoolean>;
156
+ public: z.ZodOptional<z.ZodBoolean>;
157
+ deprecated: z.ZodOptional<z.ZodBoolean>;
158
+ hidden: z.ZodOptional<z.ZodBoolean>;
159
+ groups: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
160
+ robots: z.ZodOptional<z.ZodString>;
161
+ playground: z.ZodOptional<z.ZodEnum<["interactive", "simple", "none", "auth"]>>;
162
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
163
+ timestamp: z.ZodOptional<z.ZodBoolean>;
164
+ }, z.ZodTypeAny, "passthrough"> | (Omit<{
165
+ group: string;
166
+ icon?: string | {
167
+ name: string;
168
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
169
+ library?: "fontawesome" | "lucide" | undefined;
170
+ } | undefined;
171
+ expanded?: boolean | undefined;
172
+ public?: boolean | undefined;
173
+ tag?: string | undefined;
174
+ hidden?: boolean | undefined;
175
+ root?: string | undefined;
176
+ }, "root"> & {
177
+ pages: PageOrGroupNavigation<"decorated">[];
178
+ root?: import("../reusable/page.js").DecoratedPageConfig;
179
+ })>, "many">;
7
180
  export type PageConfig = z.infer<typeof pageSchema>;
8
181
  export type PagesConfig = z.infer<typeof pagesSchema>;
9
182
  export type DecoratedPagesConfig = z.infer<typeof decoratedPagesSchema>;
@@ -1,5 +1,7 @@
1
1
  import { z } from 'zod';
2
2
  import { TabNavigation } from './divisionNav.js';
3
+ export declare const tabAlignSchema: z.ZodEnum<["start", "end"]>;
4
+ export type TabAlign = z.infer<typeof tabAlignSchema>;
3
5
  export declare const baseTabSchema: z.ZodObject<{
4
6
  tab: z.ZodString;
5
7
  icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
@@ -16,6 +18,7 @@ export declare const baseTabSchema: z.ZodObject<{
16
18
  library?: "fontawesome" | "lucide" | undefined;
17
19
  }>]>>;
18
20
  hidden: z.ZodOptional<z.ZodBoolean>;
21
+ align: z.ZodOptional<z.ZodEnum<["start", "end"]>>;
19
22
  }, "strip", z.ZodTypeAny, {
20
23
  tab: string;
21
24
  icon?: string | {
@@ -24,6 +27,7 @@ export declare const baseTabSchema: z.ZodObject<{
24
27
  library?: "fontawesome" | "lucide" | undefined;
25
28
  } | undefined;
26
29
  hidden?: boolean | undefined;
30
+ align?: "start" | "end" | undefined;
27
31
  }, {
28
32
  tab: string;
29
33
  icon?: string | {
@@ -32,6 +36,7 @@ export declare const baseTabSchema: z.ZodObject<{
32
36
  library?: "fontawesome" | "lucide" | undefined;
33
37
  } | undefined;
34
38
  hidden?: boolean | undefined;
39
+ align?: "start" | "end" | undefined;
35
40
  }>;
36
41
  export type BaseTabSchema = z.infer<typeof baseTabSchema>;
37
42
  export declare const nonRecursiveTabSchema: z.ZodObject<z.objectUtil.extendShape<{
@@ -50,6 +55,7 @@ export declare const nonRecursiveTabSchema: z.ZodObject<z.objectUtil.extendShape
50
55
  library?: "fontawesome" | "lucide" | undefined;
51
56
  }>]>>;
52
57
  hidden: z.ZodOptional<z.ZodBoolean>;
58
+ align: z.ZodOptional<z.ZodEnum<["start", "end"]>>;
53
59
  }, {
54
60
  href: z.ZodEffects<z.ZodString, string, string>;
55
61
  }>, "strip", z.ZodTypeAny, {
@@ -61,6 +67,7 @@ export declare const nonRecursiveTabSchema: z.ZodObject<z.objectUtil.extendShape
61
67
  library?: "fontawesome" | "lucide" | undefined;
62
68
  } | undefined;
63
69
  hidden?: boolean | undefined;
70
+ align?: "start" | "end" | undefined;
64
71
  }, {
65
72
  href: string;
66
73
  tab: string;
@@ -70,6 +77,7 @@ export declare const nonRecursiveTabSchema: z.ZodObject<z.objectUtil.extendShape
70
77
  library?: "fontawesome" | "lucide" | undefined;
71
78
  } | undefined;
72
79
  hidden?: boolean | undefined;
80
+ align?: "start" | "end" | undefined;
73
81
  }>;
74
82
  export declare const tabSchema: z.ZodType<TabNavigation<'default'>>;
75
83
  export declare const decoratedTabSchema: z.ZodType<TabNavigation<'decorated'>>;
@@ -13,10 +13,12 @@ import { decoratedMenuSchema, menuSchema } from './menu.js';
13
13
  import { decoratedPagesSchema, pagesSchema } from './pages.js';
14
14
  import { decoratedProductsSchema, productsSchema } from './products.js';
15
15
  import { decoratedVersionsSchema, versionsSchema } from './version.js';
16
+ export const tabAlignSchema = z.enum(['start', 'end']).describe('Tab alignment in the navigation');
16
17
  export const baseTabSchema = z.object({
17
18
  tab: z.string().nonempty().describe('The name of the tab'),
18
19
  icon: iconSchema.optional(),
19
20
  hidden: hiddenSchema.optional(),
21
+ align: tabAlignSchema.optional(),
20
22
  });
21
23
  export const nonRecursiveTabSchema = baseTabSchema.extend({ href: hrefSchema });
22
24
  export const tabSchema = z.union([
@@ -5,6 +5,9 @@ export declare const decoratedPageSchema: z.ZodObject<{
5
5
  title: z.ZodString;
6
6
  sidebarTitle: z.ZodOptional<z.ZodString>;
7
7
  description: z.ZodOptional<z.ZodString>;
8
+ canonical: z.ZodOptional<z.ZodString>;
9
+ 'og:title': z.ZodOptional<z.ZodString>;
10
+ 'og:url': z.ZodOptional<z.ZodString>;
8
11
  api: z.ZodOptional<z.ZodString>;
9
12
  openapi: z.ZodOptional<z.ZodString>;
10
13
  asyncapi: z.ZodOptional<z.ZodString>;
@@ -31,6 +34,7 @@ export declare const decoratedPageSchema: z.ZodObject<{
31
34
  style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
32
35
  library?: "fontawesome" | "lucide" | undefined;
33
36
  }>]>>;
37
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
34
38
  tag: z.ZodOptional<z.ZodString>;
35
39
  url: z.ZodOptional<z.ZodString>;
36
40
  hideApiMarker: z.ZodOptional<z.ZodBoolean>;
@@ -38,65 +42,107 @@ export declare const decoratedPageSchema: z.ZodObject<{
38
42
  isPublic: z.ZodOptional<z.ZodBoolean>;
39
43
  public: z.ZodOptional<z.ZodBoolean>;
40
44
  deprecated: z.ZodOptional<z.ZodBoolean>;
41
- }, "strip", z.ZodTypeAny, {
42
- href: string;
43
- title: string;
44
- url?: string | undefined;
45
- icon?: string | {
45
+ hidden: z.ZodOptional<z.ZodBoolean>;
46
+ groups: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
47
+ robots: z.ZodOptional<z.ZodString>;
48
+ playground: z.ZodOptional<z.ZodEnum<["interactive", "simple", "none", "auth"]>>;
49
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
50
+ timestamp: z.ZodOptional<z.ZodBoolean>;
51
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
52
+ href: z.ZodString;
53
+ title: z.ZodString;
54
+ sidebarTitle: z.ZodOptional<z.ZodString>;
55
+ description: z.ZodOptional<z.ZodString>;
56
+ canonical: z.ZodOptional<z.ZodString>;
57
+ 'og:title': z.ZodOptional<z.ZodString>;
58
+ 'og:url': z.ZodOptional<z.ZodString>;
59
+ api: z.ZodOptional<z.ZodString>;
60
+ openapi: z.ZodOptional<z.ZodString>;
61
+ asyncapi: z.ZodOptional<z.ZodString>;
62
+ contentType: z.ZodOptional<z.ZodString>;
63
+ authMethod: z.ZodOptional<z.ZodString>;
64
+ auth: z.ZodOptional<z.ZodString>;
65
+ version: z.ZodOptional<z.ZodString>;
66
+ mode: z.ZodOptional<z.ZodString>;
67
+ hideFooterPagination: z.ZodOptional<z.ZodBoolean>;
68
+ authors: z.ZodOptional<z.ZodUnknown>;
69
+ lastUpdatedDate: z.ZodOptional<z.ZodString>;
70
+ createdDate: z.ZodOptional<z.ZodString>;
71
+ 'openapi-schema': z.ZodOptional<z.ZodString>;
72
+ icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
73
+ style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
74
+ name: z.ZodEffects<z.ZodString, string, string>;
75
+ library: z.ZodOptional<z.ZodEnum<["fontawesome", "lucide"]>>;
76
+ }, "strip", z.ZodTypeAny, {
77
+ name: string;
78
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
79
+ library?: "fontawesome" | "lucide" | undefined;
80
+ }, {
81
+ name: string;
82
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
83
+ library?: "fontawesome" | "lucide" | undefined;
84
+ }>]>>;
85
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
86
+ tag: z.ZodOptional<z.ZodString>;
87
+ url: z.ZodOptional<z.ZodString>;
88
+ hideApiMarker: z.ZodOptional<z.ZodBoolean>;
89
+ noindex: z.ZodOptional<z.ZodBoolean>;
90
+ isPublic: z.ZodOptional<z.ZodBoolean>;
91
+ public: z.ZodOptional<z.ZodBoolean>;
92
+ deprecated: z.ZodOptional<z.ZodBoolean>;
93
+ hidden: z.ZodOptional<z.ZodBoolean>;
94
+ groups: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
95
+ robots: z.ZodOptional<z.ZodString>;
96
+ playground: z.ZodOptional<z.ZodEnum<["interactive", "simple", "none", "auth"]>>;
97
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
98
+ timestamp: z.ZodOptional<z.ZodBoolean>;
99
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
100
+ href: z.ZodString;
101
+ title: z.ZodString;
102
+ sidebarTitle: z.ZodOptional<z.ZodString>;
103
+ description: z.ZodOptional<z.ZodString>;
104
+ canonical: z.ZodOptional<z.ZodString>;
105
+ 'og:title': z.ZodOptional<z.ZodString>;
106
+ 'og:url': z.ZodOptional<z.ZodString>;
107
+ api: z.ZodOptional<z.ZodString>;
108
+ openapi: z.ZodOptional<z.ZodString>;
109
+ asyncapi: z.ZodOptional<z.ZodString>;
110
+ contentType: z.ZodOptional<z.ZodString>;
111
+ authMethod: z.ZodOptional<z.ZodString>;
112
+ auth: z.ZodOptional<z.ZodString>;
113
+ version: z.ZodOptional<z.ZodString>;
114
+ mode: z.ZodOptional<z.ZodString>;
115
+ hideFooterPagination: z.ZodOptional<z.ZodBoolean>;
116
+ authors: z.ZodOptional<z.ZodUnknown>;
117
+ lastUpdatedDate: z.ZodOptional<z.ZodString>;
118
+ createdDate: z.ZodOptional<z.ZodString>;
119
+ 'openapi-schema': z.ZodOptional<z.ZodString>;
120
+ icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
121
+ style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
122
+ name: z.ZodEffects<z.ZodString, string, string>;
123
+ library: z.ZodOptional<z.ZodEnum<["fontawesome", "lucide"]>>;
124
+ }, "strip", z.ZodTypeAny, {
46
125
  name: string;
47
126
  style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
48
127
  library?: "fontawesome" | "lucide" | undefined;
49
- } | undefined;
50
- version?: string | undefined;
51
- openapi?: string | undefined;
52
- auth?: string | undefined;
53
- mode?: string | undefined;
54
- public?: boolean | undefined;
55
- api?: string | undefined;
56
- asyncapi?: string | undefined;
57
- description?: string | undefined;
58
- sidebarTitle?: string | undefined;
59
- contentType?: string | undefined;
60
- authMethod?: string | undefined;
61
- hideFooterPagination?: boolean | undefined;
62
- authors?: unknown;
63
- lastUpdatedDate?: string | undefined;
64
- createdDate?: string | undefined;
65
- 'openapi-schema'?: string | undefined;
66
- tag?: string | undefined;
67
- hideApiMarker?: boolean | undefined;
68
- noindex?: boolean | undefined;
69
- isPublic?: boolean | undefined;
70
- deprecated?: boolean | undefined;
71
- }, {
72
- href: string;
73
- title: string;
74
- url?: string | undefined;
75
- icon?: string | {
128
+ }, {
76
129
  name: string;
77
130
  style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
78
131
  library?: "fontawesome" | "lucide" | undefined;
79
- } | undefined;
80
- version?: string | undefined;
81
- openapi?: string | undefined;
82
- auth?: string | undefined;
83
- mode?: string | undefined;
84
- public?: boolean | undefined;
85
- api?: string | undefined;
86
- asyncapi?: string | undefined;
87
- description?: string | undefined;
88
- sidebarTitle?: string | undefined;
89
- contentType?: string | undefined;
90
- authMethod?: string | undefined;
91
- hideFooterPagination?: boolean | undefined;
92
- authors?: unknown;
93
- lastUpdatedDate?: string | undefined;
94
- createdDate?: string | undefined;
95
- 'openapi-schema'?: string | undefined;
96
- tag?: string | undefined;
97
- hideApiMarker?: boolean | undefined;
98
- noindex?: boolean | undefined;
99
- isPublic?: boolean | undefined;
100
- deprecated?: boolean | undefined;
101
- }>;
132
+ }>]>>;
133
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>;
134
+ tag: z.ZodOptional<z.ZodString>;
135
+ url: z.ZodOptional<z.ZodString>;
136
+ hideApiMarker: z.ZodOptional<z.ZodBoolean>;
137
+ noindex: z.ZodOptional<z.ZodBoolean>;
138
+ isPublic: z.ZodOptional<z.ZodBoolean>;
139
+ public: z.ZodOptional<z.ZodBoolean>;
140
+ deprecated: z.ZodOptional<z.ZodBoolean>;
141
+ hidden: z.ZodOptional<z.ZodBoolean>;
142
+ groups: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
143
+ robots: z.ZodOptional<z.ZodString>;
144
+ playground: z.ZodOptional<z.ZodEnum<["interactive", "simple", "none", "auth"]>>;
145
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
146
+ timestamp: z.ZodOptional<z.ZodBoolean>;
147
+ }, z.ZodTypeAny, "passthrough">>;
102
148
  export type DecoratedPageConfig = z.infer<typeof decoratedPageSchema>;
@@ -1,3 +1,4 @@
1
+ import { apiPlaygroundDisplayTypes, iconTypes } from '@mintlify/models';
1
2
  import { z } from 'zod';
2
3
  import { normalizeRelativePath } from '../../../../transforms/normalizeRelativePath.js';
3
4
  import { iconSchema } from './icon.js';
@@ -12,6 +13,9 @@ export const decoratedPageSchema = z
12
13
  title: z.string(),
13
14
  sidebarTitle: z.string().optional(),
14
15
  description: z.string().optional(),
16
+ canonical: z.string().optional(),
17
+ 'og:title': z.string().optional(),
18
+ 'og:url': z.string().optional(),
15
19
  api: z.string().optional(),
16
20
  openapi: z.string().optional(),
17
21
  asyncapi: z.string().optional(),
@@ -26,6 +30,7 @@ export const decoratedPageSchema = z
26
30
  createdDate: z.string().optional(),
27
31
  'openapi-schema': z.string().optional(),
28
32
  icon: iconSchema.optional(),
33
+ iconType: z.enum(iconTypes).optional().describe('Deprecated, use icon instead'),
29
34
  tag: z.string().optional(),
30
35
  url: z.string().optional(),
31
36
  hideApiMarker: z.boolean().optional(),
@@ -33,5 +38,12 @@ export const decoratedPageSchema = z
33
38
  isPublic: z.boolean().optional(),
34
39
  public: z.boolean().optional(),
35
40
  deprecated: z.boolean().optional(),
41
+ hidden: z.boolean().optional(),
42
+ groups: z.array(z.string()).optional(),
43
+ robots: z.string().optional(),
44
+ playground: z.enum(apiPlaygroundDisplayTypes).optional(),
45
+ keywords: z.array(z.string()).optional(),
46
+ timestamp: z.boolean().optional(),
36
47
  })
48
+ .passthrough()
37
49
  .describe('page metadata tags in the navigation');