@mintlify/validation 0.1.10 → 0.1.11

package/dist/schemas/config.d.ts

@@ -0,0 +1,651 @@
+import { z } from "zod";
+export declare const configSchema: z.ZodObject<{
+    $schema: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    mintlify: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    logo: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        light: z.ZodString;
+        dark: z.ZodString;
+        href: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        href?: string | undefined;
+        light: string;
+        dark: string;
+    }, {
+        href?: string | undefined;
+        light: string;
+        dark: string;
+    }>]>>;
+    favicon: z.ZodEffects<z.ZodString, string, string>;
+    openApi: z.ZodOptional<z.ZodString>;
+    api: z.ZodOptional<z.ZodObject<{
+        baseUrl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+        auth: z.ZodOptional<z.ZodObject<{
+            method: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+            name: z.ZodOptional<z.ZodString>;
+            inputPrefix: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name?: string | undefined;
+            method?: string | undefined;
+            inputPrefix?: string | undefined;
+        }, {
+            name?: string | undefined;
+            method?: string | undefined;
+            inputPrefix?: string | undefined;
+        }>>;
+        hidePlayground: z.ZodOptional<z.ZodBoolean>;
+    }, "strict", z.ZodTypeAny, {
+        baseUrl?: string | string[] | undefined;
+        auth?: {
+            name?: string | undefined;
+            method?: string | undefined;
+            inputPrefix?: string | undefined;
+        } | undefined;
+        hidePlayground?: boolean | undefined;
+    }, {
+        baseUrl?: string | string[] | undefined;
+        auth?: {
+            name?: string | undefined;
+            method?: string | undefined;
+            inputPrefix?: string | undefined;
+        } | undefined;
+        hidePlayground?: boolean | undefined;
+    }>>;
+    modeToggle: z.ZodOptional<z.ZodObject<{
+        default: z.ZodOptional<z.ZodString>;
+        isHidden: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        default?: string | undefined;
+        isHidden?: boolean | undefined;
+    }, {
+        default?: string | undefined;
+        isHidden?: boolean | undefined;
+    }>>;
+    versions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    colors: z.ZodObject<{
+        primary: z.ZodString;
+        light: z.ZodOptional<z.ZodString>;
+        dark: z.ZodOptional<z.ZodString>;
+        background: z.ZodOptional<z.ZodObject<{
+            light: z.ZodOptional<z.ZodString>;
+            dark: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            light?: string | undefined;
+            dark?: string | undefined;
+        }, {
+            light?: string | undefined;
+            dark?: string | undefined;
+        }>>;
+        anchors: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+            from: z.ZodString;
+            via: z.ZodOptional<z.ZodString>;
+            to: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        }, {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        }>]>>;
+        ultraLight: z.ZodOptional<z.ZodAny>;
+        ultraDark: z.ZodOptional<z.ZodAny>;
+    }, "strict", z.ZodTypeAny, {
+        light?: string | undefined;
+        dark?: string | undefined;
+        background?: {
+            light?: string | undefined;
+            dark?: string | undefined;
+        } | undefined;
+        anchors?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        ultraLight?: any;
+        ultraDark?: any;
+        primary: string;
+    }, {
+        light?: string | undefined;
+        dark?: string | undefined;
+        background?: {
+            light?: string | undefined;
+            dark?: string | undefined;
+        } | undefined;
+        anchors?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        ultraLight?: any;
+        ultraDark?: any;
+        primary: string;
+    }>;
+    topbarCtaButton: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        type: z.ZodOptional<z.ZodLiteral<"link">>;
+        name: z.ZodString;
+        url: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    }, {
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"github">;
+        url: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type: "github";
+        url: string;
+    }, {
+        type: "github";
+        url: string;
+    }>]>>;
+    topbarLinks: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        type: z.ZodOptional<z.ZodLiteral<"link">>;
+        name: z.ZodString;
+        url: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    }, {
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"github">;
+        url: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type: "github";
+        url: string;
+    }, {
+        type: "github";
+        url: string;
+    }>]>, "many">>;
+    navigation: z.ZodArray<z.ZodType<import("../types/navigation").NavigationType, z.ZodTypeDef, import("../types/navigation").NavigationType>, "many">;
+    topAnchor: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        icon: z.ZodOptional<z.ZodString>;
+        iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
+    }, "strict", z.ZodTypeAny, {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        name: string;
+    }, {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        name: string;
+    }>>;
+    anchors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        url: z.ZodString;
+        icon: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
+        color: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+            from: z.ZodString;
+            via: z.ZodOptional<z.ZodString>;
+            to: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        }, {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        }>]>>;
+        isDefaultHidden: z.ZodOptional<z.ZodBoolean>;
+        version: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        color?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        isDefaultHidden?: boolean | undefined;
+        version?: string | undefined;
+        name: string;
+        url: string;
+    }, {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        color?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        isDefaultHidden?: boolean | undefined;
+        version?: string | undefined;
+        name: string;
+        url: string;
+    }>, "many">>;
+    footerSocials: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        url: string;
+    }, {
+        type: string;
+        url: string;
+    }>, "many">, z.ZodRecord<z.ZodString, z.ZodString>]>>;
+    backgroundImage: z.ZodOptional<z.ZodString>;
+    analytics: z.ZodOptional<z.ZodObject<{
+        amplitude: z.ZodOptional<z.ZodObject<{
+            apiKey: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            apiKey: string;
+        }, {
+            apiKey: string;
+        }>>;
+        fathom: z.ZodOptional<z.ZodObject<{
+            siteId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            siteId: string;
+        }, {
+            siteId: string;
+        }>>;
+        ga4: z.ZodOptional<z.ZodObject<{
+            measurementId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            measurementId: string;
+        }, {
+            measurementId: string;
+        }>>;
+        gtm: z.ZodOptional<z.ZodObject<{
+            tagId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            tagId: string;
+        }, {
+            tagId: string;
+        }>>;
+        hotjar: z.ZodOptional<z.ZodObject<{
+            hjid: z.ZodString;
+            hjsv: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            hjid: string;
+            hjsv: string;
+        }, {
+            hjid: string;
+            hjsv: string;
+        }>>;
+        koala: z.ZodOptional<z.ZodObject<{
+            projectId: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            projectId: string;
+        }, {
+            projectId: string;
+        }>>;
+        logrocket: z.ZodOptional<z.ZodObject<{
+            appId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            appId: string;
+        }, {
+            appId: string;
+        }>>;
+        mixpanel: z.ZodOptional<z.ZodObject<{
+            projectToken: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            projectToken: string;
+        }, {
+            projectToken: string;
+        }>>;
+        pirsch: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>>;
+        posthog: z.ZodOptional<z.ZodObject<{
+            apiKey: z.ZodString;
+            apiHost: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            apiHost?: string | undefined;
+            apiKey: string;
+        }, {
+            apiHost?: string | undefined;
+            apiKey: string;
+        }>>;
+        plausible: z.ZodOptional<z.ZodObject<{
+            domain: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            domain: string;
+        }, {
+            domain: string;
+        }>>;
+    }, "strict", z.ZodTypeAny, {
+        amplitude?: {
+            apiKey: string;
+        } | undefined;
+        fathom?: {
+            siteId: string;
+        } | undefined;
+        ga4?: {
+            measurementId: string;
+        } | undefined;
+        gtm?: {
+            tagId: string;
+        } | undefined;
+        hotjar?: {
+            hjid: string;
+            hjsv: string;
+        } | undefined;
+        koala?: {
+            projectId: string;
+        } | undefined;
+        logrocket?: {
+            appId: string;
+        } | undefined;
+        mixpanel?: {
+            projectToken: string;
+        } | undefined;
+        pirsch?: {
+            id: string;
+        } | undefined;
+        posthog?: {
+            apiHost?: string | undefined;
+            apiKey: string;
+        } | undefined;
+        plausible?: {
+            domain: string;
+        } | undefined;
+    }, {
+        amplitude?: {
+            apiKey: string;
+        } | undefined;
+        fathom?: {
+            siteId: string;
+        } | undefined;
+        ga4?: {
+            measurementId: string;
+        } | undefined;
+        gtm?: {
+            tagId: string;
+        } | undefined;
+        hotjar?: {
+            hjid: string;
+            hjsv: string;
+        } | undefined;
+        koala?: {
+            projectId: string;
+        } | undefined;
+        logrocket?: {
+            appId: string;
+        } | undefined;
+        mixpanel?: {
+            projectToken: string;
+        } | undefined;
+        pirsch?: {
+            id: string;
+        } | undefined;
+        posthog?: {
+            apiHost?: string | undefined;
+            apiKey: string;
+        } | undefined;
+        plausible?: {
+            domain: string;
+        } | undefined;
+    }>>;
+    integrations: z.ZodOptional<z.ZodObject<{
+        intercom: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        intercom?: string | undefined;
+    }, {
+        intercom?: string | undefined;
+    }>>;
+    __injected: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    mintlify?: string | undefined;
+    logo?: string | {
+        href?: string | undefined;
+        light: string;
+        dark: string;
+    } | undefined;
+    openApi?: string | undefined;
+    api?: {
+        baseUrl?: string | string[] | undefined;
+        auth?: {
+            name?: string | undefined;
+            method?: string | undefined;
+            inputPrefix?: string | undefined;
+        } | undefined;
+        hidePlayground?: boolean | undefined;
+    } | undefined;
+    modeToggle?: {
+        default?: string | undefined;
+        isHidden?: boolean | undefined;
+    } | undefined;
+    versions?: string[] | undefined;
+    metadata?: Record<string, string> | undefined;
+    anchors?: {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        color?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        isDefaultHidden?: boolean | undefined;
+        version?: string | undefined;
+        name: string;
+        url: string;
+    }[] | undefined;
+    topbarCtaButton?: {
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    } | {
+        type: "github";
+        url: string;
+    } | undefined;
+    topbarLinks?: ({
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    } | {
+        type: "github";
+        url: string;
+    })[] | undefined;
+    topAnchor?: {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        name: string;
+    } | undefined;
+    footerSocials?: Record<string, string> | {
+        type: string;
+        url: string;
+    }[] | undefined;
+    backgroundImage?: string | undefined;
+    analytics?: {
+        amplitude?: {
+            apiKey: string;
+        } | undefined;
+        fathom?: {
+            siteId: string;
+        } | undefined;
+        ga4?: {
+            measurementId: string;
+        } | undefined;
+        gtm?: {
+            tagId: string;
+        } | undefined;
+        hotjar?: {
+            hjid: string;
+            hjsv: string;
+        } | undefined;
+        koala?: {
+            projectId: string;
+        } | undefined;
+        logrocket?: {
+            appId: string;
+        } | undefined;
+        mixpanel?: {
+            projectToken: string;
+        } | undefined;
+        pirsch?: {
+            id: string;
+        } | undefined;
+        posthog?: {
+            apiHost?: string | undefined;
+            apiKey: string;
+        } | undefined;
+        plausible?: {
+            domain: string;
+        } | undefined;
+    } | undefined;
+    integrations?: {
+        intercom?: string | undefined;
+    } | undefined;
+    __injected?: undefined;
+    $schema: string;
+    name: string;
+    favicon: string;
+    colors: {
+        light?: string | undefined;
+        dark?: string | undefined;
+        background?: {
+            light?: string | undefined;
+            dark?: string | undefined;
+        } | undefined;
+        anchors?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        ultraLight?: any;
+        ultraDark?: any;
+        primary: string;
+    };
+    navigation: import("../types/navigation").NavigationType[];
+}, {
+    $schema?: string | undefined;
+    mintlify?: string | undefined;
+    logo?: string | {
+        href?: string | undefined;
+        light: string;
+        dark: string;
+    } | undefined;
+    openApi?: string | undefined;
+    api?: {
+        baseUrl?: string | string[] | undefined;
+        auth?: {
+            name?: string | undefined;
+            method?: string | undefined;
+            inputPrefix?: string | undefined;
+        } | undefined;
+        hidePlayground?: boolean | undefined;
+    } | undefined;
+    modeToggle?: {
+        default?: string | undefined;
+        isHidden?: boolean | undefined;
+    } | undefined;
+    versions?: string[] | undefined;
+    metadata?: Record<string, string> | undefined;
+    anchors?: {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        color?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        isDefaultHidden?: boolean | undefined;
+        version?: string | undefined;
+        name: string;
+        url: string;
+    }[] | undefined;
+    topbarCtaButton?: {
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    } | {
+        type: "github";
+        url: string;
+    } | undefined;
+    topbarLinks?: ({
+        type?: "link" | undefined;
+        name: string;
+        url: string;
+    } | {
+        type: "github";
+        url: string;
+    })[] | undefined;
+    topAnchor?: {
+        icon?: string | undefined;
+        iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
+        name: string;
+    } | undefined;
+    footerSocials?: Record<string, string> | {
+        type: string;
+        url: string;
+    }[] | undefined;
+    backgroundImage?: string | undefined;
+    analytics?: {
+        amplitude?: {
+            apiKey: string;
+        } | undefined;
+        fathom?: {
+            siteId: string;
+        } | undefined;
+        ga4?: {
+            measurementId: string;
+        } | undefined;
+        gtm?: {
+            tagId: string;
+        } | undefined;
+        hotjar?: {
+            hjid: string;
+            hjsv: string;
+        } | undefined;
+        koala?: {
+            projectId: string;
+        } | undefined;
+        logrocket?: {
+            appId: string;
+        } | undefined;
+        mixpanel?: {
+            projectToken: string;
+        } | undefined;
+        pirsch?: {
+            id: string;
+        } | undefined;
+        posthog?: {
+            apiHost?: string | undefined;
+            apiKey: string;
+        } | undefined;
+        plausible?: {
+            domain: string;
+        } | undefined;
+    } | undefined;
+    integrations?: {
+        intercom?: string | undefined;
+    } | undefined;
+    __injected?: undefined;
+    name: string;
+    favicon: string;
+    colors: {
+        light?: string | undefined;
+        dark?: string | undefined;
+        background?: {
+            light?: string | undefined;
+            dark?: string | undefined;
+        } | undefined;
+        anchors?: string | {
+            via?: string | undefined;
+            from: string;
+            to: string;
+        } | undefined;
+        ultraLight?: any;
+        ultraDark?: any;
+        primary: string;
+    };
+    navigation: import("../types/navigation").NavigationType[];
+}>;

package/dist/schemas/favicon.d.ts

@@ -0,0 +1,2 @@
+import { z } from "zod";
+export declare const faviconSchema: z.ZodEffects<z.ZodString, string, string>;

package/dist/schemas/name.d.ts

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

package/dist/schemas/navigation.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { NavigationType } from "../types/navigation";
+export declare const navigationConfigSchema: z.ZodArray<z.ZodType<NavigationType, z.ZodTypeDef, NavigationType>, "many">;

package/dist/schemas/versions.d.ts

@@ -0,0 +1,2 @@
+import { z } from "zod";
+export declare const versionsSchema: z.ZodArray<z.ZodString, "many">;

package/dist/types/analytics.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { analyticsSchema } from "../schemas/analytics";
+export type AnalyticsType = z.infer<typeof analyticsSchema>;

package/dist/types/anchors.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { anchorsSchema } from "../schemas/anchors";
+export type AnchorsType = z.infer<typeof anchorsSchema>;

package/dist/types/colors.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { colorsSchema } from "../schemas/colors";
+export type ColorsType = z.infer<typeof colorsSchema>;

package/dist/types/config.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { configSchema } from "../schemas/config";
+export type ConfigType = z.infer<typeof configSchema>;

package/dist/types/navigation.d.ts

@@ -0,0 +1,6 @@
+export type NavigationEntry = string | NavigationType;
+export type NavigationType = {
+    group: string;
+    pages: NavigationEntry[];
+    version?: string;
+};

package/dist/types/versions.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { versionsSchema } from "../schemas/versions";
+export type VersionsType = z.infer<typeof versionsSchema>;

package/dist/utils/common.d.ts

@@ -0,0 +1,6 @@
+export declare class MintValidationResults {
+    status: "error" | "success";
+    errors: string[];
+    warnings: string[];
+    constructor();
+}