@mintlify/validation 0.1.125 → 0.1.127

package/dist/index.d.ts

@@ -1,334 +1,9 @@
-export declare function validateMintConfig(value: unknown): import("zod").SafeParseError<{
-    navigation: import("@mintlify/models").NavigationGroup[];
-    name: string;
-    favicon: string;
-    colors: {
-        primary: string;
-        light?: string | undefined;
-        dark?: string | undefined;
-        background?: {
-            light?: string | undefined;
-            dark?: string | undefined;
-        } | undefined;
-        anchors?: string | {
-            from: string;
-            to: string;
-            via?: string | undefined;
-        } | undefined;
-        ultraLight?: any;
-        ultraDark?: any;
-    };
-    $schema?: string | undefined;
-    mintlify?: string | undefined;
-    logo?: string | {
-        light: string;
-        dark: string;
-        href?: string | undefined;
-    } | undefined;
-    openapi?: string | string[] | undefined;
-    api?: {
-        baseUrl?: string | string[] | undefined;
-        auth?: {
-            method?: "bearer" | "basic" | "key" | "cobo" | undefined;
-            name?: string | undefined;
-            inputPrefix?: string | undefined;
-        } | undefined;
-        playground?: {
-            mode?: "show" | "simple" | "hide" | undefined;
-        } | undefined;
-        request?: {
-            example?: {
-                showOptionalParams?: boolean | undefined;
-            } | undefined;
-        } | undefined;
-        maintainOrder?: boolean | undefined;
-    } | undefined;
-    modeToggle?: {
-        default?: "light" | "dark" | undefined;
-        isHidden?: boolean | undefined;
-    } | undefined;
-    versions?: (string | {
-        name: string;
-        url: string;
-    })[] | undefined;
-    metadata?: Record<string, string> | undefined;
-    topbarCtaButton?: {
-        name: string;
-        url: string;
-        type?: "link" | undefined;
-    } | {
-        type: "github";
-        url: string;
-    } | undefined;
-    topbarLinks?: ({
-        name: string;
-        url: string;
-        type?: "link" | undefined;
-    } | {
-        type: "github";
-        url: string;
-    })[] | undefined;
-    primaryTab?: {
-        name: string;
-    } | undefined;
-    topAnchor?: {
-        name: string;
-        icon?: string | undefined;
-        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
-    } | undefined;
-    anchors?: {
-        name: string;
-        url: string;
-        icon?: string | undefined;
-        iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
-        color?: string | {
-            from: string;
-            to: string;
-            via?: string | undefined;
-        } | undefined;
-        isDefaultHidden?: boolean | undefined;
-        version?: string | undefined;
-    }[] | undefined;
-    tabs?: {
-        name: string;
-        url: string;
-        version?: string | undefined;
-    }[] | undefined;
-    footerSocials?: {
-        type: string;
-        url: string;
-    }[] | Record<string, string> | undefined;
-    backgroundImage?: string | undefined;
-    feedback?: {
-        thumbsRating?: boolean | undefined;
-        suggestEdit?: boolean | undefined;
-        raiseIssue?: boolean | undefined;
-    } | undefined;
-    analytics?: {
-        amplitude?: {
-            apiKey: string;
-        } | undefined;
-        clearbit?: {
-            publicApiKey: string;
-        } | undefined;
-        fathom?: {
-            siteId: string;
-        } | undefined;
-        ga4?: {
-            measurementId: string;
-        } | undefined;
-        gtm?: {
-            tagId: string;
-        } | undefined;
-        hotjar?: {
-            hjid: string;
-            hjsv: string;
-        } | undefined;
-        koala?: {
-            publicApiKey: string;
-        } | undefined;
-        logrocket?: {
-            appId: string;
-        } | undefined;
-        mixpanel?: {
-            projectToken: string;
-        } | undefined;
-        pirsch?: {
-            id: string;
-        } | undefined;
-        posthog?: {
-            apiKey: string;
-            apiHost?: string | undefined;
-        } | undefined;
-        plausible?: {
-            domain: string;
-        } | undefined;
-    } | undefined;
-    integrations?: {
-        intercom?: string | undefined;
-        frontchat?: string | undefined;
-    } | undefined;
-    isWhiteLabeled?: boolean | undefined;
-    search?: {
-        prompt?: string | undefined;
-    } | undefined;
-    redirects?: {
-        source: string;
-        destination: string;
-    }[] | undefined;
-    seo?: {
-        indexHiddenPages?: boolean | undefined;
-    } | undefined;
-}> | {
-    warnings: import("zod").ZodIssue[];
-    success: true;
-    data: {
-        navigation: import("@mintlify/models").NavigationGroup[];
-        name: string;
-        $schema: string;
-        favicon: string;
-        colors: {
-            primary: string;
-            light?: string | undefined;
-            dark?: string | undefined;
-            background?: {
-                light?: string | undefined;
-                dark?: string | undefined;
-            } | undefined;
-            anchors?: string | {
-                from: string;
-                to: string;
-                via?: string | undefined;
-            } | undefined;
-            ultraLight?: any;
-            ultraDark?: any;
-        };
-        mintlify?: string | undefined;
-        logo?: string | {
-            light: string;
-            dark: string;
-            href?: string | undefined;
-        } | undefined;
-        openapi?: string | string[] | undefined;
-        api?: {
-            baseUrl?: string | string[] | undefined;
-            auth?: {
-                method?: "bearer" | "basic" | "key" | "cobo" | undefined;
-                name?: string | undefined;
-                inputPrefix?: string | undefined;
-            } | undefined;
-            playground?: {
-                mode: "show" | "simple" | "hide";
-            } | undefined;
-            request?: {
-                example?: {
-                    showOptionalParams: boolean;
-                } | undefined;
-            } | undefined;
-            maintainOrder?: boolean | undefined;
-        } | undefined;
-        modeToggle?: {
-            default?: "light" | "dark" | undefined;
-            isHidden?: boolean | undefined;
-        } | undefined;
-        versions?: (string | {
-            name: string;
-            url: string;
-        })[] | undefined;
-        metadata?: Record<string, string> | undefined;
-        topbarCtaButton?: {
-            name: string;
-            url: string;
-            type?: "link" | undefined;
-        } | {
-            type: "github";
-            url: string;
-        } | undefined;
-        topbarLinks?: ({
-            name: string;
-            url: string;
-            type?: "link" | undefined;
-        } | {
-            type: "github";
-            url: string;
-        })[] | undefined;
-        primaryTab?: {
-            name: string;
-        } | undefined;
-        topAnchor?: {
-            name: string;
-            icon?: string | undefined;
-            iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
-        } | undefined;
-        anchors?: {
-            name: string;
-            url: string;
-            icon?: string | undefined;
-            iconType?: "light" | "brands" | "duotone" | "regular" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
-            color?: string | {
-                from: string;
-                to: string;
-                via?: string | undefined;
-            } | undefined;
-            isDefaultHidden?: boolean | undefined;
-            version?: string | undefined;
-        }[] | undefined;
-        tabs?: {
-            name: string;
-            url: string;
-            version?: string | undefined;
-        }[] | undefined;
-        footerSocials?: {
-            type: string;
-            url: string;
-        }[] | Record<string, string> | undefined;
-        backgroundImage?: string | undefined;
-        feedback?: {
-            thumbsRating?: boolean | undefined;
-            suggestEdit?: boolean | undefined;
-            raiseIssue?: boolean | undefined;
-        } | undefined;
-        analytics?: {
-            amplitude?: {
-                apiKey: string;
-            } | undefined;
-            clearbit?: {
-                publicApiKey: string;
-            } | undefined;
-            fathom?: {
-                siteId: string;
-            } | undefined;
-            ga4?: {
-                measurementId: string;
-            } | undefined;
-            gtm?: {
-                tagId: string;
-            } | undefined;
-            hotjar?: {
-                hjid: string;
-                hjsv: string;
-            } | undefined;
-            koala?: {
-                publicApiKey: string;
-            } | undefined;
-            logrocket?: {
-                appId: string;
-            } | undefined;
-            mixpanel?: {
-                projectToken: string;
-            } | undefined;
-            pirsch?: {
-                id: string;
-            } | undefined;
-            posthog?: {
-                apiKey: string;
-                apiHost?: string | undefined;
-            } | undefined;
-            plausible?: {
-                domain: string;
-            } | undefined;
-        } | undefined;
-        integrations?: {
-            intercom?: string | undefined;
-            frontchat?: string | undefined;
-        } | undefined;
-        isWhiteLabeled?: boolean | undefined;
-        search?: {
-            prompt?: string | undefined;
-        } | undefined;
-        redirects?: {
-            source: string;
-            destination: string;
-        }[] | undefined;
-        seo?: {
-            indexHiddenPages?: boolean | undefined;
-        } | undefined;
-    };
-};
 export * from './openapi/types/endpoint.js';
 export { OpenApiToEndpointConverter } from './openapi/OpenApiToEndpointConverter.js';
 export { SchemaConverter } from './openapi/SchemaConverter.js';
 export { generateExampleFromSchema } from './openapi/generateExampleFromSchema.js';
+export { validateMintConfig } from './mint-config/validateMintConfig.js';
+export { formatIssue } from './mint-config/formatIssue.js';
 export declare const mintConfigJsonSchema: import("zod-to-json-schema/src/parseDef.js").JsonSchema7Type & {
     $schema?: string | undefined;
     definitions?: {

package/dist/index.js

@@ -1,19 +1,12 @@
 import { zodToJsonSchema } from 'zod-to-json-schema';
-import { refineMissingVersions } from './mint-config/refinements/refineMissingVersions.js';
 import { colorsSchema } from './mint-config/schemas/colors.js';
 import { mintConfigSchema } from './mint-config/schemas/config.js';
-import { aggregateWarnings } from './mint-config/warnings/aggregateWarnings.js';
-export function validateMintConfig(value) {
-    const refinedSchema = mintConfigSchema.superRefine(refineMissingVersions);
-    const validationResults = refinedSchema.safeParse(value);
-    if (!validationResults.success)
-        return validationResults;
-    return Object.assign(Object.assign({}, validationResults), { warnings: aggregateWarnings(validationResults.data) });
-}
 export * from './openapi/types/endpoint.js';
 export { OpenApiToEndpointConverter } from './openapi/OpenApiToEndpointConverter.js';
 export { SchemaConverter } from './openapi/SchemaConverter.js';
 export { generateExampleFromSchema } from './openapi/generateExampleFromSchema.js';
+export { validateMintConfig } from './mint-config/validateMintConfig.js';
+export { formatIssue } from './mint-config/formatIssue.js';
 export const mintConfigJsonSchema = (() => {
     const cleanedSchema = mintConfigSchema.extend({
         colors: colorsSchema.omit({

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

@@ -0,0 +1,2 @@
+import { ZodErrorMap } from 'zod';
+export declare const customErrorMap: ZodErrorMap;

package/dist/mint-config/customErrorMap.js

@@ -0,0 +1,13 @@
+export const customErrorMap = (issue, ctx) => {
+    switch (issue.code) {
+        case 'invalid_type':
+            if (issue.received === 'undefined')
+                return { message: 'This field is required' };
+            return {
+                message: `Invalid type. Expected field to be of type '${issue.expected}', received '${issue.received}'`,
+            };
+        case 'invalid_union':
+            return { message: `Invalid type. Field did not match any types in union` };
+    }
+    return { message: ctx.defaultError };
+};

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

@@ -0,0 +1,3 @@
+import { ZodIssue } from 'zod';
+export declare const formatIssue: (issue: ZodIssue) => string;
+export declare const formatIssueWithIndent: (issue: ZodIssue, indent?: number) => string;

package/dist/mint-config/formatIssue.js

@@ -0,0 +1,15 @@
+const HALF_INDENT = '  ';
+const INDENT = '    ';
+export const formatIssue = (issue) => formatIssueWithIndent(issue);
+export const formatIssueWithIndent = (issue, indent = 0) => {
+    const pathComponents = issue.path.map((value) => typeof value === 'string' ? `.${value}` : `[${value}]`);
+    const lines = issue.code === 'invalid_union'
+        ? issue.unionErrors.flatMap((unionError, i) => {
+            const unionErrorLines = unionError.issues.map((unionIssue) => formatIssueWithIndent(unionIssue, indent + 1));
+            unionErrorLines.unshift(`${INDENT.repeat(indent)}${HALF_INDENT}${i + 1}:`);
+            return unionErrorLines;
+        })
+        : [];
+    lines.unshift(`${INDENT.repeat(indent)}\#${pathComponents.join('')}: ${issue.message}`);
+    return lines.join('\n');
+};

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

@@ -46,7 +46,7 @@ export declare const analyticsSchema: z.ZodObject<{
         hjsv: string;
     }>>;
     koala: z.ZodOptional<z.ZodObject<{
-        publicApiKey: z.ZodEffects<z.ZodString, string, string>;
+        publicApiKey: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         publicApiKey: string;
     }, {

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

@@ -1,115 +1,43 @@
 import { z } from 'zod';
 const amplitudeConfigInterfaceSchema = z.object({
-    apiKey: z.string({
-        required_error: 'Amplitude apiKey is missing.',
-        invalid_type_error: 'Amplitude apiKey must be a string.',
-    }),
-}, {
-    invalid_type_error: 'Amplitude analytics config must be an object with an apiKey property.',
+    apiKey: z.string(),
 });
 const clearbitConfigInterfaceSchema = z.object({
-    publicApiKey: z.string({
-        required_error: 'Clearbit publicApiKey is missing.',
-        invalid_type_error: 'Clearbit publicApiKey must be a string.',
-    }),
-}, {
-    invalid_type_error: 'Clearbit config must be an object with a publicApiKey property.',
+    publicApiKey: z.string(),
 });
 const fathomConfigInterfaceSchema = z.object({
-    siteId: z.string({
-        required_error: 'Fathom siteId is missing.',
-        invalid_type_error: 'Fathom siteId must be a string.',
-    }),
-}, {
-    invalid_type_error: 'Fathom analytics config must be an object with a siteId property.',
+    siteId: z.string(),
 });
 const googleAnalyticsConfigInterfaceSchema = z.object({
-    measurementId: z
-        .string({
-        required_error: 'Google Analytics measurementId is missing.',
-        invalid_type_error: 'Google Analytics measurementId must be a string.',
-    })
-        .startsWith('G', 'Google Analytics measurementId must start with G.'),
-}, {
-    invalid_type_error: 'Google Analytics config must be an object with a measurementId property.',
+    measurementId: z.string().startsWith('G', 'Must start with G'),
 });
 const googleTagManagerConfigInterfaceSchema = z.object({
-    tagId: z
-        .string({
-        required_error: 'Google Tag Manager tagId is missing.',
-        invalid_type_error: 'Google Tag Manager tagId must be a string.',
-    })
-        .startsWith('G', 'Google Tag Manager tagId must start with G.'),
-}, {
-    invalid_type_error: 'Google Tag Manager config must be an object with a tagId property.',
+    tagId: z.string().startsWith('G', 'Must start with G'),
 });
 const hotjarConfigInterfaceSchema = z.object({
-    hjid: z.string({
-        required_error: 'Hotjar hjid is missing.',
-        invalid_type_error: 'Hotjar hjid must be a string.',
-    }),
-    hjsv: z.string({
-        required_error: 'Hotjar hjsv is missing.',
-        invalid_type_error: 'Hotjar hjsv must be a string.',
-    }),
-}, {
-    invalid_type_error: 'Hotjar config must be an object with a hjid and hjsv property.',
+    hjid: z.string(),
+    hjsv: z.string(),
 });
 const koalaConfigInterfaceSchema = z.object({
-    publicApiKey: z
-        .string({
-        required_error: 'Public Api Key is required for the Koala snippet to run.',
-        invalid_type_error: 'Koala Public Api Key must be a string.',
-    })
-        .refine((publicApiKey) => publicApiKey.length >= 2, 'Koala Public Api Key must have at least two characters'),
-}, {
-    invalid_type_error: 'Koala config must be an object with a publicApiKey property.',
+    publicApiKey: z.string().min(2),
 });
 const logrocketConfigInterfaceSchema = z.object({
-    appId: z.string({
-        required_error: 'Logrocket appId is missing.',
-        invalid_type_error: 'Logrocket appId must be a string.',
-    }),
-}, {
-    invalid_type_error: 'Logrocket config must be an object with an appId property.',
+    appId: z.string(),
 });
 const mixpanelConfigInterfaceSchema = z.object({
-    projectToken: z.string({
-        required_error: 'Mixpanel projectToken is missing.',
-        invalid_type_error: 'Mixpanel projectToken must be a string.',
-    }),
-}, {
-    invalid_type_error: 'Mixpanel config must be an object with a projectToken property.',
+    projectToken: z.string(),
 });
 const pirschConfigInterfaceSchema = z.object({
-    id: z.string({
-        required_error: 'Pirsch id is missing.',
-        invalid_type_error: 'Pirsch id must be a string.',
-    }),
-}, { invalid_type_error: 'Pirsch config must be an object with an id property.' });
+    id: z.string(),
+});
 const postHogConfigInterfaceSchema = z.object({
-    apiKey: z
-        .string({
-        required_error: 'Posthog apiKey is missing.',
-        invalid_type_error: 'Posthog apiKey must be a string.',
-    })
-        .startsWith('phc_', 'Posthog apiKey must start with phc_'),
-    apiHost: z
-        .string({ invalid_type_error: 'Posthog apiHost must be a string.' })
-        .url('Posthog apiHost must be a valid URL.')
-        .optional(),
-}, {
-    invalid_type_error: 'Posthog config must be an object with an apiKey property.',
+    apiKey: z.string().startsWith('phc_', 'Must start with phc_'),
+    apiHost: z.string().url('Must be a valid URL').optional(),
 });
 const plausibleConfigInterfaceSchema = z.object({
     domain: z
-        .string({
-        required_error: 'Plausible domain is missing.',
-        invalid_type_error: 'Plausible domain must be a string.',
-    })
-        .refine((domain) => !domain.startsWith('http://') && !domain.startsWith('https://'), 'Plausible domain must not start with http:// or https://'),
-}, {
-    invalid_type_error: 'Plausible config must be an object with a domain property. The domain must not start with http:// or https://.',
+        .string()
+        .refine((domain) => !domain.startsWith('http://') && !domain.startsWith('https://'), 'Must not start with http:// or https://'),
 });
 export const analyticsSchema = z
     .object({

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

@@ -1,13 +1,8 @@
 import { z } from 'zod';
 import { hexColor } from './hexColor.js';
 export const gradientSchema = z.object({
-    from: hexColor('Anchor color.from'),
-    via: hexColor('Anchor color.via').optional(),
-    to: hexColor('Anchor color.to'),
-});
-export const anchorColorSchema = z.union([
-    hexColor('Anchor color'),
-    gradientSchema.strict('Anchors with gradient colors can only have properties from, via, and to with valid hexadecimal colors.'),
-], {
-    invalid_type_error: 'Anchor color must be a string or an object with from and to properties.',
+    from: hexColor,
+    via: hexColor.optional(),
+    to: hexColor,
 });
+export const anchorColorSchema = z.union([hexColor, gradientSchema.strict()]);

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

@@ -2,68 +2,27 @@ import { iconTypes } from '@mintlify/models';
 import { z } from 'zod';
 import { anchorColorSchema } from './anchorColors.js';
 export const anchorSchema = z.object({
-    name: z
-        .string({
-        required_error: 'Every anchor must have a name.',
-        invalid_type_error: 'Anchor name must be a string.',
-    })
-        .trim()
-        .min(1, 'Anchor name is empty.'),
-    url: z
-        .string({
-        required_error: 'Every anchor must have a url',
-        invalid_type_error: 'Anchor url must be a string.',
-    })
-        .trim()
-        .min(1, 'Anchor URL is missing.'),
+    name: z.string().trim().nonempty(),
+    url: z.string().trim().nonempty(),
     icon: z
         .string({
         invalid_type_error: 'Anchor icon must be the name of a Font Awesome icon. Visit this link to see all the available icons: https://fontawesome.com/icons',
     })
-        .refine((iconStr) => !iconStr.startsWith('fa-'), 'icon does not need to start with "fa-". Please delete "fa-" and keep the rest of the icon name.')
-        .optional(),
-    iconType: z
-        .enum(iconTypes, {
-        errorMap: () => {
-            return {
-                message: 'anchor iconType must be one of the following strings: brands, duotone, light, sharp-solid, solid, thin',
-            };
-        },
-    })
+        .refine((icon) => !icon.startsWith('fa-'), "Icon does not need to start with 'fa-'. Please delete 'fa-' and keep the rest of the icon name")
         .optional(),
+    iconType: z.enum(iconTypes).optional(),
     color: anchorColorSchema.optional(),
-    isDefaultHidden: z
-        .boolean({
-        invalid_type_error: 'Anchor isDefaultHidden must be a boolean. Try writing true or false without quotes around them.',
-    })
-        .optional(),
+    isDefaultHidden: z.boolean().optional(),
     version: z
         .string({
-        invalid_type_error: 'Version must be a string in the versions array.',
+        invalid_type_error: 'Version must be a string in the #.versions array',
     })
         .optional(),
 });
 export const topAnchorSchema = z
     .object({
-    name: z.string({
-        required_error: 'topAnchor.name is missing, set it or delete the entire topAnchor property.',
-        invalid_type_error: 'topAnchor.name must be a string',
-    }),
-    icon: z
-        .string({
-        invalid_type_error: 'topAnchor.icon must be a string',
-    })
-        .optional(),
-    iconType: z
-        .enum(iconTypes, {
-        errorMap: () => {
-            return {
-                message: 'topAnchor.iconType must be one of the following strings: brands, duotone, light, sharp-solid, solid, thin',
-            };
-        },
-    })
-        .optional(),
-}, {
-    invalid_type_error: "topAnchor must be an object with a name property. Delete the topAnchor if you don't want to customize the values.",
+    name: z.string(),
+    icon: z.string().optional(),
+    iconType: z.enum(iconTypes).optional(),
 })
-    .strict('topAnchor can only have name, icon, and iconType properties.');
+    .strict();