@mintlify/validation 0.1.246 → 0.1.247

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

@@ -1,14 +1,16 @@
 import { z } from 'zod';
-export declare const versionSchema: z.ZodType;
 export declare const nonRecursiveVersionSchema: z.ZodIntersection<z.ZodObject<{
     version: z.ZodString;
     hidden: z.ZodOptional<z.ZodBoolean>;
+    openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
 }, "strip", z.ZodTypeAny, {
     version: string;
     hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
 }, {
     version: string;
     hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
 }>, z.ZodObject<{
     href: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -16,6 +18,83 @@ export declare const nonRecursiveVersionSchema: z.ZodIntersection<z.ZodObject<{
 }, {
     href: string;
 }>>;
-export declare const versionsSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">;
+export declare const versionSchema: z.ZodIntersection<z.ZodObject<{
+    version: z.ZodString;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    href: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    href: string;
+}, {
+    href: string;
+}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>;
+export declare const decoratedVersionSchema: z.ZodIntersection<z.ZodObject<{
+    version: z.ZodString;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    href: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    href: string;
+}, {
+    href: string;
+}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>;
+export declare const versionsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{
+    version: z.ZodString;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    href: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    href: string;
+}, {
+    href: string;
+}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">;
+export declare const decoratedVersionsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{
+    version: z.ZodString;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}, {
+    version: string;
+    hidden?: boolean | undefined;
+    openapi?: string | string[] | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    href: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    href: string;
+}, {
+    href: string;
+}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">;
 export type VersionsConfig = z.infer<typeof versionsSchema>;
 export type VersionConfig = z.infer<typeof versionSchema>;
+export type DecoratedVersionsConfig = z.infer<typeof decoratedVersionsSchema>;
+export type DecoratedVersionConfig = z.infer<typeof decoratedVersionSchema>;

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

@@ -2,25 +2,19 @@ import { z } from 'zod';
 import { hiddenSchema } from '../reusable/hidden.js';
 import { hrefSchema } from '../reusable/href.js';
 import { openApiSchema } from '../reusable/openapi.js';
-import { anchorsSchema } from './anchors.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 { getDivisionSchemasExcluding, registerDivisionSchema } from './divisionSchemas.js';
 const baseVersionSchema = z.object({
     version: z.string().nonempty().describe('The name of the version'),
     hidden: hiddenSchema.optional(),
+    openapi: openApiSchema.optional(),
 });
-export const versionSchema = baseVersionSchema.and(z.union([
-    z.object({ openapi: openApiSchema }),
-    z.object({ href: hrefSchema }),
-    z.lazy(() => z.object({ languages: languagesSchema })),
-    z.lazy(() => z.object({ tabs: tabsSchema })),
-    z.lazy(() => z.object({ dropdowns: dropdownsSchema })),
-    z.lazy(() => z.object({ anchors: anchorsSchema })),
-    z.lazy(() => z.object({ groups: groupsSchema })),
-    z.lazy(() => z.object({ pages: pagesSchema })),
-]));
+const createVersionSchema = (type) => baseVersionSchema.and(z.union([z.object({ href: hrefSchema }), ...getDivisionSchemasExcluding('versions', type)]));
 export const nonRecursiveVersionSchema = baseVersionSchema.and(z.object({ href: hrefSchema }));
+export const versionSchema = createVersionSchema('default');
+export const decoratedVersionSchema = createVersionSchema('decorated');
 export const versionsSchema = z.array(versionSchema).describe('Organizing by versions');
+export const decoratedVersionsSchema = z
+    .array(decoratedVersionSchema)
+    .describe('Organizing by versions');
+registerDivisionSchema('versions', versionsSchema, 'default');
+registerDivisionSchema('versions', decoratedVersionsSchema, 'decorated');

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

@@ -0,0 +1,2 @@
+export declare const divisions: readonly ["anchors", "dropdowns", "languages", "tabs", "versions"];
+export type Division = (typeof divisions)[number];

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

@@ -0,0 +1 @@
+export const divisions = ['anchors', 'dropdowns', 'languages', 'tabs', 'versions'];

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

@@ -0,0 +1,4 @@
+export * from './divisions.js';
+export * from './icon.js';
+export * from './page.js';
+export * from './openapi.js';

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

@@ -0,0 +1,4 @@
+export * from './divisions.js';
+export * from './icon.js';
+export * from './page.js';
+export * from './openapi.js';

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

@@ -1,2 +1,88 @@
 import { z } from 'zod';
 export declare const pageSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const decoratedPageSchema: z.ZodObject<{
+    href: z.ZodString;
+    title: z.ZodString;
+    sidebarTitle: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    api: z.ZodOptional<z.ZodString>;
+    openapi: z.ZodOptional<z.ZodString>;
+    contentType: z.ZodOptional<z.ZodString>;
+    authMethod: z.ZodOptional<z.ZodString>;
+    auth: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodString>;
+    mode: z.ZodOptional<z.ZodString>;
+    hideFooterPagination: z.ZodOptional<z.ZodBoolean>;
+    authors: z.ZodOptional<z.ZodUnknown>;
+    lastUpdatedDate: z.ZodOptional<z.ZodString>;
+    createdDate: z.ZodOptional<z.ZodString>;
+    'openapi-schema': z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
+        style: z.ZodOptional<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" | undefined;
+    }, {
+        name: string;
+        style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+    }>]>>;
+    tag: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    hideApiMarker: z.ZodOptional<z.ZodBoolean>;
+    noindex: z.ZodOptional<z.ZodBoolean>;
+    isPublic: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    href: string;
+    title: string;
+    sidebarTitle?: string | undefined;
+    description?: string | undefined;
+    api?: string | undefined;
+    openapi?: string | undefined;
+    contentType?: string | undefined;
+    authMethod?: string | undefined;
+    auth?: string | undefined;
+    version?: string | undefined;
+    mode?: string | undefined;
+    hideFooterPagination?: boolean | undefined;
+    authors?: unknown;
+    lastUpdatedDate?: string | undefined;
+    createdDate?: string | undefined;
+    'openapi-schema'?: string | undefined;
+    icon?: string | {
+        name: string;
+        style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+    } | undefined;
+    tag?: string | undefined;
+    url?: string | undefined;
+    hideApiMarker?: boolean | undefined;
+    noindex?: boolean | undefined;
+    isPublic?: boolean | undefined;
+}, {
+    href: string;
+    title: string;
+    sidebarTitle?: string | undefined;
+    description?: string | undefined;
+    api?: string | undefined;
+    openapi?: string | undefined;
+    contentType?: string | undefined;
+    authMethod?: string | undefined;
+    auth?: string | undefined;
+    version?: string | undefined;
+    mode?: string | undefined;
+    hideFooterPagination?: boolean | undefined;
+    authors?: unknown;
+    lastUpdatedDate?: string | undefined;
+    createdDate?: string | undefined;
+    'openapi-schema'?: string | undefined;
+    icon?: string | {
+        name: string;
+        style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+    } | undefined;
+    tag?: string | undefined;
+    url?: string | undefined;
+    hideApiMarker?: boolean | undefined;
+    noindex?: boolean | undefined;
+    isPublic?: boolean | undefined;
+}>;
+export type DecoratedPageConfig = z.infer<typeof decoratedPageSchema>;

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

@@ -1,7 +1,34 @@
 import { z } from 'zod';
 import { normalizeRelativePath } from '../../../../transforms/normalizeRelativePath.js';
+import { iconSchema } from './icon.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');
+export const decoratedPageSchema = z
+    .object({
+    href: z.string(),
+    title: z.string(),
+    sidebarTitle: z.string().optional(),
+    description: z.string().optional(),
+    api: z.string().optional(),
+    openapi: z.string().optional(),
+    contentType: z.string().optional(),
+    authMethod: z.string().optional(),
+    auth: z.string().optional(),
+    version: z.string().optional(),
+    mode: z.string().optional(),
+    hideFooterPagination: z.boolean().optional(),
+    authors: z.unknown().optional(),
+    lastUpdatedDate: z.string().optional(),
+    createdDate: z.string().optional(),
+    'openapi-schema': z.string().optional(),
+    icon: iconSchema.optional(),
+    tag: z.string().optional(),
+    url: z.string().optional(),
+    hideApiMarker: z.boolean().optional(),
+    noindex: z.boolean().optional(),
+    isPublic: z.boolean().optional(),
+})
+    .describe('page metadata tags in the navigation');

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

@@ -2,10 +2,10 @@ 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.ZodOptional<z.ZodEnum<["navigable", "all"]>>>;
+    indexing: z.ZodOptional<z.ZodEnum<["navigable", "all"]>>;
 }, "strip", z.ZodTypeAny, {
-    indexing: "all" | "navigable";
     metatags?: Record<string, string> | undefined;
+    indexing?: "all" | "navigable" | undefined;
 }, {
     metatags?: Record<string, string> | undefined;
     indexing?: "all" | "navigable" | undefined;

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

@@ -9,7 +9,6 @@ export const seoSchema = z
     indexing: z
         .enum(['navigable', 'all'])
         .optional()
-        .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('Specify which pages to be indexed by search engines. Setting `navigable` indexes pages that are set in navigation, `all` indexes all pages. Defaults to `navigable`.'),
 })
     .describe('SEO indexing configurations');

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

@@ -1,12 +1,12 @@
 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<["system", "dark"]>>>;
+    rounded: z.ZodOptional<z.ZodEnum<["regular", "sharp"]>>;
+    eyebrows: z.ZodOptional<z.ZodEnum<["section", "breadcrumbs"]>>;
+    codeblocks: z.ZodOptional<z.ZodEnum<["system", "dark"]>>;
 }, "strip", z.ZodTypeAny, {
-    rounded: "regular" | "sharp";
-    eyebrows: "section" | "breadcrumbs";
-    codeblocks: "dark" | "system";
+    rounded?: "regular" | "sharp" | undefined;
+    eyebrows?: "section" | "breadcrumbs" | undefined;
+    codeblocks?: "dark" | "system" | undefined;
 }, {
     rounded?: "regular" | "sharp" | undefined;
     eyebrows?: "section" | "breadcrumbs" | undefined;

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

@@ -4,17 +4,14 @@ export const stylingSchema = z
     rounded: z
         .enum(['regular', 'sharp'])
         .optional()
-        .default('regular')
-        .describe('Whether corners are rounded or sharp'),
+        .describe('Whether corners are rounded or sharp. Defaults to `regular`.'),
     eyebrows: z
         .enum(['section', 'breadcrumbs'])
         .optional()
-        .default('section')
-        .describe('The eyebrows style of the content'),
+        .describe('The eyebrows style of the content. Defaults to `section`.'),
     codeblocks: z
         .enum(['system', 'dark'])
         .optional()
-        .default('system')
-        .describe('The codeblock theme'),
+        .describe('The codeblock theme. Defaults to `system`.'),
 })
     .describe('Styling configurations');