@mintlify/validation 0.1.862 → 0.1.864

package/dist/mint-config/schemas/v2/properties/seo.d.ts

@@ -1,5 +1,31 @@
 import { z } from 'zod';
 export declare const metatagsSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+export declare const seoPathSchema: z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    metatags: z.ZodRecord<z.ZodString, z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    metatags: Record<string, string>;
+}, {
+    path: string;
+    metatags: Record<string, string>;
+}>;
+export declare const seoPathsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    metatags: z.ZodRecord<z.ZodString, z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    metatags: Record<string, string>;
+}, {
+    path: string;
+    metatags: Record<string, string>;
+}>, "many">, {
+    path: string;
+    metatags: Record<string, string>;
+}[], {
+    path: string;
+    metatags: Record<string, string>;
+}[]>;
 export declare const seoOrganizationSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodOptional<z.ZodString>;
@@ -24,6 +50,22 @@ export declare const seoOrganizationSchema: z.ZodObject<{
 }>;
 export declare const seoSchema: z.ZodObject<{
     metatags: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    paths: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
+        path: z.ZodEffects<z.ZodString, string, string>;
+        metatags: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        metatags: Record<string, string>;
+    }, {
+        path: string;
+        metatags: Record<string, string>;
+    }>, "many">, {
+        path: string;
+        metatags: Record<string, string>;
+    }[], {
+        path: string;
+        metatags: Record<string, string>;
+    }[]>>;
     organization: z.ZodOptional<z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
         name: z.ZodOptional<z.ZodString>;
@@ -50,6 +92,10 @@ export declare const seoSchema: z.ZodObject<{
     trailingSlash: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     metatags?: Record<string, string> | undefined;
+    paths?: {
+        path: string;
+        metatags: Record<string, string>;
+    }[] | undefined;
     organization?: {
         id?: string | undefined;
         name?: string | undefined;
@@ -62,6 +108,10 @@ export declare const seoSchema: z.ZodObject<{
     trailingSlash?: boolean | undefined;
 }, {
     metatags?: Record<string, string> | undefined;
+    paths?: {
+        path: string;
+        metatags: Record<string, string>;
+    }[] | undefined;
     organization?: {
         id?: string | undefined;
         name?: string | undefined;

package/dist/mint-config/schemas/v2/properties/seo.js

@@ -3,6 +3,29 @@ export const metatagsSchema = z
     .record(z.string(), z.string().nonempty())
     .optional()
     .describe('Meta tags added to every page. Must be a valid key-value pair.');
+const SEO_PATH_SEGMENT = /^[^\s/\\?#]+$/;
+function isCanonicalSeoPath(value) {
+    return value
+        .split('/')
+        .every((segment) => SEO_PATH_SEGMENT.test(segment) && segment !== '.' && segment !== '..');
+}
+export const seoPathSchema = z.object({
+    path: z
+        .string()
+        .nonempty()
+        .refine(isCanonicalSeoPath, 'Must be a slash-delimited folder path relative to the docs root, e.g. `guides/v2`. Each segment must be non-empty and must not be `.` or `..`, and the path must not start or end with a slash or contain whitespace, backslashes, `?`, or `#`.')
+        .describe('Folder path relative to the docs root, e.g. `guides/v2`. Applies to every page under that folder.'),
+    metatags: z
+        .record(z.string(), z.string().nonempty())
+        .describe('Meta tags added to every page under `path`. Must be a valid key-value pair.'),
+});
+export const seoPathsSchema = z
+    .array(seoPathSchema)
+    .refine((value) => {
+    const paths = value.map((entry) => entry.path);
+    return new Set(paths).size === paths.length;
+}, 'Each path can only be used once')
+    .describe('Meta tags scoped to a folder. Longer paths override shorter ones, which override `metatags`. Page frontmatter overrides both.');
 export const seoOrganizationSchema = z
     .object({
     id: z
@@ -31,6 +54,7 @@ export const seoOrganizationSchema = z
 export const seoSchema = z
     .object({
     metatags: metatagsSchema.optional(),
+    paths: seoPathsSchema.optional(),
     organization: seoOrganizationSchema.optional(),
     indexing: z
         .enum(['navigable', 'all'])

package/dist/mint-config/schemas/v2/themes/almond.d.ts

@@ -431,16 +431,16 @@ export declare const almondConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -449,14 +449,14 @@ export declare const almondConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     }, {
         primary?: {
@@ -473,16 +473,16 @@ export declare const almondConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -491,14 +491,14 @@ export declare const almondConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     }>>;
     navigation: z.ZodUnion<[z.ZodObject<{
@@ -981,6 +981,22 @@ export declare const almondConfigSchema: z.ZodObject<{
     }>>;
     seo: z.ZodOptional<z.ZodObject<{
         metatags: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+        paths: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
+            path: z.ZodEffects<z.ZodString, string, string>;
+            metatags: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            metatags: Record<string, string>;
+        }, {
+            path: string;
+            metatags: Record<string, string>;
+        }>, "many">, {
+            path: string;
+            metatags: Record<string, string>;
+        }[], {
+            path: string;
+            metatags: Record<string, string>;
+        }[]>>;
         organization: z.ZodOptional<z.ZodObject<{
             id: z.ZodOptional<z.ZodString>;
             name: z.ZodOptional<z.ZodString>;
@@ -1007,6 +1023,10 @@ export declare const almondConfigSchema: z.ZodObject<{
         trailingSlash: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -1019,6 +1039,10 @@ export declare const almondConfigSchema: z.ZodObject<{
         trailingSlash?: boolean | undefined;
     }, {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -2122,6 +2146,10 @@ export declare const almondConfigSchema: z.ZodObject<{
     }[] | undefined;
     seo?: {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -2177,16 +2205,16 @@ export declare const almondConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -2195,14 +2223,14 @@ export declare const almondConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     } | undefined;
     appearance?: {
@@ -2556,6 +2584,10 @@ export declare const almondConfigSchema: z.ZodObject<{
     }[] | undefined;
     seo?: {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -2611,16 +2643,16 @@ export declare const almondConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -2629,14 +2661,14 @@ export declare const almondConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     } | undefined;
     appearance?: {

package/dist/mint-config/schemas/v2/themes/aspen.d.ts

@@ -431,16 +431,16 @@ export declare const aspenConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -449,14 +449,14 @@ export declare const aspenConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     }, {
         primary?: {
@@ -473,16 +473,16 @@ export declare const aspenConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -491,14 +491,14 @@ export declare const aspenConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     }>>;
     navigation: z.ZodUnion<[z.ZodObject<{
@@ -981,6 +981,22 @@ export declare const aspenConfigSchema: z.ZodObject<{
     }>>;
     seo: z.ZodOptional<z.ZodObject<{
         metatags: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+        paths: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
+            path: z.ZodEffects<z.ZodString, string, string>;
+            metatags: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            metatags: Record<string, string>;
+        }, {
+            path: string;
+            metatags: Record<string, string>;
+        }>, "many">, {
+            path: string;
+            metatags: Record<string, string>;
+        }[], {
+            path: string;
+            metatags: Record<string, string>;
+        }[]>>;
         organization: z.ZodOptional<z.ZodObject<{
             id: z.ZodOptional<z.ZodString>;
             name: z.ZodOptional<z.ZodString>;
@@ -1007,6 +1023,10 @@ export declare const aspenConfigSchema: z.ZodObject<{
         trailingSlash: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -1019,6 +1039,10 @@ export declare const aspenConfigSchema: z.ZodObject<{
         trailingSlash?: boolean | undefined;
     }, {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -2122,6 +2146,10 @@ export declare const aspenConfigSchema: z.ZodObject<{
     }[] | undefined;
     seo?: {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -2177,16 +2205,16 @@ export declare const aspenConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -2195,14 +2223,14 @@ export declare const aspenConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     } | undefined;
     appearance?: {
@@ -2556,6 +2584,10 @@ export declare const aspenConfigSchema: z.ZodObject<{
     }[] | undefined;
     seo?: {
         metatags?: Record<string, string> | undefined;
+        paths?: {
+            path: string;
+            metatags: Record<string, string>;
+        }[] | undefined;
         organization?: {
             id?: string | undefined;
             name?: string | undefined;
@@ -2611,16 +2643,16 @@ export declare const aspenConfigSchema: z.ZodObject<{
             label?: string | undefined;
         } | undefined;
         links?: ({
+            type: "github";
             href: string;
-            label: string;
-            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
+            label?: string | undefined;
         } | {
-            type: "github";
+            type: "discord";
             href: string;
             icon?: string | {
                 name: string;
@@ -2629,14 +2661,14 @@ export declare const aspenConfigSchema: z.ZodObject<{
             } | undefined;
             label?: string | undefined;
         } | {
-            type: "discord";
             href: string;
+            label: string;
+            type?: string | undefined;
             icon?: string | {
                 name: string;
                 style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
                 library?: "fontawesome" | "lucide" | "tabler" | undefined;
             } | undefined;
-            label?: string | undefined;
         })[] | undefined;
     } | undefined;
     appearance?: {