@mintlify/validation 0.1.120 → 0.1.122

package/dist/mint-config/schemas/config.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export declare const configSchema: z.ZodObject<{
+export declare const mintConfigSchema: z.ZodObject<{
     $schema: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     mintlify: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
@@ -231,11 +231,11 @@ export declare const configSchema: z.ZodObject<{
     }, "strict", z.ZodTypeAny, {
         name: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
     }, {
         name: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
     }>>;
     anchors: z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
@@ -261,7 +261,7 @@ export declare const configSchema: z.ZodObject<{
         name: string;
         url: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
         color?: string | {
             from: string;
             to: string;
@@ -273,7 +273,7 @@ export declare const configSchema: z.ZodObject<{
         name: string;
         url: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
         color?: string | {
             from: string;
             to: string;
@@ -285,12 +285,15 @@ export declare const configSchema: z.ZodObject<{
     tabs: z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         url: z.ZodString;
+        version: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         url: string;
+        version?: string | undefined;
     }, {
         name: string;
         url: string;
+        version?: string | undefined;
     }>, "many">>;
     footerSocials: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         type: z.ZodString;
@@ -528,6 +531,7 @@ export declare const configSchema: z.ZodObject<{
         indexHiddenPages?: boolean | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
+    navigation: import("@mintlify/models").NavigationGroup[];
     name: string;
     $schema: string;
     favicon: string;
@@ -547,7 +551,6 @@ export declare const configSchema: z.ZodObject<{
         ultraLight?: any;
         ultraDark?: any;
     };
-    navigation: import("@mintlify/models").NavigationGroup[];
     mintlify?: string | undefined;
     logo?: string | {
         light: string;
@@ -603,13 +606,13 @@ export declare const configSchema: z.ZodObject<{
     topAnchor?: {
         name: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
     } | undefined;
     anchors?: {
         name: string;
         url: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
         color?: string | {
             from: string;
             to: string;
@@ -621,6 +624,7 @@ export declare const configSchema: z.ZodObject<{
     tabs?: {
         name: string;
         url: string;
+        version?: string | undefined;
     }[] | undefined;
     footerSocials?: {
         type: string;
@@ -688,6 +692,7 @@ export declare const configSchema: z.ZodObject<{
         indexHiddenPages?: boolean | undefined;
     } | undefined;
 }, {
+    navigation: import("@mintlify/models").NavigationGroup[];
     name: string;
     favicon: string;
     colors: {
@@ -706,7 +711,6 @@ export declare const configSchema: z.ZodObject<{
         ultraLight?: any;
         ultraDark?: any;
     };
-    navigation: import("@mintlify/models").NavigationGroup[];
     $schema?: string | undefined;
     mintlify?: string | undefined;
     logo?: string | {
@@ -763,13 +767,13 @@ export declare const configSchema: z.ZodObject<{
     topAnchor?: {
         name: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
     } | undefined;
     anchors?: {
         name: string;
         url: string;
         icon?: string | undefined;
-        iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
         color?: string | {
             from: string;
             to: string;
@@ -781,6 +785,7 @@ export declare const configSchema: z.ZodObject<{
     tabs?: {
         name: string;
         url: string;
+        version?: string | undefined;
     }[] | undefined;
     footerSocials?: {
         type: string;

package/dist/mint-config/schemas/config.js

@@ -10,7 +10,7 @@ import { navigationSchema } from './navigation.js';
 import { seoSchema } from './seo.js';
 import { tabsSchema, primaryTabSchema } from './tabs.js';
 import { versionsSchema } from './versions.js';
-export const configSchema = z.object({
+export const mintConfigSchema = z.object({
     $schema: z.string().url().optional().default('https://mintlify.com/schema.json'),
     mintlify: z.string().optional(),
     name: nameSchema,

package/dist/mint-config/schemas/hexColor.d.ts

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const hexColor: (name: string) => z.ZodString;

package/dist/mint-config/schemas/hexColor.js

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+const hexColorRegex = /^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$/;
+export const hexColor = (name) => z
+    .string({ invalid_type_error: `${name} must be a string` })
+    .regex(hexColorRegex, `${name} must be a hex color string, with a leading #`);

package/dist/mint-config/schemas/navigation.d.ts

@@ -8,12 +8,12 @@ export declare const baseNavigationGroupSchema: z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     group: string;
     icon?: string | undefined;
-    iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+    iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
     version?: string | undefined;
 }, {
     group: string;
     icon?: string | undefined;
-    iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
+    iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-solid" | "solid" | "thin" | undefined;
     version?: string | undefined;
 }>;
 export declare const navigationSchema: z.ZodArray<z.ZodType<NavigationGroup, z.ZodTypeDef, NavigationGroup>, "many">;

package/dist/mint-config/schemas/tabs.d.ts

@@ -2,12 +2,15 @@ import { z } from 'zod';
 export declare const tabsSchema: z.ZodArray<z.ZodObject<{
     name: z.ZodString;
     url: z.ZodString;
+    version: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     url: string;
+    version?: string | undefined;
 }, {
     name: string;
     url: string;
+    version?: string | undefined;
 }>, "many">;
 export declare const primaryTabSchema: z.ZodObject<{
     name: z.ZodString;

package/dist/mint-config/schemas/tabs.js

@@ -14,6 +14,11 @@ const tabSchema = z.object({
     })
         .trim()
         .min(1, 'Tab URL is missing.'),
+    version: z
+        .string({
+        invalid_type_error: 'Version must be a string in the versions array.',
+    })
+        .optional(),
 });
 export const tabsSchema = tabSchema.array();
 export const primaryTabSchema = z

package/dist/mint-config/warnings/aggregateWarnings.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+import { mintConfigSchema } from '../schemas/config.js';
+export type WarningGenerator = (config: z.infer<typeof mintConfigSchema>) => z.ZodIssue[];
+export declare const aggregateWarnings: WarningGenerator;

package/dist/mint-config/warnings/aggregateWarnings.js

@@ -0,0 +1,4 @@
+import { warnAnchorUrls } from './warnAnchorUrls.js';
+import { warnUnusedVersions } from './warnUnusedVersions.js';
+const warnings = [warnAnchorUrls, warnUnusedVersions];
+export const aggregateWarnings = (config) => warnings.flatMap((generator) => generator(config));

package/dist/mint-config/warnings/warnAnchorUrls.d.ts

@@ -0,0 +1,2 @@
+import { WarningGenerator } from './aggregateWarnings.js';
+export declare const warnAnchorUrls: WarningGenerator;

package/dist/mint-config/warnings/warnAnchorUrls.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+export const warnAnchorUrls = ({ anchors, navigation }) => {
+    var _a;
+    return ((_a = anchors === null || anchors === void 0 ? void 0 : anchors.filter((anchor) => !anchor.url.startsWith('mailto:') &&
+        !anchor.url.startsWith('http://') &&
+        !anchor.url.startsWith('https://') &&
+        !navigation.some((nav) => pageStartsWith(nav, anchor.url))).map((anchor, i) => ({
+        code: z.ZodIssueCode.custom,
+        message: `No pages in the navigation match anchor ${anchor.url}`,
+        path: ['anchors', i, 'url'],
+    }))) !== null && _a !== void 0 ? _a : []);
+};
+function pageStartsWith(navEntry, prefix) {
+    if (typeof navEntry === 'string') {
+        return navEntry.startsWith(prefix);
+    }
+    else {
+        return navEntry.pages.some((entry) => pageStartsWith(entry, prefix));
+    }
+}

package/dist/mint-config/warnings/warnUnusedVersions.d.ts

@@ -0,0 +1,2 @@
+import { WarningGenerator } from './aggregateWarnings.js';
+export declare const warnUnusedVersions: WarningGenerator;

package/dist/mint-config/warnings/warnUnusedVersions.js

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+import { flattenNavigationVersions } from '../flattenNavigationVersions.js';
+export const warnUnusedVersions = ({ navigation, versions }) => {
+    if (versions === undefined || versions.length === 0)
+        return [];
+    const versionsFromNavigation = flattenNavigationVersions(navigation);
+    if (versionsFromNavigation.length === 0) {
+        return [
+            {
+                code: z.ZodIssueCode.custom,
+                message: 'Versions are defined in the config, but no versions are used in the navigation',
+                path: ['versions'],
+            },
+        ];
+    }
+    return [];
+};