@mintlify/validation 0.1.798 → 0.1.799

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

@@ -18,6 +18,7 @@ export declare const pagesSchema: z.ZodArray<z.ZodType<string | ({
     boost?: number | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
     root?: string | undefined;
 } & {
     openapi?: string | string[] | {
@@ -45,6 +46,7 @@ export declare const pagesSchema: z.ZodArray<z.ZodType<string | ({
     boost?: number | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
     root?: string | undefined;
 } & {
     openapi?: string | string[] | {
@@ -265,6 +267,7 @@ export declare const decoratedPagesSchema: z.ZodArray<z.ZodType<z.objectInputTyp
     boost?: number | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
     root?: string | undefined;
 }, "root"> & {
     pages: PageOrGroupNavigation<"decorated">[];
@@ -476,6 +479,7 @@ export declare const decoratedPagesSchema: z.ZodArray<z.ZodType<z.objectInputTyp
     boost?: number | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
     root?: string | undefined;
 }, "root"> & {
     pages: PageOrGroupNavigation<"decorated">[];

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

@@ -4,6 +4,7 @@ export declare const baseProductSchema: z.ZodObject<{
     directory: z.ZodOptional<z.ZodEnum<["none", "accordion", "card"]>>;
     product: z.ZodString;
     graphql: z.ZodOptional<z.ZodNever>;
+    sdk: z.ZodOptional<z.ZodNever>;
     name: 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"]>>;
@@ -46,6 +47,7 @@ export declare const baseProductSchema: z.ZodObject<{
     description?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }, {
     product: string;
     name?: string | undefined;
@@ -62,6 +64,7 @@ export declare const baseProductSchema: z.ZodObject<{
     description?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }>;
 export declare const productSchema: z.ZodType<ProductNavigation<'default'>>;
 export declare const decoratedProductSchema: z.ZodType<ProductNavigation<'decorated'>>;
@@ -72,6 +75,7 @@ export declare const nonRecursiveProductSchema: z.ZodObject<{
     directory: z.ZodOptional<z.ZodEnum<["none", "accordion", "card"]>>;
     product: z.ZodString;
     graphql: z.ZodOptional<z.ZodNever>;
+    sdk: z.ZodOptional<z.ZodNever>;
     name: 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"]>>;
@@ -117,6 +121,7 @@ export declare const nonRecursiveProductSchema: z.ZodObject<{
     description?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }, {
     href: string;
     product: string;
@@ -134,6 +139,7 @@ export declare const nonRecursiveProductSchema: z.ZodObject<{
     description?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }>;
 export type ProductConfig = z.infer<typeof productSchema>;
 export type ProductsConfig = z.infer<typeof productsSchema>;

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

@@ -6,6 +6,7 @@ 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 { sdkNotSupportedSchema } from '../reusable/sdk.js';
 import { anchorsSchema, decoratedAnchorsSchema } from './anchors.js';
 import { decoratedDropdownsSchema, dropdownsSchema } from './dropdown.js';
 import { globalSchema } from './global.js';
@@ -15,7 +16,7 @@ import { decoratedMenuSchema, menuSchema } from './menu.js';
 import { pagesSchema, decoratedPagesSchema } from './pages.js';
 import { tabsSchema, decoratedTabsSchema } from './tabs.js';
 import { versionsSchema, decoratedVersionsSchema } from './version.js';
-export const baseProductSchema = z.object(Object.assign({ product: z.string().nonempty().describe('The name of the product'), graphql: graphqlNotSupportedSchema, name: z.string().optional().describe('Display name for the product'), icon: iconSchema.optional(), color: colorSchemaWithOptionalLightAndDark.optional(), description: z.string().optional().describe('The description of the product'), hidden: hiddenSchema.optional() }, directoryField));
+export const baseProductSchema = z.object(Object.assign({ product: z.string().nonempty().describe('The name of the product'), graphql: graphqlNotSupportedSchema, sdk: sdkNotSupportedSchema, name: z.string().optional().describe('Display name for the product'), icon: iconSchema.optional(), color: colorSchemaWithOptionalLightAndDark.optional(), description: z.string().optional().describe('The description of the product'), hidden: hiddenSchema.optional() }, directoryField));
 export const productSchema = z.union([
     baseProductSchema.extend({
         href: hrefSchema,

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

@@ -67,6 +67,7 @@ export declare const nonRecursiveTabSchema: z.ZodObject<{
 } & {
     href: z.ZodEffects<z.ZodString, string, string>;
     graphql: z.ZodOptional<z.ZodNever>;
+    sdk: z.ZodOptional<z.ZodNever>;
 }, "strip", z.ZodTypeAny, {
     href: string;
     tab: string;
@@ -79,6 +80,7 @@ export declare const nonRecursiveTabSchema: z.ZodObject<{
     searchable?: boolean | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
     align?: "start" | "end" | undefined;
 }, {
     href: string;
@@ -92,6 +94,7 @@ export declare const nonRecursiveTabSchema: z.ZodObject<{
     searchable?: boolean | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
     align?: "start" | "end" | undefined;
 }>;
 export declare const tabSchema: z.ZodType<TabNavigation<'default'>>;

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

@@ -5,6 +5,7 @@ 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 { sdkNotSupportedSchema, sdkSchema } from '../reusable/sdk.js';
 import { searchableSchema } from '../reusable/searchable.js';
 import { anchorsSchema, decoratedAnchorsSchema } from './anchors.js';
 import { decoratedDropdownsSchema, dropdownsSchema } from './dropdown.js';
@@ -20,6 +21,7 @@ export const baseTabSchema = z.object(Object.assign({ tab: z.string().nonempty()
 export const nonRecursiveTabSchema = baseTabSchema.extend({
     href: hrefSchema,
     graphql: graphqlNotSupportedSchema,
+    sdk: sdkNotSupportedSchema,
 });
 export const tabSchema = z.union([
     baseTabSchema.extend({ graphql: graphqlSchema }).strict(),
@@ -29,9 +31,17 @@ export const tabSchema = z.union([
         graphql: graphqlSchema,
     })
         .strict(),
+    baseTabSchema.extend({ sdk: sdkSchema }).strict(),
+    baseTabSchema
+        .extend({
+        groups: z.lazy(() => groupsSchema),
+        sdk: sdkSchema,
+    })
+        .strict(),
     baseTabSchema.extend({
         href: hrefSchema,
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -39,6 +49,7 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         languages: z.lazy(() => languagesSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -46,6 +57,7 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         versions: z.lazy(() => versionsSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -53,6 +65,7 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         dropdowns: z.lazy(() => dropdownsSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -60,6 +73,7 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         anchors: z.lazy(() => anchorsSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -67,6 +81,7 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         products: z.lazy(() => productsSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -74,6 +89,7 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         groups: z.lazy(() => groupsSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -81,6 +97,7 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         pages: z.lazy(() => pagesSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
@@ -88,19 +105,21 @@ export const tabSchema = z.union([
     baseTabSchema.extend({
         menu: z.lazy(() => menuSchema),
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
     }),
     baseTabSchema.extend({
         graphql: graphqlNotSupportedSchema,
+        sdk: sdkNotSupportedSchema,
         openapi: openApiSchema.optional(),
         asyncapi: asyncApiSchema.optional(),
         global: z.lazy(() => globalSchema).optional(),
     }),
 ]);
 export const decoratedTabSchema = baseTabSchema
-    .and(z.object({ graphql: graphqlNotSupportedSchema }))
+    .and(z.object({ graphql: graphqlNotSupportedSchema, sdk: sdkNotSupportedSchema }))
     .and(z.union([
     z.object({ href: hrefSchema }),
     z.lazy(() => z.object({ languages: decoratedLanguagesSchema, global: globalSchema.optional() })),

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

@@ -4,6 +4,7 @@ export declare const baseVersionSchema: z.ZodObject<{
     directory: z.ZodOptional<z.ZodEnum<["none", "accordion", "card"]>>;
     version: z.ZodString;
     graphql: z.ZodOptional<z.ZodNever>;
+    sdk: z.ZodOptional<z.ZodNever>;
     default: z.ZodOptional<z.ZodBoolean>;
     tag: z.ZodOptional<z.ZodString>;
     hidden: z.ZodOptional<z.ZodBoolean>;
@@ -14,6 +15,7 @@ export declare const baseVersionSchema: z.ZodObject<{
     tag?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }, {
     version: string;
     default?: boolean | undefined;
@@ -21,12 +23,14 @@ export declare const baseVersionSchema: z.ZodObject<{
     tag?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }>;
 export type BaseVersionSchema = z.infer<typeof baseVersionSchema>;
 export declare const nonRecursiveVersionSchema: z.ZodObject<{
     directory: z.ZodOptional<z.ZodEnum<["none", "accordion", "card"]>>;
     version: z.ZodString;
     graphql: z.ZodOptional<z.ZodNever>;
+    sdk: z.ZodOptional<z.ZodNever>;
     default: z.ZodOptional<z.ZodBoolean>;
     tag: z.ZodOptional<z.ZodString>;
     hidden: z.ZodOptional<z.ZodBoolean>;
@@ -40,6 +44,7 @@ export declare const nonRecursiveVersionSchema: z.ZodObject<{
     tag?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }, {
     version: string;
     href: string;
@@ -48,6 +53,7 @@ export declare const nonRecursiveVersionSchema: z.ZodObject<{
     tag?: string | undefined;
     hidden?: boolean | undefined;
     graphql?: undefined;
+    sdk?: undefined;
 }>;
 export declare const versionSchema: z.ZodType<VersionNavigation<'default'>>;
 export declare const decoratedVersionSchema: z.ZodType<VersionNavigation<'decorated'>>;

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

@@ -4,6 +4,7 @@ import { graphqlNotSupportedSchema } from '../reusable/graphql.js';
 import { hiddenSchema } from '../reusable/hidden.js';
 import { hrefSchema } from '../reusable/href.js';
 import { openApiSchema } from '../reusable/openapi.js';
+import { sdkNotSupportedSchema } from '../reusable/sdk.js';
 import { anchorsSchema, decoratedAnchorsSchema } from './anchors.js';
 import { decoratedDropdownsSchema, dropdownsSchema } from './dropdown.js';
 import { globalSchema } from './global.js';
@@ -12,7 +13,7 @@ import { decoratedLanguagesSchema, languagesSchema } from './languages.js';
 import { decoratedPagesSchema, pagesSchema } from './pages.js';
 import { decoratedProductsSchema, productsSchema } from './products.js';
 import { decoratedTabsSchema, tabsSchema } from './tabs.js';
-export const baseVersionSchema = z.object(Object.assign({ version: z.string().nonempty().describe('The name of the version'), graphql: graphqlNotSupportedSchema, default: z.boolean().optional().describe('Whether this version is the default version'), tag: z.string().optional().describe('Tag for the version'), hidden: hiddenSchema.optional() }, directoryField));
+export const baseVersionSchema = z.object(Object.assign({ version: z.string().nonempty().describe('The name of the version'), graphql: graphqlNotSupportedSchema, sdk: sdkNotSupportedSchema, default: z.boolean().optional().describe('Whether this version is the default version'), tag: z.string().optional().describe('Tag for the version'), hidden: hiddenSchema.optional() }, directoryField));
 export const nonRecursiveVersionSchema = baseVersionSchema.extend({ href: hrefSchema });
 export const versionSchema = z.union([
     baseVersionSchema.extend({

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

@@ -3,5 +3,6 @@ export * from './icon.js';
 export * from './page.js';
 export * from './openapi.js';
 export * from './graphql.js';
+export * from './sdk.js';
 export * from './color.js';
 export * from './asyncapi.js';

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

@@ -3,5 +3,6 @@ export * from './icon.js';
 export * from './page.js';
 export * from './openapi.js';
 export * from './graphql.js';
+export * from './sdk.js';
 export * from './color.js';
 export * from './asyncapi.js';

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

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+export declare const SDK_FORMATS: readonly ["typedoc", "docfx", "javadoc", "sphinx", "phpdoc"];
+export declare const sdkFormatSchema: z.ZodEnum<["typedoc", "docfx", "javadoc", "sphinx", "phpdoc"]>;
+export declare const sdkSchema: z.ZodObject<{
+    format: z.ZodEnum<["typedoc", "docfx", "javadoc", "sphinx", "phpdoc"]>;
+    source: z.ZodEffects<z.ZodString, string, string>;
+    directory: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+}, "strict", z.ZodTypeAny, {
+    source: string;
+    format: "typedoc" | "docfx" | "javadoc" | "sphinx" | "phpdoc";
+    directory?: string | undefined;
+}, {
+    source: string;
+    format: "typedoc" | "docfx" | "javadoc" | "sphinx" | "phpdoc";
+    directory?: string | undefined;
+}>;
+export type SdkConfig = z.infer<typeof sdkSchema>;
+export type SdkFormat = z.infer<typeof sdkFormatSchema>;
+export declare const sdkNotSupportedSchema: z.ZodOptional<z.ZodNever>;

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

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+import { isAbsoluteUrl } from '../../../../isAbsoluteUrl.js';
+import { normalizeRelativePath } from '../../../../transforms/normalizeRelativePath.js';
+export const SDK_FORMATS = ['typedoc', 'docfx', 'javadoc', 'sphinx', 'phpdoc'];
+export const sdkFormatSchema = z
+    .enum(SDK_FORMATS)
+    .describe('The documentation generator that produced the artifact');
+const sdkSourceSchema = z
+    .string()
+    .trim()
+    .nonempty()
+    .transform((value, ctx) => {
+    if (!isAbsoluteUrl(value))
+        return normalizeRelativePath(value);
+    try {
+        if (new URL(value).protocol !== 'https:') {
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                message: 'Must be a local path or a valid HTTPS URL.',
+            });
+            return z.NEVER;
+        }
+    }
+    catch (_a) {
+        ctx.addIssue({ code: z.ZodIssueCode.custom, message: 'Invalid URL' });
+        return z.NEVER;
+    }
+    return value;
+})
+    .describe('Relative path or HTTPS URL of the generator artifact; directory-shaped formats accept a zip (or javadoc jar) when remote');
+export const sdkSchema = z
+    .object({
+    format: sdkFormatSchema,
+    source: sdkSourceSchema,
+    directory: z.string().trim().nonempty().transform(normalizeRelativePath).optional(),
+})
+    .strict()
+    .describe('Generate SDK reference pages from a documentation generator artifact');
+export const sdkNotSupportedSchema = z.never().optional();