@mintlify/validation 0.1.44 → 0.1.45

package/dist/mint-config/schemas/favicon.d.ts

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

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

@@ -0,0 +1,38 @@
+import { z } from 'zod';
+declare const intercomSchema: z.ZodString;
+declare const frontchatSchema: z.ZodString;
+declare const inkeepSchema: z.ZodObject<{
+    integrationApiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    integrationApiKey: string;
+}, {
+    integrationApiKey: string;
+}>;
+export declare const integrationsSchema: z.ZodObject<{
+    intercom: z.ZodOptional<z.ZodString>;
+    frontchat: z.ZodOptional<z.ZodString>;
+    inkeepSchema: z.ZodOptional<z.ZodObject<{
+        integrationApiKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        integrationApiKey: string;
+    }, {
+        integrationApiKey: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    intercom?: string | undefined;
+    frontchat?: string | undefined;
+    inkeepSchema?: {
+        integrationApiKey: string;
+    } | undefined;
+}, {
+    intercom?: string | undefined;
+    frontchat?: string | undefined;
+    inkeepSchema?: {
+        integrationApiKey: string;
+    } | undefined;
+}>;
+export type IntercomType = z.infer<typeof intercomSchema>;
+export type FrontchatType = z.infer<typeof frontchatSchema>;
+export type InkeepType = z.infer<typeof inkeepSchema>;
+export type IntegrationsType = z.infer<typeof integrationsSchema>;
+export {};

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

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

package/dist/mint-config/schemas/navigation.d.ts

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

package/dist/mint-config/schemas/tabs.d.ts

@@ -1,11 +1,31 @@
-import { z } from 'zod';
-export declare const tabsSchema: z.ZodArray<z.ZodObject<{
-    name: z.ZodString;
-    url: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    url: string;
-}, {
-    name: string;
-    url: string;
-}>, "many">;
+import { z } from 'zod';
+declare const tabSchema: z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    url: string;
+}, {
+    name: string;
+    url: string;
+}>;
+export type TabType = z.infer<typeof tabSchema>;
+export declare const tabsSchema: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    url: string;
+}, {
+    name: string;
+    url: string;
+}>, "many">;
+export declare const primaryTabSchema: z.ZodObject<{
+    name: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>;
+export type PrimaryTabType = z.infer<typeof primaryTabSchema>;
+export {};

package/dist/mint-config/schemas/versions.d.ts

@@ -1,11 +1,24 @@
-import { z } from 'zod';
-export declare const versionsSchema: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodObject<{
-    name: z.ZodString;
-    url: z.ZodString;
-}, "strict", z.ZodTypeAny, {
-    name: string;
-    url: string;
-}, {
-    name: string;
-    url: string;
-}>]>, "many">;
+import { z } from 'zod';
+declare const versionSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    name: string;
+    url: string;
+}, {
+    name: string;
+    url: string;
+}>]>;
+export declare const versionsSchema: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    name: string;
+    url: string;
+}, {
+    name: string;
+    url: string;
+}>]>, "many">;
+export type VersionType = z.infer<typeof versionSchema>;
+export type VersionsType = z.infer<typeof versionsSchema>;
+export {};

package/dist/mint-config/types/analytics.d.ts

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

package/dist/mint-config/types/anchors.d.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
-import { anchorsSchema } from '../schemas/anchors';
-export type AnchorsType = z.infer<typeof anchorsSchema>;
-export type AnchorType = AnchorsType[0];
+import { z } from 'zod';
+import { anchorsSchema } from '../schemas/anchors';
+export type AnchorsType = z.infer<typeof anchorsSchema>;
+export type AnchorType = AnchorsType[0];

package/dist/mint-config/types/colors.d.ts

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

package/dist/mint-config/types/config.d.ts

@@ -1,4 +1,55 @@
-import { z } from 'zod';
-import { configSchema, apiSchema } from '../schemas/config';
-export type ConfigType = z.infer<typeof configSchema>;
-export type ApiConfigType = z.infer<typeof apiSchema>;
+import { z } from 'zod';
+import { AnalyticsType } from '../schemas/analytics';
+import { AnchorsType } from '../schemas/anchors';
+import { ApiConfigType } from '../schemas/apiReference';
+import { FeedbackType, LogoType, FooterSocialsType, NavbarLink, IconType } from '../schemas/basics';
+import { ColorsType } from '../schemas/colors';
+import { configSchema } from '../schemas/config';
+import { IntegrationsType } from '../schemas/integrations';
+import { TabType } from '../schemas/tabs';
+import { VersionsType } from '../schemas/versions';
+import { ModeToggleType } from './enums';
+import { MintNavigation } from './navigation';
+export type ConfigType = z.infer<typeof configSchema>;
+export type MintConfig = {
+    name: string;
+    backgroundImage?: string;
+    colors?: ColorsType;
+    favicon?: string;
+    feedback?: FeedbackType;
+    footerSocials?: FooterSocialsType;
+    logo?: LogoType;
+    metadata?: Record<string, string>;
+    modeToggle?: {
+        default?: ModeToggleType;
+        isHidden?: boolean;
+    };
+    openapi?: string | string[];
+    api?: ApiConfigType;
+    navigation?: MintNavigation;
+    anchors?: AnchorsType;
+    versions?: VersionsType;
+    topbarCtaButton?: NavbarLink;
+    topAnchor?: {
+        name: string;
+        icon?: string;
+        iconType?: IconType;
+    };
+    topbarLinks?: NavbarLink[];
+    primaryTab?: {
+        name: string;
+    };
+    tabs?: TabType[];
+    repo?: {
+        github?: {
+            owner: string;
+            repo: string;
+            deployBranch: string;
+            contentDirectory: string;
+            isPrivate?: boolean;
+        };
+    };
+    analytics?: AnalyticsType;
+    integrations?: IntegrationsType;
+    isWhiteLabeled?: boolean;
+};

package/dist/mint-config/types/enums.d.ts

@@ -0,0 +1,4 @@
+export type ModeToggleType = 'dark' | 'light' | (string & {});
+export type NavbarLinkType = 'github' | 'link' | (string & {});
+export type ApiAuthMethodType = 'key' | 'bearer' | 'basic' | (string & {});
+export type ApiPlaygroundModeType = 'show' | 'simple' | 'hide' | (string & {});

package/dist/mint-config/types/index.d.ts

@@ -0,0 +1,12 @@
+export type { ConfigType, MintConfig } from './config';
+export type { AnalyticsType, AmplitudeConfigInterface, ClearbitConfigInterface, FathomConfigInterface, GoogleAnalyticsConfigInterface, GoogleTagManagerConfigInterface, HotjarConfigInterface, KoalaConfigInterface, LogrocketConfigInterface, MixpanelConfigInterface, PirschConfigInterface, PostHogConfigInterface, PlausibleConfigInterface, } from '../schemas/analytics';
+export type { AnchorsType, AnchorType, TopAnchorType } from '../schemas/anchors';
+export type { ApiConfigType } from '../schemas/apiReference';
+export type { FeedbackType, FooterSocialsType, IconType, LogoType, NavbarLink, } from '../schemas/basics';
+export type { ColorsType } from '../schemas/colors';
+export type { GradientType } from '../schemas/anchorColors';
+export type { IntegrationsType, IntercomType, FrontchatType, InkeepType, } from '../schemas/integrations';
+export type { TabType, PrimaryTabType } from '../schemas/tabs';
+export type { VersionsType, VersionType } from '../schemas/versions';
+export type { ModeToggleType, NavbarLinkType, ApiAuthMethodType, ApiPlaygroundModeType, } from './enums';
+export type { MintNavigation, MintNavigationGroup, MintNavigationGroupChild, NavigationEntry, NavigationType, } from './navigation';

package/dist/mint-config/types/navigation.d.ts

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

package/dist/mint-config/types/versions.d.ts

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

package/dist/mint-config/validateAnchorsWarnings.d.ts

@@ -1,4 +1,4 @@
-import { MintValidationResults } from './common';
-import { AnchorsType } from './types/anchors';
-import { NavigationType } from './types/navigation';
-export declare function validateAnchorsWarnings(anchors: AnchorsType | undefined, navigation: NavigationType[] | undefined): MintValidationResults;
+import { MintValidationResults } from './common';
+import { AnchorsType } from './schemas/anchors';
+import { MintNavigation } from './types/navigation';
+export declare function validateAnchorsWarnings(anchors: AnchorsType | undefined, navigation: MintNavigation | undefined): MintValidationResults;

package/dist/mint-config/validateVersionsInNavigation.d.ts

@@ -1,5 +1,5 @@
-import { MintValidationResults } from './common';
-import { NavigationEntry, NavigationType } from './types/navigation';
-import { VersionsType } from './types/versions';
-export declare function flattenNavigationVersions(nav: NavigationEntry[], versions?: string[]): string[];
-export declare function validateVersionsInNavigation(navigation: NavigationType[] | undefined, versions?: VersionsType | undefined): MintValidationResults;
+import { MintValidationResults } from './common';
+import { VersionsType } from './schemas/versions';
+import { MintNavigationGroupChild, MintNavigationGroup } from './types/navigation';
+export declare function flattenNavigationVersions(nav: MintNavigationGroupChild[], versions?: string[]): string[];
+export declare function validateVersionsInNavigation(navigation: MintNavigationGroup[] | undefined, versions?: VersionsType | undefined): MintValidationResults;

package/dist/openapi/convertOpenApi.d.ts

@@ -1,18 +1,18 @@
-import { OpenAPIV3_1 } from 'openapi-types';
-import type { BodySchema, DataSchemaArray, Endpoint, HttpMethod, ResponseSchema } from './types/endpoint';
-export declare const generateMessage: (path: string[], messages?: string[]) => string;
-export declare class InvalidSchemaError extends Error {
-    constructor(path: string[], ...messages: string[]);
-}
-export declare class ImpossibleSchemaError extends Error {
-    constructor(path: string[], ...messages: string[]);
-}
-export declare class ConversionError extends Error {
-    constructor(path: string[], ...messages: string[]);
-}
-export declare const convertBody: (path: string[], body: OpenAPIV3_1.RequestBodyObject | undefined) => BodySchema;
-export declare const convertResponses: (path: string[], responses: OpenAPIV3_1.ResponsesObject) => ResponseSchema;
-export declare const convertResponse: (path: string[], response: OpenAPIV3_1.ResponseObject) => {
-    [contentType: string]: DataSchemaArray;
-};
-export declare const convertOpenAPIV3_1ToEndpoint: (spec: OpenAPIV3_1.Document, path: string, method: HttpMethod) => Endpoint | undefined;
+import { OpenAPIV3_1 } from 'openapi-types';
+import type { BodySchema, DataSchemaArray, Endpoint, HttpMethod, ResponseSchema } from './types/endpoint';
+export declare const generateMessage: (path: string[], messages?: string[]) => string;
+export declare class InvalidSchemaError extends Error {
+    constructor(path: string[], ...messages: string[]);
+}
+export declare class ImpossibleSchemaError extends Error {
+    constructor(path: string[], ...messages: string[]);
+}
+export declare class ConversionError extends Error {
+    constructor(path: string[], ...messages: string[]);
+}
+export declare const convertBody: (path: string[], body: OpenAPIV3_1.RequestBodyObject | undefined) => BodySchema;
+export declare const convertResponses: (path: string[], responses: OpenAPIV3_1.ResponsesObject) => ResponseSchema;
+export declare const convertResponse: (path: string[], response: OpenAPIV3_1.ResponseObject) => {
+    [contentType: string]: DataSchemaArray;
+};
+export declare const convertOpenAPIV3_1ToEndpoint: (spec: OpenAPIV3_1.Document, path: string, method: HttpMethod) => Endpoint | undefined;

package/dist/openapi/convertParameters.d.ts

@@ -1,9 +1,9 @@
-import { OpenAPIV3_1 } from 'openapi-types';
-import { ParameterSections } from './types/endpoint';
-export type ConvertParametersParams = {
-    path: string[];
-    method: string;
-    pathParameters: OpenAPIV3_1.ParameterObject[] | undefined;
-    operationParameters: OpenAPIV3_1.ParameterObject[] | undefined;
-};
-export declare const convertParameters: ({ path, method, pathParameters, operationParameters, }: ConvertParametersParams) => ParameterSections;
+import { OpenAPIV3_1 } from 'openapi-types';
+import { ParameterSections } from './types/endpoint';
+export type ConvertParametersParams = {
+    path: string[];
+    method: string;
+    pathParameters: OpenAPIV3_1.ParameterObject[] | undefined;
+    operationParameters: OpenAPIV3_1.ParameterObject[] | undefined;
+};
+export declare const convertParameters: ({ path, method, pathParameters, operationParameters, }: ConvertParametersParams) => ParameterSections;

package/dist/openapi/convertSchema.d.ts

@@ -1,11 +1,11 @@
-import { OpenAPIV3_1 } from 'openapi-types';
-import { DataSchemaArray } from './types/endpoint';
-export declare const convertSchema: (path: string[], schema: OpenAPIV3_1.SchemaObject | undefined, required?: boolean) => DataSchemaArray;
-export declare const combineTopLevelSchemas: (path: string[], schema1: OpenAPIV3_1.SchemaObject, schema2: OpenAPIV3_1.SchemaObject) => OpenAPIV3_1.SchemaObject;
-export declare const addKeyIfDefined: <D, K extends keyof D>(key: K, value: D[K], destination: D) => void;
-export declare const copyKeyIfDefined: <D, K extends keyof D>(key: K, source: Pick<D, K>, destination: D) => void;
-export declare const convertProperties: (path: string[], properties: {
-    [key: string]: OpenAPIV3_1.SchemaObject;
-} | undefined, required?: string[]) => {
-    [key: string]: DataSchemaArray;
-};
+import { OpenAPIV3_1 } from 'openapi-types';
+import { DataSchemaArray } from './types/endpoint';
+export declare const convertSchema: (path: string[], schema: OpenAPIV3_1.SchemaObject | undefined, required?: boolean) => DataSchemaArray;
+export declare const combineTopLevelSchemas: (path: string[], schema1: OpenAPIV3_1.SchemaObject, schema2: OpenAPIV3_1.SchemaObject) => OpenAPIV3_1.SchemaObject;
+export declare const addKeyIfDefined: <D, K extends keyof D>(key: K, value: D[K], destination: D) => void;
+export declare const copyKeyIfDefined: <D, K extends keyof D>(key: K, source: Pick<D, K>, destination: D) => void;
+export declare const convertProperties: (path: string[], properties: {
+    [key: string]: OpenAPIV3_1.SchemaObject;
+} | undefined, required?: string[]) => {
+    [key: string]: DataSchemaArray;
+};

package/dist/openapi/convertSecurity.d.ts

@@ -1,14 +1,14 @@
-import { OpenAPIV3_1 } from 'openapi-types';
-import { SecurityOption } from './types/endpoint';
-type ConvertSecurityParams = {
-    securityRequirements?: OpenAPIV3_1.SecurityRequirementObject[];
-    securitySchemes: OpenAPIV3_1.ComponentsObject['securitySchemes'];
-};
-export declare const convertSecurity: ({ securityRequirements, securitySchemes, }: ConvertSecurityParams) => SecurityOption[];
-type AddSecurityParametersParams = {
-    securityName: string;
-    securityScheme: OpenAPIV3_1.SecuritySchemeObject;
-    parameterSections: SecurityOption;
-};
-export declare const addSecurityParameters: ({ securityName, securityScheme, parameterSections, }: AddSecurityParametersParams) => void;
-export {};
+import { OpenAPIV3_1 } from 'openapi-types';
+import { SecurityOption } from './types/endpoint';
+type ConvertSecurityParams = {
+    securityRequirements?: OpenAPIV3_1.SecurityRequirementObject[];
+    securitySchemes: OpenAPIV3_1.ComponentsObject['securitySchemes'];
+};
+export declare const convertSecurity: ({ securityRequirements, securitySchemes, }: ConvertSecurityParams) => SecurityOption[];
+type AddSecurityParametersParams = {
+    securityName: string;
+    securityScheme: OpenAPIV3_1.SecuritySchemeObject;
+    parameterSections: SecurityOption;
+};
+export declare const addSecurityParameters: ({ securityName, securityScheme, parameterSections, }: AddSecurityParametersParams) => void;
+export {};

package/dist/openapi/convertServers.d.ts

@@ -1,8 +1,8 @@
-import { OpenAPIV3_1 } from 'openapi-types';
-import { Server } from './types/endpoint';
-type ConvertServersParams = {
-    servers?: OpenAPIV3_1.ServerObject[];
-};
-type ConvertServersType = Server[] | undefined;
-export declare const convertServers: ({ servers }: ConvertServersParams) => ConvertServersType;
-export {};
+import { OpenAPIV3_1 } from 'openapi-types';
+import { Server } from './types/endpoint';
+type ConvertServersParams = {
+    servers?: OpenAPIV3_1.ServerObject[];
+};
+type ConvertServersType = Server[] | undefined;
+export declare const convertServers: ({ servers }: ConvertServersParams) => ConvertServersType;
+export {};