@mintlify/validation 0.1.227 → 0.1.228

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

@@ -0,0 +1,241 @@
+import { z } from 'zod';
+export declare const integrationsSchema: z.ZodObject<{
+    amplitude: z.ZodOptional<z.ZodObject<{
+        apiKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        apiKey: string;
+    }, {
+        apiKey: string;
+    }>>;
+    clearbit: z.ZodOptional<z.ZodObject<{
+        publicApiKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        publicApiKey: string;
+    }, {
+        publicApiKey: string;
+    }>>;
+    fathom: z.ZodOptional<z.ZodObject<{
+        siteId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        siteId: string;
+    }, {
+        siteId: string;
+    }>>;
+    frontchat: z.ZodOptional<z.ZodObject<{
+        snippetId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        snippetId: string;
+    }, {
+        snippetId: 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;
+    }>>;
+    heap: z.ZodOptional<z.ZodObject<{
+        appId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appId: string;
+    }, {
+        appId: string;
+    }>>;
+    hotjar: z.ZodOptional<z.ZodObject<{
+        hjid: z.ZodString;
+        hjsv: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        hjid: string;
+        hjsv: string;
+    }, {
+        hjid: string;
+        hjsv: string;
+    }>>;
+    intercom: z.ZodOptional<z.ZodObject<{
+        appId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appId: string;
+    }, {
+        appId: string;
+    }>>;
+    koala: z.ZodOptional<z.ZodObject<{
+        publicApiKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        publicApiKey: string;
+    }, {
+        publicApiKey: 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;
+    }>>;
+    osano: z.ZodOptional<z.ZodObject<{
+        scriptSource: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        scriptSource: string;
+    }, {
+        scriptSource: 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, {
+        apiKey: string;
+        apiHost?: string | undefined;
+    }, {
+        apiKey: string;
+        apiHost?: string | undefined;
+    }>>;
+    plausible: z.ZodOptional<z.ZodObject<{
+        domain: z.ZodEffects<z.ZodString, string, string>;
+        server: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    }, "strip", z.ZodTypeAny, {
+        domain: string;
+        server?: string | undefined;
+    }, {
+        domain: string;
+        server?: string | undefined;
+    }>>;
+    segment: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+    }, {
+        key: string;
+    }>>;
+}, "strict", z.ZodTypeAny, {
+    amplitude?: {
+        apiKey: string;
+    } | undefined;
+    clearbit?: {
+        publicApiKey: string;
+    } | undefined;
+    fathom?: {
+        siteId: string;
+    } | undefined;
+    frontchat?: {
+        snippetId: string;
+    } | undefined;
+    ga4?: {
+        measurementId: string;
+    } | undefined;
+    gtm?: {
+        tagId: string;
+    } | undefined;
+    heap?: {
+        appId: string;
+    } | undefined;
+    hotjar?: {
+        hjid: string;
+        hjsv: string;
+    } | undefined;
+    intercom?: {
+        appId: string;
+    } | undefined;
+    koala?: {
+        publicApiKey: string;
+    } | undefined;
+    logrocket?: {
+        appId: string;
+    } | undefined;
+    mixpanel?: {
+        projectToken: string;
+    } | undefined;
+    osano?: {
+        scriptSource: string;
+    } | undefined;
+    pirsch?: {
+        id: string;
+    } | undefined;
+    posthog?: {
+        apiKey: string;
+        apiHost?: string | undefined;
+    } | undefined;
+    plausible?: {
+        domain: string;
+        server?: string | undefined;
+    } | undefined;
+    segment?: {
+        key: string;
+    } | undefined;
+}, {
+    amplitude?: {
+        apiKey: string;
+    } | undefined;
+    clearbit?: {
+        publicApiKey: string;
+    } | undefined;
+    fathom?: {
+        siteId: string;
+    } | undefined;
+    frontchat?: {
+        snippetId: string;
+    } | undefined;
+    ga4?: {
+        measurementId: string;
+    } | undefined;
+    gtm?: {
+        tagId: string;
+    } | undefined;
+    heap?: {
+        appId: string;
+    } | undefined;
+    hotjar?: {
+        hjid: string;
+        hjsv: string;
+    } | undefined;
+    intercom?: {
+        appId: string;
+    } | undefined;
+    koala?: {
+        publicApiKey: string;
+    } | undefined;
+    logrocket?: {
+        appId: string;
+    } | undefined;
+    mixpanel?: {
+        projectToken: string;
+    } | undefined;
+    osano?: {
+        scriptSource: string;
+    } | undefined;
+    pirsch?: {
+        id: string;
+    } | undefined;
+    posthog?: {
+        apiKey: string;
+        apiHost?: string | undefined;
+    } | undefined;
+    plausible?: {
+        domain: string;
+        server?: string | undefined;
+    } | undefined;
+    segment?: {
+        key: string;
+    } | undefined;
+}>;

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

@@ -0,0 +1,85 @@
+import { z } from 'zod';
+const amplitudeConfigSchema = z.object({
+    apiKey: z.string(),
+});
+const clearbitConfigSchema = z.object({
+    publicApiKey: z.string(),
+});
+const fathomConfigSchema = z.object({
+    siteId: z.string(),
+});
+const googleAnalyticsConfigSchema = z.object({
+    measurementId: z.string().startsWith('G', 'Must start with G'),
+});
+const googleTagManagerConfigSchema = z.object({
+    tagId: z.string().startsWith('G', 'Must start with G'),
+});
+const hotjarConfigSchema = z.object({
+    hjid: z.string(),
+    hjsv: z.string(),
+});
+const koalaConfigSchema = z.object({
+    publicApiKey: z.string().min(2),
+});
+const logrocketConfigSchema = z.object({
+    appId: z.string(),
+});
+const mixpanelConfigSchema = z.object({
+    projectToken: z.string(),
+});
+const pirschConfigSchema = z.object({
+    id: z.string(),
+});
+const postHogConfigSchema = z.object({
+    apiKey: z.string().startsWith('phc_', 'Must start with phc_'),
+    apiHost: z.string().url('Must be a valid URL').optional(),
+});
+const plausibleConfigSchema = z.object({
+    domain: z
+        .string()
+        .refine((domain) => !domain.startsWith('https://'), 'Must not start with https://'),
+    server: z
+        .string()
+        .refine((server) => !server.startsWith('https://'), 'Must not start with https://')
+        .optional(),
+});
+const heapConfigSchema = z.object({
+    appId: z.string(),
+});
+const segmentConfigSchema = z.object({
+    key: z.string(),
+});
+const intercomSchema = z.object({
+    appId: z.string().min(6, 'Must be a valid Intercom app ID'),
+});
+const frontchatSchema = z.object({
+    snippetId: z.string().min(6, 'Must be a valid Front chat snippet id'),
+});
+const osanoSchema = z.object({
+    scriptSource: z
+        .string()
+        .startsWith('https://cmp.osano.com/', 'A valid Osano script source must start with https://cmp.osano.com/')
+        .endsWith('/osano.js', 'A valid Osano script source must end with /osano.js'),
+});
+export const integrationsSchema = z
+    .object({
+    amplitude: amplitudeConfigSchema.optional(),
+    clearbit: clearbitConfigSchema.optional(),
+    fathom: fathomConfigSchema.optional(),
+    frontchat: frontchatSchema.optional(),
+    ga4: googleAnalyticsConfigSchema.optional(),
+    gtm: googleTagManagerConfigSchema.optional(),
+    heap: heapConfigSchema.optional(),
+    hotjar: hotjarConfigSchema.optional(),
+    intercom: intercomSchema.optional(),
+    koala: koalaConfigSchema.optional(),
+    logrocket: logrocketConfigSchema.optional(),
+    mixpanel: mixpanelConfigSchema.optional(),
+    osano: osanoSchema.optional(),
+    pirsch: pirschConfigSchema.optional(),
+    posthog: postHogConfigSchema.optional(),
+    plausible: plausibleConfigSchema.optional(),
+    segment: segmentConfigSchema.optional(),
+})
+    .strict()
+    .describe('Configurations for official integrations');

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

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const legacySchema: z.ZodObject<{
+    baseurl: z.ZodString;
+    auth: z.ZodEnum<["basic", "bearer", "cobo", "key"]>;
+}, "strip", z.ZodTypeAny, {
+    auth: "key" | "bearer" | "basic" | "cobo";
+    baseurl: string;
+}, {
+    auth: "key" | "bearer" | "basic" | "cobo";
+    baseurl: string;
+}>;

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

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export const legacySchema = z
+    .object({
+    baseurl: z.string().describe('The base URL for legacy API calls'),
+    auth: z
+        .enum(['basic', 'bearer', 'cobo', 'key'])
+        .describe('The authentication type for legacy API calls'),
+})
+    .describe('Legacy API configuration');

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

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const logoSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
+    light: z.ZodString;
+    dark: z.ZodString;
+    href: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    light: string;
+    dark: string;
+    href?: string | undefined;
+}, {
+    light: string;
+    dark: string;
+    href?: string | undefined;
+}>]>;

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

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+import { hrefSchema } from './reusable/href.js';
+export const logoSchema = z
+    .union([
+    z
+        .string()
+        .min(3, 'Must be a path to your logo file including the file extension')
+        .describe('The logo (for both light and dark mode)'),
+    z.object({
+        light: z
+            .string()
+            .describe('Path pointing to the light logo file to use in dark mode, including the file extension. Example: `/logo.png`'),
+        dark: z
+            .string()
+            .describe('Path pointing to the dark logo file to use in light mode, including the file extension. Example: `/logo-dark.png`'),
+        href: hrefSchema
+            .optional()
+            .describe('The URL to redirect to when clicking the logo. If not provided, the logo will link to the homepage. Example: `https://example.com`'),
+    }),
+])
+    .describe('The logo configuration. Can be a single image path for both light and dark mode, or separate paths for each mode with an optional click target URL');

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

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

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

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+export const nameSchema = z
+    .string()
+    .trim()
+    .nonempty()
+    .describe('The name of the project, organization, or product');

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

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const anchorsSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">;

package/dist/mint-config/schemas/v2/properties/navigation/anchors.js

@@ -0,0 +1,30 @@
+import { z } from 'zod';
+import { colorSchema } from '../reusable/color.js';
+import { hiddenSchema } from '../reusable/hidden.js';
+import { hrefSchema } from '../reusable/href.js';
+import { iconSchema } from '../reusable/icon.js';
+import { openApiSchema } from '../reusable/openapi.js';
+import { dropdownsSchema } from './dropdown.js';
+import { groupsSchema } from './groups.js';
+import { languagesSchema } from './languages.js';
+import { pagesSchema } from './pages.js';
+import { tabsSchema } from './tabs.js';
+import { versionsSchema } from './version.js';
+const anchorSchema = z
+    .object({
+    anchor: z.string().nonempty().describe('The name of the anchor'),
+    icon: iconSchema.optional(),
+    color: colorSchema.optional(),
+    hidden: hiddenSchema.optional(),
+})
+    .and(z.union([
+    z.object({ href: hrefSchema }),
+    z.object({ openapi: openApiSchema }),
+    z.object({ languages: languagesSchema }),
+    z.object({ versions: versionsSchema }),
+    z.object({ dropdowns: dropdownsSchema }),
+    z.object({ tabs: tabsSchema }),
+    z.object({ groups: groupsSchema }),
+    z.object({ pages: pagesSchema }),
+]));
+export const anchorsSchema = z.array(anchorSchema).describe('Organizing by anchors');

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

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const dropdownsSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">;

package/dist/mint-config/schemas/v2/properties/navigation/dropdown.js

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+import { hiddenSchema } from '../reusable/hidden.js';
+import { hrefSchema } from '../reusable/href.js';
+import { iconSchema } from '../reusable/icon.js';
+import { openApiSchema } from '../reusable/openapi.js';
+import { anchorsSchema } from './anchors.js';
+import { groupsSchema } from './groups.js';
+import { languagesSchema } from './languages.js';
+import { pagesSchema } from './pages.js';
+import { tabsSchema } from './tabs.js';
+import { versionsSchema } from './version.js';
+const dropdownSchema = z
+    .object({
+    dropdown: z.string().nonempty().describe('The name of the dropdown'),
+    icon: iconSchema.optional(),
+    hidden: hiddenSchema.optional(),
+})
+    .and(z.union([
+    z.object({ href: hrefSchema }),
+    z.object({ openapi: openApiSchema }),
+    z.object({ languages: languagesSchema }),
+    z.object({ versions: versionsSchema }),
+    z.object({ tabs: tabsSchema }),
+    z.object({ anchors: anchorsSchema }),
+    z.object({ groups: groupsSchema }),
+    z.object({ pages: pagesSchema }),
+]));
+export const dropdownsSchema = z.array(dropdownSchema).describe('Organizing by dropdowns');

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

@@ -0,0 +1,87 @@
+import { z } from 'zod';
+export declare const groupSchema: z.ZodIntersection<z.ZodObject<{
+    group: z.ZodString;
+    icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
+        style: z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>;
+        name: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    }, {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    }>]>>;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+}, "strip", z.ZodTypeAny, {
+    group: string;
+    icon?: string | {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    } | undefined;
+    hidden?: boolean | undefined;
+    root?: string | undefined;
+}, {
+    group: string;
+    icon?: string | {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    } | undefined;
+    hidden?: boolean | undefined;
+    root?: string | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>;
+}, "strip", z.ZodTypeAny, {
+    openapi: (string | string[]) & (string | string[] | undefined);
+}, {
+    openapi: (string | string[]) & (string | string[] | undefined);
+}>, z.ZodObject<{
+    pages: z.ZodArray<z.ZodType<import("./pages.js").Page, z.ZodTypeDef, import("./pages.js").Page>, "many">;
+}, "strip", z.ZodTypeAny, {
+    pages: import("./pages.js").Page[];
+}, {
+    pages: import("./pages.js").Page[];
+}>]>>;
+export declare const groupsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{
+    group: z.ZodString;
+    icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
+        style: z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>;
+        name: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    }, {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    }>]>>;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+}, "strip", z.ZodTypeAny, {
+    group: string;
+    icon?: string | {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    } | undefined;
+    hidden?: boolean | undefined;
+    root?: string | undefined;
+}, {
+    group: string;
+    icon?: string | {
+        name: string;
+        style: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin";
+    } | undefined;
+    hidden?: boolean | undefined;
+    root?: string | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>;
+}, "strip", z.ZodTypeAny, {
+    openapi: (string | string[]) & (string | string[] | undefined);
+}, {
+    openapi: (string | string[]) & (string | string[] | undefined);
+}>, z.ZodObject<{
+    pages: z.ZodArray<z.ZodType<import("./pages.js").Page, z.ZodTypeDef, import("./pages.js").Page>, "many">;
+}, "strip", z.ZodTypeAny, {
+    pages: import("./pages.js").Page[];
+}, {
+    pages: import("./pages.js").Page[];
+}>]>>, "many">;

package/dist/mint-config/schemas/v2/properties/navigation/groups.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { hiddenSchema } from '../reusable/hidden.js';
+import { iconSchema } from '../reusable/icon.js';
+import { openApiSchema } from '../reusable/openapi.js';
+import { pageSchema } from '../reusable/page.js';
+import { pagesSchema } from './pages.js';
+export const groupSchema = z
+    .object({
+    group: z.string().nonempty().describe('The name of the group'),
+    icon: iconSchema.optional(),
+    hidden: hiddenSchema.optional(),
+    root: pageSchema.optional(),
+})
+    .and(z.union([z.object({ openapi: openApiSchema }), z.object({ pages: pagesSchema })]))
+    .describe('Organizing by groups');
+export const groupsSchema = z.array(groupSchema);