@mintlify/validation 0.1.227 → 0.1.229

package/dist/mint-config/schemas/v2/properties/reusable/icon.js

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+const iconTypes = [
+    'brands',
+    'duotone',
+    'light',
+    'regular',
+    'sharp-duotone-solid',
+    'sharp-light',
+    'sharp-regular',
+    'sharp-solid',
+    'sharp-thin',
+    'solid',
+    'thin',
+];
+const iconNameSchema = 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((icon) => !icon.startsWith('fa-'), "Icon does not need to start with 'fa-'. Please delete 'fa-' and keep the rest of the icon name");
+export const iconSchema = z
+    .union([iconNameSchema, z.object({ style: z.enum(iconTypes), name: iconNameSchema })])
+    .describe('The icon to be displayed in the section');

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

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const openapiStringSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const openApiSchema: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>;

package/dist/mint-config/schemas/v2/properties/reusable/openapi.js

@@ -0,0 +1,35 @@
+import isAbsoluteUrl from 'is-absolute-url';
+import { z } from 'zod';
+import { normalizeRelativePath } from '../../../../transforms/normalizeRelativePath.js';
+export const openapiStringSchema = z
+    .string()
+    .trim()
+    .nonempty()
+    .transform((value, ctx) => {
+    if (isAbsoluteUrl(value)) {
+        try {
+            const url = new URL(value);
+            if (url.protocol !== 'https:') {
+                ctx.addIssue({
+                    code: z.ZodIssueCode.custom,
+                    message: 'Must use protocol https',
+                });
+                return z.NEVER;
+            }
+        }
+        catch (_a) {
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                message: 'Invalid URL',
+            });
+            return z.NEVER;
+        }
+        return value;
+    }
+    else {
+        return normalizeRelativePath(value);
+    }
+});
+export const openApiSchema = z
+    .union([openapiStringSchema, z.array(openapiStringSchema)])
+    .describe('A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)');

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

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

package/dist/mint-config/schemas/v2/properties/reusable/page.js

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { normalizeRelativePath } from '../../../../transforms/normalizeRelativePath.js';
+export const pageSchema = z
+    .string()
+    .nonempty()
+    .transform(normalizeRelativePath)
+    .describe('A page in the navigation. Referenced by the path to the page. Example: path/to/page');

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

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const searchSchema: z.ZodObject<{
+    prompt: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    prompt?: string | undefined;
+}, {
+    prompt?: string | undefined;
+}>;

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

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export const searchSchema = z
+    .object({
+    prompt: z
+        .string()
+        .optional()
+        .describe('The prompt to be displayed in the search bar placeholder'),
+})
+    .describe('Search display settings');

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

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const metatagsSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+export declare const seoSchema: z.ZodObject<{
+    metatags: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    indexing: z.ZodDefault<z.ZodEnum<["navigable", "all"]>>;
+}, "strip", z.ZodTypeAny, {
+    indexing: "all" | "navigable";
+    metatags?: Record<string, string> | undefined;
+}, {
+    metatags?: Record<string, string> | undefined;
+    indexing?: "all" | "navigable" | undefined;
+}>;

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

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+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');
+export const seoSchema = z
+    .object({
+    metatags: metatagsSchema.optional(),
+    indexing: z
+        .enum(['navigable', 'all'])
+        .default('navigable')
+        .describe('Specify which pages to be indexed by search engines. Setting "navigable" indexes pages that are set in navigation, "all" indexes all pages'),
+})
+    .describe('SEO indexing configurations');

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

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const stylingSchema: z.ZodObject<{
+    rounded: z.ZodDefault<z.ZodOptional<z.ZodEnum<["regular", "sharp"]>>>;
+    eyebrows: z.ZodDefault<z.ZodOptional<z.ZodEnum<["section", "breadcrumbs"]>>>;
+    codeblocks: z.ZodDefault<z.ZodOptional<z.ZodEnum<["auto", "dark"]>>>;
+}, "strip", z.ZodTypeAny, {
+    rounded: "regular" | "sharp";
+    eyebrows: "section" | "breadcrumbs";
+    codeblocks: "dark" | "auto";
+}, {
+    rounded?: "regular" | "sharp" | undefined;
+    eyebrows?: "section" | "breadcrumbs" | undefined;
+    codeblocks?: "dark" | "auto" | undefined;
+}>;

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

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+export const stylingSchema = z
+    .object({
+    rounded: z
+        .enum(['regular', 'sharp'])
+        .optional()
+        .default('regular')
+        .describe('Whether corners are rounded or sharp'),
+    eyebrows: z
+        .enum(['section', 'breadcrumbs'])
+        .optional()
+        .default('section')
+        .describe('The eyebrows style of the content'),
+    codeblocks: z.enum(['auto', 'dark']).optional().default('auto').describe('The codeblock theme'),
+})
+    .describe('Styling configurations');

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

@@ -0,0 +1,61 @@
+import { z } from 'zod';
+export declare const topbarSchema: z.ZodObject<{
+    links: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        href: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        href: string;
+        label: string;
+    }, {
+        href: string;
+        label: string;
+    }>, "many">>;
+    primary: z.ZodOptional<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"button">;
+        label: z.ZodString;
+        href: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "button";
+        href: string;
+        label: string;
+    }, {
+        type: "button";
+        href: string;
+        label: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"github">;
+        href: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "github";
+        href: string;
+    }, {
+        type: "github";
+        href: string;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    links?: {
+        href: string;
+        label: string;
+    }[] | undefined;
+    primary?: {
+        type: "button";
+        href: string;
+        label: string;
+    } | {
+        type: "github";
+        href: string;
+    } | undefined;
+}, {
+    links?: {
+        href: string;
+        label: string;
+    }[] | undefined;
+    primary?: {
+        type: "button";
+        href: string;
+        label: string;
+    } | {
+        type: "github";
+        href: string;
+    } | undefined;
+}>;

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

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+import { hrefSchema } from './reusable/href.js';
+const linkSchema = z.object({
+    label: z.string(),
+    href: hrefSchema,
+});
+const buttonSchema = z.object({
+    type: z.literal('button'),
+    label: z.string(),
+    href: hrefSchema,
+});
+const githubSchema = z.object({
+    type: z.literal('github'),
+    href: hrefSchema,
+});
+const primarySchema = z.discriminatedUnion('type', [buttonSchema, githubSchema]);
+export const topbarSchema = z
+    .object({
+    links: z.array(linkSchema).optional().describe('The links in the topbar'),
+    primary: primarySchema.optional().describe('The primary CTA in the topbar'),
+})
+    .describe('Topbar content and settings');