@mintlify/validation 0.1.39 → 0.1.41

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/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 { NavigationType } from '../types/navigation';
+export declare const navigationConfigSchema: z.ZodArray<z.ZodType<NavigationType, z.ZodTypeDef, NavigationType>, "many">;

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

@@ -1,11 +1,11 @@
-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';
+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">;

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

@@ -1,11 +1,11 @@
-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';
+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">;

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,3 +1,4 @@
-import { z } from 'zod';
-import { anchorsSchema } from '../schemas/anchors';
-export type AnchorsType = z.infer<typeof anchorsSchema>;
+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,3 +1,3 @@
-import { z } from 'zod';
-import { configSchema } from '../schemas/config';
-export type ConfigType = z.infer<typeof configSchema>;
+import { z } from 'zod';
+import { configSchema } from '../schemas/config';
+export type ConfigType = z.infer<typeof configSchema>;

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

@@ -1,6 +1,6 @@
-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;
+};

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 './types/anchors';
+import { NavigationType } from './types/navigation';
+export declare function validateAnchorsWarnings(anchors: AnchorsType | undefined, navigation: NavigationType[] | 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 { 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;

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 {};

package/dist/openapi/types/endpoint.d.ts

@@ -1,128 +1,128 @@
-export type Endpoint = {
-    description?: string;
-    path: string;
-    method: HttpMethod;
-    servers?: Server[];
-    request: RequestSchema;
-    response: ResponseSchema;
-    deprecated: boolean;
-};
-export type Server = {
-    url: string;
-    description?: string;
-    variables?: {
-        [variableName: string]: ServerVariableSchema;
-    };
-};
-export type ServerVariableSchema = ServerVariableStringSchema | ServerVariableStringEnumSchema;
-export type ServerVariableStringSchema = {
-    type: 'string';
-    default: string;
-    description?: string;
-};
-export type ServerVariableStringEnumSchema = {
-    type: 'stringEnum';
-    enum: string[];
-    default: string;
-    description?: string;
-};
-export type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
-export type RequestSchema = {
-    security: SecurityOption[];
-    parameters: ParameterSections;
-    body: BodySchema;
-};
-export type SecurityOption = NonPathParameterSections & {
-    title: string;
-};
-export type BodySchema = {
-    [contentType: string]: DataSchemaArray;
-};
-export type ParameterSchema = {
-    required?: boolean;
-    description?: string;
-    deprecated?: boolean;
-    schema: DataSchemaArray | 'basic' | 'bearer';
-};
-export type PathParameterSchema = ParameterSchema & {
-    required: true;
-};
-export type ParameterGroup = {
-    [name: string]: ParameterSchema;
-};
-export type PathParameterGroup = {
-    [name: string]: PathParameterSchema;
-};
-type NonPathParameterLocations = 'query' | 'header' | 'cookie';
-type PathParameterLocations = 'path';
-export type ParameterLocations = NonPathParameterLocations | PathParameterLocations;
-type NonPathParameterSections = Record<NonPathParameterLocations, ParameterGroup>;
-type PathParameterSections = Record<PathParameterLocations, PathParameterGroup>;
-export type ParameterSections = NonPathParameterSections & PathParameterSections;
-export type ResponseSchema = {
-    [code: string]: BodySchema;
-};
-export type DataSchemaArray = [DataSchema, ...DataSchema[]];
-export declare const typeList: readonly ["boolean", "string", "number", "integer", "object", "array", "stringEnum", "numberEnum", "integerEnum", "null", "any"];
-export type SchemaType = (typeof typeList)[number];
-export type DataSchema = BooleanSchema | StringSchema | NumberSchema | ObjectSchema | ArraySchema | StringEnumSchema | NumberEnumSchema | NullSchema | AnySchema;
-export type BaseSchema<T> = {
-    type: SchemaType;
-    title?: string;
-    description?: string;
-    default?: T;
-    example?: T;
-    required?: boolean;
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    deprecated?: boolean;
-};
-export type BooleanSchema = {
-    type: 'boolean';
-} & BaseSchema<boolean>;
-export type StringSchema = {
-    type: 'string';
-    format?: string;
-    pattern?: string;
-    maxLength?: number;
-    minLength?: number;
-} & BaseSchema<string>;
-export type NumberSchema = {
-    type: 'number' | 'integer';
-    multipleOf?: number;
-    maximum?: number;
-    exclusiveMaximum?: boolean;
-    minimum?: number;
-    exclusiveMinimum?: boolean;
-} & BaseSchema<number>;
-export type ObjectSchema = {
-    type: 'object';
-    additionalProperties?: boolean | DataSchemaArray;
-    maxProperties?: number;
-    minProperties?: number;
-    properties: {
-        [key: string]: DataSchemaArray;
-    };
-} & BaseSchema<object>;
-export type ArraySchema = {
-    type: 'array';
-    items: DataSchemaArray;
-    maxItems?: number;
-    minItems?: number;
-    uniqueItems?: boolean;
-} & BaseSchema<unknown[]>;
-export type StringEnumSchema = {
-    type: 'stringEnum';
-    enum: string[];
-} & BaseSchema<string>;
-export type NumberEnumSchema = {
-    type: 'numberEnum' | 'integerEnum';
-    enum: number[];
-} & BaseSchema<number>;
-export type NullSchema = {
-    type: 'null';
-} & BaseSchema<null>;
-export type AnySchema = {
-    type: 'any';
-} & BaseSchema<unknown>;
-export {};
+export type Endpoint = {
+    description?: string;
+    path: string;
+    method: HttpMethod;
+    servers?: Server[];
+    request: RequestSchema;
+    response: ResponseSchema;
+    deprecated: boolean;
+};
+export type Server = {
+    url: string;
+    description?: string;
+    variables?: {
+        [variableName: string]: ServerVariableSchema;
+    };
+};
+export type ServerVariableSchema = ServerVariableStringSchema | ServerVariableStringEnumSchema;
+export type ServerVariableStringSchema = {
+    type: 'string';
+    default: string;
+    description?: string;
+};
+export type ServerVariableStringEnumSchema = {
+    type: 'stringEnum';
+    enum: string[];
+    default: string;
+    description?: string;
+};
+export type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
+export type RequestSchema = {
+    security: SecurityOption[];
+    parameters: ParameterSections;
+    body: BodySchema;
+};
+export type SecurityOption = NonPathParameterSections & {
+    title: string;
+};
+export type BodySchema = {
+    [contentType: string]: DataSchemaArray;
+};
+export type ParameterSchema = {
+    required?: boolean;
+    description?: string;
+    deprecated?: boolean;
+    schema: DataSchemaArray | 'basic' | 'bearer';
+};
+export type PathParameterSchema = ParameterSchema & {
+    required: true;
+};
+export type ParameterGroup = {
+    [name: string]: ParameterSchema;
+};
+export type PathParameterGroup = {
+    [name: string]: PathParameterSchema;
+};
+type NonPathParameterLocations = 'query' | 'header' | 'cookie';
+type PathParameterLocations = 'path';
+export type ParameterLocations = NonPathParameterLocations | PathParameterLocations;
+type NonPathParameterSections = Record<NonPathParameterLocations, ParameterGroup>;
+type PathParameterSections = Record<PathParameterLocations, PathParameterGroup>;
+export type ParameterSections = NonPathParameterSections & PathParameterSections;
+export type ResponseSchema = {
+    [code: string]: BodySchema;
+};
+export type DataSchemaArray = [DataSchema, ...DataSchema[]];
+export declare const typeList: readonly ["boolean", "string", "number", "integer", "object", "array", "stringEnum", "numberEnum", "integerEnum", "null", "any"];
+export type SchemaType = (typeof typeList)[number];
+export type DataSchema = BooleanSchema | StringSchema | NumberSchema | ObjectSchema | ArraySchema | StringEnumSchema | NumberEnumSchema | NullSchema | AnySchema;
+export type BaseSchema<T> = {
+    type: SchemaType;
+    title?: string;
+    description?: string;
+    default?: T;
+    example?: T;
+    required?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    deprecated?: boolean;
+};
+export type BooleanSchema = {
+    type: 'boolean';
+} & BaseSchema<boolean>;
+export type StringSchema = {
+    type: 'string';
+    format?: string;
+    pattern?: string;
+    maxLength?: number;
+    minLength?: number;
+} & BaseSchema<string>;
+export type NumberSchema = {
+    type: 'number' | 'integer';
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean;
+    minimum?: number;
+    exclusiveMinimum?: boolean;
+} & BaseSchema<number>;
+export type ObjectSchema = {
+    type: 'object';
+    additionalProperties?: boolean | DataSchemaArray;
+    maxProperties?: number;
+    minProperties?: number;
+    properties: {
+        [key: string]: DataSchemaArray;
+    };
+} & BaseSchema<object>;
+export type ArraySchema = {
+    type: 'array';
+    items: DataSchemaArray;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+} & BaseSchema<unknown[]>;
+export type StringEnumSchema = {
+    type: 'stringEnum';
+    enum: string[];
+} & BaseSchema<string>;
+export type NumberEnumSchema = {
+    type: 'numberEnum' | 'integerEnum';
+    enum: number[];
+} & BaseSchema<number>;
+export type NullSchema = {
+    type: 'null';
+} & BaseSchema<null>;
+export type AnySchema = {
+    type: 'any';
+} & BaseSchema<unknown>;
+export {};