@mintlify/validation 0.1.227 → 0.1.229

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

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { mintConfigSchema } from './themes/mint.js';
+import { prismConfigSchema } from './themes/prism.js';
+import { quillConfigSchema } from './themes/quill.js';
+import { venusConfigSchema } from './themes/venus.js';
+export const docsConfigSchema = z.discriminatedUnion('theme', [
+    mintConfigSchema,
+    prismConfigSchema,
+    quillConfigSchema,
+    venusConfigSchema,
+]);

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

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const $schemaSchema: z.ZodDefault<z.ZodOptional<z.ZodString>>;

package/dist/mint-config/schemas/v2/properties/$schema.js

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export const $schemaSchema = z
+    .string()
+    .url()
+    .optional()
+    .default('https://mintlify.com/schemas/docs.json')
+    .describe('The URL of the schema file');

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

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+export declare const apiSchema: z.ZodObject<{
+    playground: z.ZodOptional<z.ZodObject<{
+        display: z.ZodDefault<z.ZodOptional<z.ZodEnum<["interactive", "simple", "none"]>>>;
+        proxy: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        display: "simple" | "none" | "interactive";
+        proxy: boolean;
+    }, {
+        display?: "simple" | "none" | "interactive" | undefined;
+        proxy?: boolean | undefined;
+    }>>;
+    examples: z.ZodOptional<z.ZodObject<{
+        languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        languages?: string[] | undefined;
+    }, {
+        languages?: string[] | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    playground?: {
+        display: "simple" | "none" | "interactive";
+        proxy: boolean;
+    } | undefined;
+    examples?: {
+        languages?: string[] | undefined;
+    } | undefined;
+}, {
+    playground?: {
+        display?: "simple" | "none" | "interactive" | undefined;
+        proxy?: boolean | undefined;
+    } | undefined;
+    examples?: {
+        languages?: string[] | undefined;
+    } | undefined;
+}>;

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

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export const apiSchema = z
+    .object({
+    playground: z
+        .object({
+        display: z
+            .enum(['interactive', 'simple', 'none'])
+            .optional()
+            .default('interactive')
+            .describe('The display mode of the API playground'),
+        proxy: z
+            .boolean()
+            .optional()
+            .default(false)
+            .describe('Whether to pass API requests through a proxy server'),
+    })
+        .optional()
+        .describe('Configurations for the API playground'),
+    examples: z
+        .object({
+        languages: z
+            .array(z.string())
+            .optional()
+            .describe('Example languages for the autogenerated API snippets'),
+    })
+        .optional()
+        .describe('Configurations for the autogenerated API examples'),
+})
+    .describe('API reference configuration and playground settings');

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

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const appearanceSchema: z.ZodObject<{
+    default: z.ZodDefault<z.ZodEnum<["system", "light", "dark"]>>;
+    strict: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    strict: boolean;
+    default: "light" | "dark" | "system";
+}, {
+    default?: "light" | "dark" | "system" | undefined;
+    strict?: boolean | undefined;
+}>;

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

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+export const appearanceSchema = z
+    .object({
+    default: z
+        .enum(['system', 'light', 'dark'])
+        .default('system')
+        .describe('The default light/dark mode'),
+    strict: z.boolean().default(false).describe('Whether to hide the light / dark mode toggle'),
+})
+    .describe('Light / dark mode toggle settings');

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

@@ -0,0 +1,44 @@
+import { z } from 'zod';
+export declare const backgroundSchema: z.ZodObject<{
+    image: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        light: z.ZodString;
+        dark: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        light: string;
+        dark: string;
+    }, {
+        light: string;
+        dark: string;
+    }>]>>;
+    decoration: z.ZodDefault<z.ZodEnum<["gradient", "grid", "windows", "none"]>>;
+    color: z.ZodOptional<z.ZodObject<{
+        light: z.ZodString;
+        dark: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        light: string;
+        dark: string;
+    }, {
+        light: string;
+        dark: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    decoration: "none" | "gradient" | "grid" | "windows";
+    image?: string | {
+        light: string;
+        dark: string;
+    } | undefined;
+    color?: {
+        light: string;
+        dark: string;
+    } | undefined;
+}, {
+    image?: string | {
+        light: string;
+        dark: string;
+    } | undefined;
+    decoration?: "none" | "gradient" | "grid" | "windows" | undefined;
+    color?: {
+        light: string;
+        dark: string;
+    } | undefined;
+}>;

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

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+import { colorSchema } from './reusable/color.js';
+export const backgroundSchema = z
+    .object({
+    image: z
+        .union([
+        z.string(),
+        z.object({
+            light: z.string(),
+            dark: z.string(),
+        }),
+    ])
+        .optional()
+        .describe('A fixed background image. Can be an absolute URL or relative path.'),
+    decoration: z
+        .enum(['gradient', 'grid', 'windows', 'none'])
+        .default('none')
+        .describe('The background decoration of the theme'),
+    color: colorSchema.optional().describe('The colors of the background'),
+})
+    .describe('Background color and decoration settings');

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

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const colorsSchema: z.ZodObject<{
+    primary: z.ZodString;
+    light: z.ZodOptional<z.ZodString>;
+    dark: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    primary: string;
+    light?: string | undefined;
+    dark?: string | undefined;
+}, {
+    primary: string;
+    light?: string | undefined;
+    dark?: string | undefined;
+}>;

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

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { hexColor } from './reusable/color.js';
+export const colorsSchema = z
+    .object({
+    primary: hexColor.describe('The primary color of the theme'),
+    light: hexColor.optional().describe('The light color of the theme. Used for dark mode'),
+    dark: hexColor.optional().describe('The dark color of the theme. Used for light mode'),
+})
+    .strict()
+    .describe('The colors to use in your documentation. At the very least, you must define the primary color. For example: { "colors": { "primary": "#ff0000" } }');

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

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const descriptionSchema: z.ZodString;

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

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+export const descriptionSchema = z
+    .string()
+    .trim()
+    .describe('Optional description used for SEO and LLM indexing');

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

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const faviconSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
+    light: z.ZodString;
+    dark: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    light: string;
+    dark: string;
+}, {
+    light: string;
+    dark: string;
+}>]>;

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

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+export const faviconSchema = z.union([
+    z
+        .string()
+        .describe('Path pointing to the favicon file in your docs folder, including the file extension. The favicon will automatically be resized to the appropriate sizes'),
+    z
+        .object({
+        light: z
+            .string()
+            .describe('Path pointing to the light favicon file to use in dark mode, including the file extension. Example: `/favicon.png`'),
+        dark: z
+            .string()
+            .describe('Path pointing to the dark favicon file to use in light mode, including the file extension. Example: `/favicon-dark.png`'),
+    })
+        .describe('The path to the favicon. Can be a single file or a pair for light and dark mode. Example: `/favicon.png`'),
+]);

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

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const feedbackSchema: z.ZodObject<{
+    thumbs: z.ZodOptional<z.ZodBoolean>;
+    edits: z.ZodOptional<z.ZodBoolean>;
+    issues: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    thumbs?: boolean | undefined;
+    edits?: boolean | undefined;
+    issues?: boolean | undefined;
+}, {
+    thumbs?: boolean | undefined;
+    edits?: boolean | undefined;
+    issues?: boolean | undefined;
+}>;

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

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export const feedbackSchema = z
+    .object({
+    thumbs: z.boolean().optional().describe('Whether to enable thumbs up/down feedback'),
+    edits: z.boolean().optional().describe('Whether to enable edit suggestions feedback'),
+    issues: z.boolean().optional().describe('Whether to enable issue reporting feedback'),
+})
+    .describe('Feedback options presented to the viewers');

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

@@ -0,0 +1,132 @@
+import { z } from 'zod';
+export declare const fontDetailsSchema: z.ZodEffects<z.ZodObject<{
+    family: z.ZodString;
+    weight: z.ZodOptional<z.ZodNumber>;
+    source: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodEnum<["woff", "woff2"]>>;
+}, "strip", z.ZodTypeAny, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}>, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}>;
+export declare const fontsSchema: z.ZodUnion<[z.ZodEffects<z.ZodObject<{
+    family: z.ZodString;
+    weight: z.ZodOptional<z.ZodNumber>;
+    source: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodEnum<["woff", "woff2"]>>;
+}, "strip", z.ZodTypeAny, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}>, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}, {
+    family: string;
+    weight?: number | undefined;
+    source?: string | undefined;
+    format?: "woff" | "woff2" | undefined;
+}>, z.ZodObject<{
+    heading: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        family: z.ZodString;
+        weight: z.ZodOptional<z.ZodNumber>;
+        source: z.ZodOptional<z.ZodString>;
+        format: z.ZodOptional<z.ZodEnum<["woff", "woff2"]>>;
+    }, "strip", z.ZodTypeAny, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }>, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }>>;
+    body: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        family: z.ZodString;
+        weight: z.ZodOptional<z.ZodNumber>;
+        source: z.ZodOptional<z.ZodString>;
+        format: z.ZodOptional<z.ZodEnum<["woff", "woff2"]>>;
+    }, "strip", z.ZodTypeAny, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }>, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }, {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    }>>;
+}, "strict", z.ZodTypeAny, {
+    heading?: {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    } | undefined;
+    body?: {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    } | undefined;
+}, {
+    heading?: {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    } | undefined;
+    body?: {
+        family: string;
+        weight?: number | undefined;
+        source?: string | undefined;
+        format?: "woff" | "woff2" | undefined;
+    } | undefined;
+}>]>;

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

@@ -0,0 +1,33 @@
+import { fontFormats } from '@mintlify/models';
+import { z } from 'zod';
+export const fontDetailsSchema = z
+    .object({
+    family: z.string().describe('The font family, such as "Open Sans", "Playfair Display"'),
+    weight: z
+        .number()
+        .optional()
+        .describe('The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.'),
+    source: z
+        .string()
+        .url()
+        .optional()
+        .describe('The font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2'),
+    format: z.enum(fontFormats).optional().describe('The font format, can be one of woff, woff2'),
+})
+    .refine((data) => {
+    if (data.source) {
+        return !!data.format;
+    }
+    return true;
+});
+export const fontsSchema = z
+    .union([
+    fontDetailsSchema,
+    z
+        .object({
+        heading: fontDetailsSchema.optional(),
+        body: fontDetailsSchema.optional(),
+    })
+        .strict(),
+])
+    .describe('The fonts to be used');

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

@@ -0,0 +1,83 @@
+import { z } from 'zod';
+export declare const footerLinkSchema: z.ZodObject<{
+    label: z.ZodString;
+    href: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    href: string;
+    label: string;
+}, {
+    href: string;
+    label: string;
+}>;
+export declare const footerLinksColumnSchema: z.ZodObject<{
+    header: z.ZodOptional<z.ZodString>;
+    items: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        href: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        href: string;
+        label: string;
+    }, {
+        href: string;
+        label: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        href: string;
+        label: string;
+    }[];
+    header?: string | undefined;
+}, {
+    items: {
+        href: string;
+        label: string;
+    }[];
+    header?: string | undefined;
+}>;
+export declare const footerSocialsSchema: z.ZodRecord<z.ZodEnum<["x", "website", "facebook", "youtube", "discord", "slack", "github", "linkedin", "instagram", "hacker-news", "medium", "telegram", "twitter"]>, z.ZodString>;
+export declare const footerSchema: z.ZodObject<{
+    socials: z.ZodOptional<z.ZodRecord<z.ZodEnum<["x", "website", "facebook", "youtube", "discord", "slack", "github", "linkedin", "instagram", "hacker-news", "medium", "telegram", "twitter"]>, z.ZodString>>;
+    links: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        header: z.ZodOptional<z.ZodString>;
+        items: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            href: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            href: string;
+            label: string;
+        }, {
+            href: string;
+            label: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        items: {
+            href: string;
+            label: string;
+        }[];
+        header?: string | undefined;
+    }, {
+        items: {
+            href: string;
+            label: string;
+        }[];
+        header?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
+    links?: {
+        items: {
+            href: string;
+            label: string;
+        }[];
+        header?: string | undefined;
+    }[] | undefined;
+}, {
+    socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
+    links?: {
+        items: {
+            href: string;
+            label: string;
+        }[];
+        header?: string | undefined;
+    }[] | undefined;
+}>;

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

@@ -0,0 +1,32 @@
+import { footerSocialKeys } from '@mintlify/models';
+import { z } from 'zod';
+import { hrefSchema } from './reusable/href.js';
+export const footerLinkSchema = z.object({
+    label: z.string().nonempty('Link must have a non-empty label').describe('The label of the link'),
+    href: hrefSchema.describe('The url of the link'),
+});
+export const footerLinksColumnSchema = z.object({
+    header: z
+        .string()
+        .nonempty('Column must have a non-empty header')
+        .optional()
+        .describe('The header title of the column'),
+    items: z
+        .array(footerLinkSchema)
+        .min(1, 'Column must have at least 1 link')
+        .describe('The links to be displayed in the column'),
+});
+export const footerSocialsSchema = z
+    .record(z.enum(footerSocialKeys), z.string().url('Must be a valid url'))
+    .describe('An object in which each key is the name of a social media platform, and each value is the url to your profile. For example: { "x": "https://x.com/mintlify" }');
+export const footerSchema = z
+    .object({
+    socials: footerSocialsSchema.optional(),
+    links: z
+        .array(footerLinksColumnSchema)
+        .min(1, 'A footer must have at least 1 links column')
+        .max(4, 'A footer can have a maximum of 4 links columns')
+        .optional()
+        .describe('The links to be displayed in the footer'),
+})
+    .describe('Footer configurations');

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

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const iconsSchema: z.ZodObject<{
+    library: z.ZodDefault<z.ZodEnum<["fontawesome"]>>;
+}, "strip", z.ZodTypeAny, {
+    library: "fontawesome";
+}, {
+    library?: "fontawesome" | undefined;
+}>;

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

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+export const iconsSchema = z
+    .object({
+    library: z.enum(['fontawesome']).default('fontawesome').describe('The icon library to be used'),
+})
+    .describe('Icon library settings');