@mintlify/validation 0.1.250 → 0.1.252

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 (27) hide show
  1. package/README.md +1 -0
  2. package/dist/index.d.ts +1 -1
  3. package/dist/index.js +1 -1
  4. package/dist/mint-config/schemas/v2/index.d.ts +920 -155
  5. package/dist/mint-config/schemas/v2/properties/api.d.ts +18 -3
  6. package/dist/mint-config/schemas/v2/properties/navigation/anchors.d.ts +72 -12
  7. package/dist/mint-config/schemas/v2/properties/navigation/dropdown.d.ts +72 -12
  8. package/dist/mint-config/schemas/v2/properties/navigation/groups.d.ts +96 -12
  9. package/dist/mint-config/schemas/v2/properties/navigation/index.d.ts +256 -40
  10. package/dist/mint-config/schemas/v2/properties/navigation/languages.d.ts +80 -20
  11. package/dist/mint-config/schemas/v2/properties/navigation/pages.d.ts +5 -0
  12. package/dist/mint-config/schemas/v2/properties/navigation/tabs.d.ts +72 -12
  13. package/dist/mint-config/schemas/v2/properties/navigation/version.d.ts +80 -20
  14. package/dist/mint-config/schemas/v2/properties/reusable/openapi.d.ts +22 -1
  15. package/dist/mint-config/schemas/v2/properties/reusable/openapi.js +7 -1
  16. package/dist/mint-config/schemas/v2/themes/linden.d.ts +182 -29
  17. package/dist/mint-config/schemas/v2/themes/maple.d.ts +182 -29
  18. package/dist/mint-config/schemas/v2/themes/mint.d.ts +182 -29
  19. package/dist/mint-config/schemas/v2/themes/palm.d.ts +182 -29
  20. package/dist/mint-config/schemas/v2/themes/reusable/index.d.ts +146 -23
  21. package/dist/mint-config/schemas/v2/themes/willow.d.ts +182 -29
  22. package/dist/mint-config/upgrades/updateNavigationToDocsConfig.js +9 -7
  23. package/dist/mint-config/validateConfig.d.ts +4333 -0
  24. package/dist/mint-config/{validateMintConfig.js → validateConfig.js} +10 -0
  25. package/dist/tsconfig.build.tsbuildinfo +1 -1
  26. package/package.json +2 -2
  27. package/dist/mint-config/validateMintConfig.d.ts +0 -478
package/dist/mint-config/schemas/v2/themes/willow.d.ts CHANGED
@@ -40,7 +40,16 @@ export declare const willowConfigSchema: z.ZodObject<{
40
40
  dark: string;
41
41
  }>]>>;
42
42
  api: z.ZodOptional<z.ZodObject<{
43
- openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
43
+ openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
44
+ source: z.ZodEffects<z.ZodString, string, string>;
45
+ directory: z.ZodOptional<z.ZodString>;
46
+ }, "strict", z.ZodTypeAny, {
47
+ source: string;
48
+ directory?: string | undefined;
49
+ }, {
50
+ source: string;
51
+ directory?: string | undefined;
52
+ }>]>>;
44
53
  playground: z.ZodOptional<z.ZodObject<{
45
54
  display: z.ZodOptional<z.ZodEnum<["interactive", "simple", "none"]>>;
46
55
  proxy: z.ZodOptional<z.ZodBoolean>;
@@ -69,7 +78,10 @@ export declare const willowConfigSchema: z.ZodObject<{
69
78
  server?: string | string[] | undefined;
70
79
  }>>;
71
80
  }, "strip", z.ZodTypeAny, {
72
- openapi?: string | string[] | undefined;
81
+ openapi?: string | string[] | {
82
+ source: string;
83
+ directory?: string | undefined;
84
+ } | undefined;
73
85
  playground?: {
74
86
  display?: "simple" | "none" | "interactive" | undefined;
75
87
  proxy?: boolean | undefined;
@@ -82,7 +94,10 @@ export declare const willowConfigSchema: z.ZodObject<{
82
94
  server?: string | string[] | undefined;
83
95
  } | undefined;
84
96
  }, {
85
- openapi?: string | string[] | undefined;
97
+ openapi?: string | string[] | {
98
+ source: string;
99
+ directory?: string | undefined;
100
+ } | undefined;
86
101
  playground?: {
87
102
  display?: "simple" | "none" | "interactive" | undefined;
88
103
  proxy?: boolean | undefined;
@@ -587,11 +602,26 @@ export declare const willowConfigSchema: z.ZodObject<{
587
602
  }, {
588
603
  href: string;
589
604
  }>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, z.ZodObject<{
590
- openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
605
+ openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
606
+ source: z.ZodEffects<z.ZodString, string, string>;
607
+ directory: z.ZodOptional<z.ZodString>;
608
+ }, "strict", z.ZodTypeAny, {
609
+ source: string;
610
+ directory?: string | undefined;
611
+ }, {
612
+ source: string;
613
+ directory?: string | undefined;
614
+ }>]>>;
591
615
  }, "strip", z.ZodTypeAny, {
592
- openapi?: string | string[] | undefined;
616
+ openapi?: string | string[] | {
617
+ source: string;
618
+ directory?: string | undefined;
619
+ } | undefined;
593
620
  }, {
594
- openapi?: string | string[] | undefined;
621
+ openapi?: string | string[] | {
622
+ source: string;
623
+ directory?: string | undefined;
624
+ } | undefined;
595
625
  }>>, "many">;
596
626
  }, "strip", z.ZodTypeAny, {
597
627
  languages: any[];
@@ -629,11 +659,26 @@ export declare const willowConfigSchema: z.ZodObject<{
629
659
  }, {
630
660
  href: string;
631
661
  }>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, z.ZodObject<{
632
- openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
662
+ openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
663
+ source: z.ZodEffects<z.ZodString, string, string>;
664
+ directory: z.ZodOptional<z.ZodString>;
665
+ }, "strict", z.ZodTypeAny, {
666
+ source: string;
667
+ directory?: string | undefined;
668
+ }, {
669
+ source: string;
670
+ directory?: string | undefined;
671
+ }>]>>;
633
672
  }, "strip", z.ZodTypeAny, {
634
- openapi?: string | string[] | undefined;
673
+ openapi?: string | string[] | {
674
+ source: string;
675
+ directory?: string | undefined;
676
+ } | undefined;
635
677
  }, {
636
- openapi?: string | string[] | undefined;
678
+ openapi?: string | string[] | {
679
+ source: string;
680
+ directory?: string | undefined;
681
+ } | undefined;
637
682
  }>>, "many">;
638
683
  }, "strip", z.ZodTypeAny, {
639
684
  versions: any[];
@@ -707,11 +752,26 @@ export declare const willowConfigSchema: z.ZodObject<{
707
752
  }, {
708
753
  href: string;
709
754
  }>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, z.ZodObject<{
710
- openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
755
+ openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
756
+ source: z.ZodEffects<z.ZodString, string, string>;
757
+ directory: z.ZodOptional<z.ZodString>;
758
+ }, "strict", z.ZodTypeAny, {
759
+ source: string;
760
+ directory?: string | undefined;
761
+ }, {
762
+ source: string;
763
+ directory?: string | undefined;
764
+ }>]>>;
711
765
  }, "strip", z.ZodTypeAny, {
712
- openapi?: string | string[] | undefined;
766
+ openapi?: string | string[] | {
767
+ source: string;
768
+ directory?: string | undefined;
769
+ } | undefined;
713
770
  }, {
714
- openapi?: string | string[] | undefined;
771
+ openapi?: string | string[] | {
772
+ source: string;
773
+ directory?: string | undefined;
774
+ } | undefined;
715
775
  }>>, "many">;
716
776
  }, "strip", z.ZodTypeAny, {
717
777
  tabs: any[];
@@ -785,11 +845,26 @@ export declare const willowConfigSchema: z.ZodObject<{
785
845
  }, {
786
846
  href: string;
787
847
  }>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, z.ZodObject<{
788
- openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
848
+ openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
849
+ source: z.ZodEffects<z.ZodString, string, string>;
850
+ directory: z.ZodOptional<z.ZodString>;
851
+ }, "strict", z.ZodTypeAny, {
852
+ source: string;
853
+ directory?: string | undefined;
854
+ }, {
855
+ source: string;
856
+ directory?: string | undefined;
857
+ }>]>>;
789
858
  }, "strip", z.ZodTypeAny, {
790
- openapi?: string | string[] | undefined;
859
+ openapi?: string | string[] | {
860
+ source: string;
861
+ directory?: string | undefined;
862
+ } | undefined;
791
863
  }, {
792
- openapi?: string | string[] | undefined;
864
+ openapi?: string | string[] | {
865
+ source: string;
866
+ directory?: string | undefined;
867
+ } | undefined;
793
868
  }>>, "many">;
794
869
  }, "strip", z.ZodTypeAny, {
795
870
  dropdowns: any[];
@@ -899,11 +974,26 @@ export declare const willowConfigSchema: z.ZodObject<{
899
974
  }, {
900
975
  href: string;
901
976
  }>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, z.ZodObject<{
902
- openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
977
+ openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
978
+ source: z.ZodEffects<z.ZodString, string, string>;
979
+ directory: z.ZodOptional<z.ZodString>;
980
+ }, "strict", z.ZodTypeAny, {
981
+ source: string;
982
+ directory?: string | undefined;
983
+ }, {
984
+ source: string;
985
+ directory?: string | undefined;
986
+ }>]>>;
903
987
  }, "strip", z.ZodTypeAny, {
904
- openapi?: string | string[] | undefined;
988
+ openapi?: string | string[] | {
989
+ source: string;
990
+ directory?: string | undefined;
991
+ } | undefined;
905
992
  }, {
906
- openapi?: string | string[] | undefined;
993
+ openapi?: string | string[] | {
994
+ source: string;
995
+ directory?: string | undefined;
996
+ } | undefined;
907
997
  }>>, "many">;
908
998
  }, "strip", z.ZodTypeAny, {
909
999
  anchors: any[];
@@ -1077,11 +1167,32 @@ export declare const willowConfigSchema: z.ZodObject<{
1077
1167
  isPublic?: boolean | undefined;
1078
1168
  } | undefined;
1079
1169
  }>, z.ZodUnion<[z.ZodObject<{
1080
- openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>;
1170
+ openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
1171
+ source: z.ZodEffects<z.ZodString, string, string>;
1172
+ directory: z.ZodOptional<z.ZodString>;
1173
+ }, "strict", z.ZodTypeAny, {
1174
+ source: string;
1175
+ directory?: string | undefined;
1176
+ }, {
1177
+ source: string;
1178
+ directory?: string | undefined;
1179
+ }>]>;
1081
1180
  }, "strip", z.ZodTypeAny, {
1082
- openapi: (string | string[]) & (string | string[] | undefined);
1181
+ openapi: (string | string[] | {
1182
+ source: string;
1183
+ directory?: string | undefined;
1184
+ }) & (string | string[] | {
1185
+ source: string;
1186
+ directory?: string | undefined;
1187
+ } | undefined);
1083
1188
  }, {
1084
- openapi: (string | string[]) & (string | string[] | undefined);
1189
+ openapi: (string | string[] | {
1190
+ source: string;
1191
+ directory?: string | undefined;
1192
+ }) & (string | string[] | {
1193
+ source: string;
1194
+ directory?: string | undefined;
1195
+ } | undefined);
1085
1196
  }>, z.ZodLazy<z.ZodObject<{
1086
1197
  pages: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">;
1087
1198
  }, "strip", z.ZodTypeAny, {
@@ -1125,7 +1236,13 @@ export declare const willowConfigSchema: z.ZodObject<{
1125
1236
  isPublic?: boolean | undefined;
1126
1237
  } | undefined;
1127
1238
  } & ({
1128
- openapi: (string | string[]) & (string | string[] | undefined);
1239
+ openapi: (string | string[] | {
1240
+ source: string;
1241
+ directory?: string | undefined;
1242
+ }) & (string | string[] | {
1243
+ source: string;
1244
+ directory?: string | undefined;
1245
+ } | undefined);
1129
1246
  } | {
1130
1247
  pages: any[];
1131
1248
  }))[];
@@ -1165,7 +1282,13 @@ export declare const willowConfigSchema: z.ZodObject<{
1165
1282
  isPublic?: boolean | undefined;
1166
1283
  } | undefined;
1167
1284
  } & ({
1168
- openapi: (string | string[]) & (string | string[] | undefined);
1285
+ openapi: (string | string[] | {
1286
+ source: string;
1287
+ directory?: string | undefined;
1288
+ }) & (string | string[] | {
1289
+ source: string;
1290
+ directory?: string | undefined;
1291
+ } | undefined);
1169
1292
  } | {
1170
1293
  pages: any[];
1171
1294
  }))[];
@@ -1730,7 +1853,13 @@ export declare const willowConfigSchema: z.ZodObject<{
1730
1853
  isPublic?: boolean | undefined;
1731
1854
  } | undefined;
1732
1855
  } & ({
1733
- openapi: (string | string[]) & (string | string[] | undefined);
1856
+ openapi: (string | string[] | {
1857
+ source: string;
1858
+ directory?: string | undefined;
1859
+ }) & (string | string[] | {
1860
+ source: string;
1861
+ directory?: string | undefined;
1862
+ } | undefined);
1734
1863
  } | {
1735
1864
  pages: any[];
1736
1865
  }))[];
@@ -1831,7 +1960,13 @@ export declare const willowConfigSchema: z.ZodObject<{
1831
1960
  isPublic?: boolean | undefined;
1832
1961
  } | undefined;
1833
1962
  } & ({
1834
- openapi: (string | string[]) & (string | string[] | undefined);
1963
+ openapi: (string | string[] | {
1964
+ source: string;
1965
+ directory?: string | undefined;
1966
+ }) & (string | string[] | {
1967
+ source: string;
1968
+ directory?: string | undefined;
1969
+ } | undefined);
1835
1970
  } | {
1836
1971
  pages: any[];
1837
1972
  }))[];
@@ -1849,7 +1984,10 @@ export declare const willowConfigSchema: z.ZodObject<{
1849
1984
  dark: string;
1850
1985
  } | undefined;
1851
1986
  api?: {
1852
- openapi?: string | string[] | undefined;
1987
+ openapi?: string | string[] | {
1988
+ source: string;
1989
+ directory?: string | undefined;
1990
+ } | undefined;
1853
1991
  playground?: {
1854
1992
  display?: "simple" | "none" | "interactive" | undefined;
1855
1993
  proxy?: boolean | undefined;
@@ -2099,7 +2237,13 @@ export declare const willowConfigSchema: z.ZodObject<{
2099
2237
  isPublic?: boolean | undefined;
2100
2238
  } | undefined;
2101
2239
  } & ({
2102
- openapi: (string | string[]) & (string | string[] | undefined);
2240
+ openapi: (string | string[] | {
2241
+ source: string;
2242
+ directory?: string | undefined;
2243
+ }) & (string | string[] | {
2244
+ source: string;
2245
+ directory?: string | undefined;
2246
+ } | undefined);
2103
2247
  } | {
2104
2248
  pages: any[];
2105
2249
  }))[];
@@ -2200,7 +2344,13 @@ export declare const willowConfigSchema: z.ZodObject<{
2200
2344
  isPublic?: boolean | undefined;
2201
2345
  } | undefined;
2202
2346
  } & ({
2203
- openapi: (string | string[]) & (string | string[] | undefined);
2347
+ openapi: (string | string[] | {
2348
+ source: string;
2349
+ directory?: string | undefined;
2350
+ }) & (string | string[] | {
2351
+ source: string;
2352
+ directory?: string | undefined;
2353
+ } | undefined);
2204
2354
  } | {
2205
2355
  pages: any[];
2206
2356
  }))[];
@@ -2219,7 +2369,10 @@ export declare const willowConfigSchema: z.ZodObject<{
2219
2369
  dark: string;
2220
2370
  } | undefined;
2221
2371
  api?: {
2222
- openapi?: string | string[] | undefined;
2372
+ openapi?: string | string[] | {
2373
+ source: string;
2374
+ directory?: string | undefined;
2375
+ } | undefined;
2223
2376
  playground?: {
2224
2377
  display?: "simple" | "none" | "interactive" | undefined;
2225
2378
  proxy?: boolean | undefined;
package/dist/mint-config/upgrades/updateNavigationToDocsConfig.js CHANGED
@@ -39,7 +39,7 @@ const getGlobalDivisions = (config) => {
39
39
  }
40
40
  return globalConfig;
41
41
  };
42
- const findPagesForPrefix = (groups, division, versionName) => {
42
+ const findPagesForPrefix = (groups, division, versionName, ignoredDivisions = []) => {
43
43
  const matchedGroups = [];
44
44
  const unmatchedGroups = [];
45
45
  const prefix = division === null || division === void 0 ? void 0 : division.url;
@@ -53,7 +53,8 @@ const findPagesForPrefix = (groups, division, versionName) => {
53
53
  if (isGroupVersionMatch) {
54
54
  group.pages.forEach((page) => {
55
55
  if (typeof page === 'string') {
56
- if (!prefix || page.startsWith(prefix)) {
56
+ if ((!prefix || page.startsWith(prefix)) &&
57
+ !ignoredDivisions.some((d) => page.startsWith(d.url))) {
57
58
  groupPages.push(page);
58
59
  }
59
60
  else {
@@ -61,7 +62,7 @@ const findPagesForPrefix = (groups, division, versionName) => {
61
62
  }
62
63
  }
63
64
  else {
64
- const { matchedGroups: nestedGroups, unmatchedGroups: nestedUnmatchedGroups } = findPagesForPrefix([page], division, versionName);
65
+ const { matchedGroups: nestedGroups, unmatchedGroups: nestedUnmatchedGroups } = findPagesForPrefix([page], division, versionName, ignoredDivisions);
65
66
  groupPages.push(...nestedGroups);
66
67
  if (nestedUnmatchedGroups.length) {
67
68
  unmatchedGroupPages.push(page);
@@ -95,7 +96,8 @@ const processDivisions = (type, divisions = [], navigationGroups = [], shouldIns
95
96
  baseDivision.color = division.color;
96
97
  }
97
98
  }
98
- const { matchedGroups, unmatchedGroups } = findPagesForPrefix(remainingGroups, division, versionName);
99
+ const ignoredDivisions = divisions.filter((d) => d.url.startsWith(division.url) && d.url !== division.url);
100
+ const { matchedGroups, unmatchedGroups } = findPagesForPrefix(remainingGroups, division, versionName, ignoredDivisions);
99
101
  remainingGroups = unmatchedGroups;
100
102
  if (matchedGroups.length) {
101
103
  return Object.assign(Object.assign({}, _.omit(baseDivision, 'href')), { groups: matchedGroups });
@@ -104,7 +106,7 @@ const processDivisions = (type, divisions = [], navigationGroups = [], shouldIns
104
106
  })
105
107
  .filter(Boolean);
106
108
  if (remainingGroups.length && shouldInsertRemainingGroups) {
107
- const { matchedGroups } = findPagesForPrefix(remainingGroups, undefined, versionName);
109
+ const { matchedGroups } = findPagesForPrefix(remainingGroups, undefined, versionName, []);
108
110
  if (type === 'tabs') {
109
111
  result.unshift(Object.assign(Object.assign({}, (((_a = config === null || config === void 0 ? void 0 : config.primaryTab) === null || _a === void 0 ? void 0 : _a.name)
110
112
  ? Object.assign({ tab: config.primaryTab.name }, (config.primaryTab.isDefaultHidden !== undefined && {
@@ -183,9 +185,9 @@ export const updateNavigationToDocsConfig = (config) => {
183
185
  var _a, _b;
184
186
  if ((anchors === null || anchors === void 0 ? void 0 : anchors.length) && !(globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length)) {
185
187
  const { anchors: anchorsResult, remainingGroups } = processDivisions('anchors', anchors, groups, false, versionName, config);
186
- if (remainingGroups.length) {
188
+ if (remainingGroups.length || (tabs === null || tabs === void 0 ? void 0 : tabs.length)) {
187
189
  if ((tabs === null || tabs === void 0 ? void 0 : tabs.length) && !(globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length)) {
188
- const { tabs: tabsResult } = processDivisions('tabs', tabs, remainingGroups, true, versionName, config);
190
+ const { tabs: tabsResult } = processDivisions('tabs', tabs, remainingGroups.length ? remainingGroups : groups, true, versionName, config);
189
191
  anchorsResult.push(Object.assign(Object.assign({}, (((_a = config === null || config === void 0 ? void 0 : config.topAnchor) === null || _a === void 0 ? void 0 : _a.name) ? { anchor: config.topAnchor.name } : DEFAULT_ANCHOR)), { tabs: tabsResult }));
190
192
  }
191
193
  else {