@mintlify/validation 0.1.496 → 0.1.498

package/dist/index.d.ts

@@ -27,3 +27,6 @@ export * from './mint-config/schemas/v2/properties/index.js';
 export * from './types/index.js';
 export type { ThemeType } from './mint-config/schemas/v2/index.js';
 export * from './chat-config/index.js';
+export * from './openapi/v2/types/index.js';
+export * from './openapi/v2/openApiToSchemaGraph.js';
+export * from './openapi/v2/isOpenAPIV3orV31Document.js';

package/dist/index.js

@@ -5,9 +5,11 @@ import { colorsSchema } from './mint-config/schemas/v2/properties/colors.js';
 import { baseLanguageSchema, languageSchema, languagesSchema, pageSchema, } from './mint-config/schemas/v2/properties/index.js';
 import { anchorsSchema, anchorSchema, baseAnchorSchema, } from './mint-config/schemas/v2/properties/navigation/anchors.js';
 import { baseDropdownSchema, dropdownSchema, dropdownsSchema, } from './mint-config/schemas/v2/properties/navigation/dropdown.js';
-import { baseGroupSchema, groupSchema, groupsSchema, } from './mint-config/schemas/v2/properties/navigation/groups.js';
+import { baseGroupSchema, groupsSchema, } from './mint-config/schemas/v2/properties/navigation/groups.js';
 import { navigationSchema } from './mint-config/schemas/v2/properties/navigation/index.js';
+import { baseMenuItemSchema, menuItemSchema, menuSchema, } from './mint-config/schemas/v2/properties/navigation/menu.js';
 import { pagesSchema, pageOrGroupSchema, } from './mint-config/schemas/v2/properties/navigation/pages.js';
+import { baseProductSchema, productSchema, productsSchema, } from './mint-config/schemas/v2/properties/navigation/products.js';
 import { baseTabSchema, tabSchema, tabsSchema, } from './mint-config/schemas/v2/properties/navigation/tabs.js';
 import { baseVersionSchema, versionSchema, versionsSchema, } from './mint-config/schemas/v2/properties/navigation/version.js';
 import { hiddenSchema } from './mint-config/schemas/v2/properties/reusable/hidden.js';
@@ -30,6 +32,8 @@ export const docsConfigJsonSchema = zodToJsonSchema(docsConfigSchema, {
         anchorsSchema,
         baseAnchorSchema,
         baseDropdownSchema,
+        baseMenuItemSchema,
+        baseProductSchema,
         baseGroupSchema,
         baseLanguageSchema,
         baseTabSchema,
@@ -37,7 +41,10 @@ export const docsConfigJsonSchema = zodToJsonSchema(docsConfigSchema, {
         colorsSchema,
         dropdownSchema,
         dropdownsSchema,
-        groupSchema,
+        menuItemSchema,
+        menuSchema,
+        productSchema,
+        productsSchema,
         groupsSchema,
         hiddenSchema,
         iconSchema,
@@ -57,3 +64,6 @@ export const docsConfigJsonSchema = zodToJsonSchema(docsConfigSchema, {
 export * from './mint-config/schemas/v2/properties/index.js';
 export * from './types/index.js';
 export * from './chat-config/index.js';
+export * from './openapi/v2/types/index.js';
+export * from './openapi/v2/openApiToSchemaGraph.js';
+export * from './openapi/v2/isOpenAPIV3orV31Document.js';

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

@@ -2,6 +2,7 @@ import { z } from 'zod';
 import { nonRecursiveAnchorSchema } from './anchors.js';
 import { nonRecursiveDropdownSchema } from './dropdown.js';
 import { nonRecursiveLanguageSchema } from './languages.js';
+import { nonRecursiveProductSchema } from './products.js';
 import { nonRecursiveTabSchema } from './tabs.js';
 import { nonRecursiveVersionSchema } from './version.js';
 export const globalSchema = z
@@ -12,6 +13,7 @@ export const globalSchema = z
     tabs: z.array(nonRecursiveTabSchema).optional(),
     dropdowns: z.array(nonRecursiveDropdownSchema).optional(),
     anchors: z.array(nonRecursiveAnchorSchema).optional(),
+    products: z.array(nonRecursiveProductSchema).optional(),
 })
     .strict())
     .describe('Add external links that will appear on all sections and pages irregardless of navigation nesting');

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

@@ -376,11 +376,11 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
     global?: import("./divisionNav.js").GlobalNavigation | undefined;
 }>]>;
 export declare const decoratedNavigationSchema: z.ZodIntersection<z.ZodUnion<[z.ZodObject<{
-    products: z.ZodArray<z.ZodType<import("./divisionNav.js").ProductNavigation<"default">, z.ZodTypeDef, import("./divisionNav.js").ProductNavigation<"default">>, "many">;
+    products: z.ZodArray<z.ZodType<import("./divisionNav.js").ProductNavigation<"decorated">, z.ZodTypeDef, import("./divisionNav.js").ProductNavigation<"decorated">>, "many">;
 }, "strip", z.ZodTypeAny, {
-    products: import("./divisionNav.js").ProductNavigation<"default">[];
+    products: import("./divisionNav.js").ProductNavigation<"decorated">[];
 }, {
-    products: import("./divisionNav.js").ProductNavigation<"default">[];
+    products: import("./divisionNav.js").ProductNavigation<"decorated">[];
 }>, z.ZodObject<{
     languages: z.ZodArray<z.ZodType<import("./divisionNav.js").LanguageNavigation<"decorated">, z.ZodTypeDef, import("./divisionNav.js").LanguageNavigation<"decorated">>, "many">;
 }, "strip", z.ZodTypeAny, {

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

@@ -5,7 +5,7 @@ import { globalSchema } from './global.js';
 import { decoratedGroupsSchema, groupsSchema, } from './groups.js';
 import { decoratedLanguagesSchema, languagesSchema, } from './languages.js';
 import { decoratedPagesSchema, pagesSchema } from './pages.js';
-import { productsSchema } from './products.js';
+import { decoratedProductsSchema, productsSchema, } from './products.js';
 import { decoratedTabsSchema, tabsSchema } from './tabs.js';
 import { decoratedVersionsSchema, versionsSchema, } from './version.js';
 const baseNavigationSchema = z.object({ global: globalSchema.optional() });
@@ -23,7 +23,7 @@ export const navigationSchema = z
     .describe('The navigation structure of the content');
 export const decoratedNavigationSchema = z
     .union([
-    z.object({ products: productsSchema }),
+    z.object({ products: decoratedProductsSchema }),
     z.object({ languages: decoratedLanguagesSchema }),
     z.object({ versions: decoratedVersionsSchema }),
     z.object({ tabs: decoratedTabsSchema }),

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

@@ -62,6 +62,66 @@ export declare const decoratedProductSchema: z.ZodType<ProductNavigation<'decora
 export declare const productsSchema: z.ZodArray<z.ZodType<ProductNavigation<"default">, z.ZodTypeDef, ProductNavigation<"default">>, "many">;
 export declare const decoratedProductsSchema: z.ZodArray<z.ZodType<ProductNavigation<"decorated">, z.ZodTypeDef, ProductNavigation<"decorated">>, "many">;
 export type BaseProductSchema = z.infer<typeof baseProductSchema>;
+export declare const nonRecursiveProductSchema: z.ZodObject<{
+    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"]>>;
+        name: z.ZodEffects<z.ZodString, string, string>;
+        library: z.ZodOptional<z.ZodEnum<["fontawesome", "lucide"]>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+        library?: "fontawesome" | "lucide" | undefined;
+    }, {
+        name: string;
+        style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+        library?: "fontawesome" | "lucide" | undefined;
+    }>]>>;
+    color: z.ZodOptional<z.ZodObject<{
+        light: z.ZodOptional<z.ZodString>;
+        dark: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        light?: string | undefined;
+        dark?: string | undefined;
+    }, {
+        light?: string | undefined;
+        dark?: string | undefined;
+    }>>;
+    description: z.ZodOptional<z.ZodString>;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    product: z.ZodString;
+    href: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    href: string;
+    product: string;
+    name?: 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;
+        library?: "fontawesome" | "lucide" | undefined;
+    } | undefined;
+    color?: {
+        light?: string | undefined;
+        dark?: string | undefined;
+    } | undefined;
+    description?: string | undefined;
+    hidden?: boolean | undefined;
+}, {
+    href: string;
+    product: string;
+    name?: 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;
+        library?: "fontawesome" | "lucide" | undefined;
+    } | undefined;
+    color?: {
+        light?: string | undefined;
+        dark?: string | undefined;
+    } | undefined;
+    description?: string | undefined;
+    hidden?: boolean | undefined;
+}>;
 export type ProductConfig = z.infer<typeof productSchema>;
 export type ProductsConfig = z.infer<typeof productsSchema>;
 export type DecoratedProductConfig = z.infer<typeof decoratedProductSchema>;

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

@@ -91,3 +91,4 @@ export const decoratedProductsSchema = z
     .array(decoratedProductSchema)
     .min(1, 'At least one product must be specified')
     .describe('Organizing by products');
+export const nonRecursiveProductSchema = baseProductSchema.extend({ href: hrefSchema });

package/dist/openapi/v2/isOpenAPIV3orV31Document.d.ts

@@ -0,0 +1,2 @@
+import { OpenAPIV3, OpenAPIV3_1, OpenAPI } from 'openapi-types';
+export declare const isOpenAPIV3orV31Document: (spec: OpenAPI.Document) => spec is OpenAPIV3.Document | OpenAPIV3_1.Document;

package/dist/openapi/v2/isOpenAPIV3orV31Document.js

@@ -0,0 +1,3 @@
+export const isOpenAPIV3orV31Document = (spec) => {
+    return 'openapi' in spec;
+};

package/dist/openapi/v2/mapOperation.d.ts

@@ -1,8 +1,10 @@
+import { HttpMethod } from '../types/endpoint.js';
 import { OperationObject, RefUuidMap, UUIDObjectHashMap, HashedNodeMap, UUID } from './types/index.js';
-export declare const mapOperation: ({ operation, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, }: {
+export declare const mapOperation: ({ operation, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, method, }: {
     operation: OperationObject;
     refUuidMap: RefUuidMap;
     uuidObjectHashMap: UUIDObjectHashMap;
     hashedNodeMap: HashedNodeMap;
     uuid: UUID;
+    method: HttpMethod;
 }) => void;

package/dist/openapi/v2/mapOperation.js

@@ -4,7 +4,7 @@ import { mapParameter } from './mapParameter.js';
 import { mapRequestBody } from './mapRequestBody.js';
 import { mapResponse } from './mapResponse.js';
 import { mapSecurityRequirement } from './mapSecurityRequirement.js';
-export const mapOperation = ({ operation, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, }) => {
+export const mapOperation = ({ operation, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, method, }) => {
     var _a;
     const objectHash = hash(operation);
     uuidObjectHashMap[uuid] = objectHash;
@@ -68,6 +68,7 @@ export const mapOperation = ({ operation, refUuidMap, uuidObjectHashMap, hashedN
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         operation.servers = serverUuids;
     }
+    operation.method = method;
     // add to hashedNodeMap
     hashedNodeMap[objectHash] = operation;
 };

package/dist/openapi/v2/mapPath.d.ts

@@ -1,8 +1,10 @@
 import { RefUuidMap, UUIDObjectHashMap, HashedNodeMap, UUID, PathObjectOrRef } from './types/index.js';
-export declare const mapPath: ({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, }: {
+export declare const mapPath: ({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, path, isWebhook, }: {
     pathItem: PathObjectOrRef;
     refUuidMap: RefUuidMap;
     uuidObjectHashMap: UUIDObjectHashMap;
     hashedNodeMap: HashedNodeMap;
     uuid: UUID;
+    path: string;
+    isWebhook?: boolean;
 }) => void;

package/dist/openapi/v2/mapPath.js

@@ -3,7 +3,7 @@ import { v4 as uuidv4 } from 'uuid';
 import { httpMethods } from '../types/endpoint.js';
 import { mapOperation } from './mapOperation.js';
 import { mapParameter } from './mapParameter.js';
-export const mapPath = ({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, }) => {
+export const mapPath = ({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, path, isWebhook, }) => {
     var _a;
     const objectHash = hash(pathItem);
     uuidObjectHashMap[uuid] = objectHash;
@@ -16,9 +16,15 @@ export const mapPath = ({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap
     if ('parameters' in pathItem) {
         const parameterUuids = [];
         (_a = pathItem.parameters) === null || _a === void 0 ? void 0 : _a.forEach((parameter) => {
-            const uuid = uuidv4();
-            mapParameter({ parameter, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid });
-            parameterUuids.push(uuid);
+            const parameterUuid = uuidv4();
+            mapParameter({
+                parameter,
+                refUuidMap,
+                uuidObjectHashMap,
+                hashedNodeMap,
+                uuid: parameterUuid,
+            });
+            parameterUuids.push(parameterUuid);
         });
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         pathItem.parameters = parameterUuids;
@@ -31,12 +37,21 @@ export const mapPath = ({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap
             const operation = pathItem[method];
             if (!operation)
                 return;
-            const uuid = uuidv4();
-            mapOperation({ operation, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid });
+            const operationUuid = uuidv4();
+            mapOperation({
+                operation,
+                refUuidMap,
+                uuidObjectHashMap,
+                hashedNodeMap,
+                uuid: operationUuid,
+                method,
+            });
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            pathItem[method] = uuid;
+            pathItem[method] = operationUuid;
+            refUuidMap[`${path}/${isWebhook ? 'webhook' : method}`] = uuid;
         });
     }
+    pathItem.path = path;
     // store path object
     hashedNodeMap[objectHash] = pathItem;
 };

package/dist/openapi/v2/mapPathComponents.js

@@ -9,6 +9,6 @@ export const mapPathComponents = ({ spec, refUuidMap, uuidObjectHashMap, hashedN
     Object.entries(pathComponents).forEach(([name, pathItem]) => {
         const refId = `#/components/pathItems/${name}`;
         const uuid = refUuidMap[refId] || uuidv4();
-        mapPath({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid });
+        mapPath({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, path: name });
     });
 };

package/dist/openapi/v2/mapPaths.js

@@ -11,10 +11,10 @@ export const mapPaths = ({ spec, refUuidMap, uuidObjectHashMap, hashedNodeMap, d
     Object.entries(paths).forEach(([path, pathItem]) => {
         if (!pathItem)
             return;
-        // map to refUuidMap, uuidObjectHashMap, hashedNodeMap
         const uuid = uuidv4();
-        refUuidMap[path] = uuid;
-        mapPath({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid });
+        // map to uuidObjectHashMap, hashedNodeMap
+        // map path + operation in refUuidMap in mapPath
+        mapPath({ pathItem, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid, path });
         // add path to document
         document.paths.push(uuid);
     });

package/dist/openapi/v2/mapWebhooks.js

@@ -14,8 +14,18 @@ export const mapWebhooks = ({ spec, refUuidMap, uuidObjectHashMap, hashedNodeMap
         if (!webhook)
             return;
         const uuid = uuidv4();
-        refUuidMap[webhookPath] = uuid;
-        mapPath({ pathItem: webhook, refUuidMap, uuidObjectHashMap, hashedNodeMap, uuid });
+        // map to uuidObjectHashMap, hashedNodeMap
+        // map path + operation in refUuidMap in mapPath
+        mapPath({
+            pathItem: webhook,
+            refUuidMap,
+            uuidObjectHashMap,
+            hashedNodeMap,
+            uuid,
+            path: webhookPath,
+            isWebhook: true,
+        });
+        // add webhook to document
         document.webhooks.push(uuid);
     });
 };

package/dist/openapi/v2/openApiToSchemaGraph.d.ts

@@ -1,14 +1,7 @@
 import { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
-import { UUIDObjectHashMap, HashedNodeMap } from './types/index.js';
+import { SchemaGraphData } from './types/index.js';
 export declare const openApiToSchemaGraph: ({ spec, filename, originalFileLocation, }: {
     spec: OpenAPIV3.Document | OpenAPIV3_1.Document;
     filename: string;
     originalFileLocation?: string;
-}) => {
-    spec: {
-        uuidObjectHashMap: UUIDObjectHashMap;
-        hashedNodeMap: HashedNodeMap;
-    };
-    filename: string;
-    originalFileLocation?: string;
-};
+}) => SchemaGraphData;

package/dist/openapi/v2/openApiToSchemaGraph.js

@@ -60,6 +60,7 @@ export const openApiToSchemaGraph = ({ spec, filename, originalFileLocation, })
         filename,
         originalFileLocation,
         spec: {
+            refUuidMap,
             uuidObjectHashMap,
             hashedNodeMap,
         },

package/dist/openapi/v2/types/index.d.ts

@@ -1,11 +1,11 @@
 import { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
-import { XMcp, XMint } from '../../types/endpoint.js';
+import { XMcp, XMint, HttpMethod } from '../../types/endpoint.js';
 export type UUID = string;
 export type HashId = string;
 export type RefUuidMap = Record<string, UUID>;
 export type UUIDObjectHashMap = Record<UUID, HashId>;
 export type HashedNodeMap = Record<HashId, GraphNode>;
-export type GraphNode = SchemaOrRef | ResponseOrRef | HeaderOrRef | ParameterOrRef | Media | ExampleOrRef | RequestBodyOrRef | SecuritySchemeOrRef | Server | PathOrRef | Operation | SecurityRequirement | Document;
+export type GraphNode = SchemaOrRef | ResponseOrRef | HeaderOrRef | ParameterOrRef | Media | ExampleOrRef | RequestBodyOrRef | SecuritySchemeOrRef | ServerObject | PathOrRef | Operation | SecurityRequirement | Document;
 export type SchemaObject = OpenAPIV3.SchemaObject | OpenAPIV3_1.SchemaObject;
 export type RefObject = OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
 export type SchemaOrRefObject = SchemaObject | RefObject;
@@ -131,16 +131,17 @@ export type SecuritySchemeOrRef = (SecuritySchemeObject & {
     $ref: UUID;
 });
 export type ServerObject = OpenAPIV3.ServerObject | OpenAPIV3_1.ServerObject;
-export type Server = ServerObject;
 export type PathObject = OpenAPIV3.PathItemObject | OpenAPIV3_1.PathItemObject;
 export type PathObjectOrRef = PathObject | RefObject;
 export type PathOrRef = (PathObject & {
+    path: string;
     parameters?: UUID[];
 } & {
     [method in OpenAPIV3.HttpMethods]: UUID;
 } & {
     $ref?: never;
 }) | (RefObject & {
+    path: string;
     $ref: UUID;
 } & {
     parameters?: never;
@@ -157,6 +158,7 @@ export type OperationExtensions = {
     'x-code-samples'?: string[];
 };
 export type Operation = OperationObject & {
+    method: HttpMethod;
     parameters?: UUID[];
     requestBody?: UUID;
     responses?: {
@@ -182,3 +184,12 @@ export type Document = Omit<DocumentObject, 'servers' | 'paths' | 'webhooks' | '
     webhooks: UUID[];
     security: UUID[];
 };
+export type SchemaGraphData = {
+    filename: string;
+    originalFileLocation?: string;
+    spec: {
+        uuidObjectHashMap: UUIDObjectHashMap;
+        hashedNodeMap: HashedNodeMap;
+        refUuidMap: RefUuidMap;
+    };
+};