fumadocs-openapi 5.7.5 → 5.8.0

package/dist/ui/{client-client-Ddkf37Pm.js → client-client-D9KEBAUd.js}

@@ -1,12 +1,12 @@
 'use client';
 import { forwardRef, createElement, useContext, createContext, useState, useEffect, useMemo } from 'react';
 import { jsx, jsxs } from 'react/jsx-runtime';
-import { useCopyButton, cn, buttonVariants } from 'fumadocs-ui/components/api';
+import { cn, useCopyButton, buttonVariants } from 'fumadocs-ui/components/api';
 import dynamic from 'next/dynamic';
 import { useOnChange } from 'fumadocs-core/utils/use-on-change';
 
 /**
- * @license lucide-react v0.460.0 - ISC
+ * @license lucide-react v0.462.0 - ISC
  *
  * This source code is licensed under the ISC license.
  * See the LICENSE file in the root directory of this source tree.
@@ -16,7 +16,7 @@ const mergeClasses = (...classes)=>classes.filter((className, index, array)=>{
     }).join(" ").trim();
 
 /**
- * @license lucide-react v0.460.0 - ISC
+ * @license lucide-react v0.462.0 - ISC
  *
  * This source code is licensed under the ISC license.
  * See the LICENSE file in the root directory of this source tree.
@@ -253,7 +253,7 @@ function useSchemaContext() {
     return ctx;
 }
 
-const APIPlayground = dynamic(()=>import('./playground-client-DPxpLHKJ.js').then((mod)=>mod.APIPlayground));
+const APIPlayground = dynamic(()=>import('./playground-client-C0GkAwm2.js').then((mod)=>mod.APIPlayground));
 function Root({ children, baseUrl, className, shikiOptions, ...props }) {
     return /*#__PURE__*/ jsx("div", {
         className: cn('flex flex-col gap-24 text-sm text-fd-muted-foreground', className),
@@ -290,7 +290,7 @@ function BaseUrlSelect({ baseUrls }) {
     const { baseUrl, setBaseUrl } = useApiContext();
     if (baseUrls.length <= 1) return null;
     return /*#__PURE__*/ jsxs("div", {
-        className: "flex flex-row items-center gap-1 px-1 mt-2",
+        className: "mt-2 flex flex-row items-center gap-1 px-1",
         children: [
             /*#__PURE__*/ jsx("span", {
                 className: "p-0.5 text-xs font-medium text-fd-muted-foreground",
@@ -299,7 +299,7 @@ function BaseUrlSelect({ baseUrls }) {
             /*#__PURE__*/ jsx("select", {
                 value: baseUrl,
                 onChange: (e)=>setBaseUrl(e.target.value),
-                className: "min-w-0 flex-1 bg-transparent font-mono text-xs text-fd-foreground outline-none",
+                className: "min-w-0 flex-1 bg-transparent text-xs text-fd-foreground outline-none",
                 children: baseUrls.map((url)=>/*#__PURE__*/ jsx("option", {
                         value: url,
                         children: url
@@ -309,4 +309,4 @@ function BaseUrlSelect({ baseUrls }) {
     });
 }
 
-export { APIPlayground as A, BaseUrlSelect as B, CircleX as C, Plus as P, Root as R, SchemaContext as S, Trash2 as T, CircleCheck as a, ChevronDown as b, ChevronUp as c, Check as d, useApiContext as e, CopyRouteButton as f, useSchemaContext as u };
+export { APIPlayground as A, BaseUrlSelect as B, CircleCheck as C, Plus as P, Root as R, SchemaContext as S, Trash2 as T, CircleX as a, ChevronDown as b, ChevronUp as c, Check as d, useApiContext as e, CopyRouteButton as f, useSchemaContext as u };

package/dist/ui/index.d.ts

@@ -2,10 +2,15 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ReactNode, ComponentType, ReactElement, MutableRefObject, HTMLAttributes } from 'react';
 import { FieldPath, ControllerRenderProps, ControllerFieldState, UseFormStateReturn } from 'react-hook-form';
-import { OpenAPIV3 } from 'openapi-types';
+import { OpenAPIV3_1 } from 'openapi-types';
 import Slugger from 'github-slugger';
 import { CodeToHastOptionsCommon, CodeOptionsThemes, BuiltinTheme } from 'shiki';
 
+type NoReference<T> = T extends (infer I)[] ? NoReference<I>[] : T extends ReferenceObject ? Exclude<T, ReferenceObject> : T extends object ? {
+    [K in keyof T]: NoReference<T[K]>;
+} : T;
+type ParsedSchema = OpenAPIV3_1.SchemaObject;
+
 /**
  * Sample info of endpoint
  */
@@ -16,7 +21,7 @@ interface EndpointSample {
     url: string;
     method: string;
     body?: {
-        schema: OpenAPIV3.SchemaObject;
+        schema: ParsedSchema;
         mediaType: string;
         sample: unknown;
     };
@@ -26,12 +31,12 @@ interface EndpointSample {
 interface ResponseSample {
     mediaType: string;
     sample: unknown;
-    schema: OpenAPIV3.SchemaObject;
+    schema: ParsedSchema;
 }
 interface ParameterSample {
     name: string;
     in: string;
-    schema: OpenAPIV3.SchemaObject;
+    schema: ParsedSchema;
     sample: unknown;
 }
 
@@ -41,12 +46,23 @@ interface CodeSample {
     source: string | ((endpoint: EndpointSample) => string | undefined) | false;
 }
 
+type Document = OpenAPIV3_1.Document;
+type ReferenceObject = OpenAPIV3_1.ReferenceObject;
 type Awaitable<T> = T | Promise<T>;
+/**
+ * Dereferenced value and its original `$ref` value
+ */
+type DereferenceMap = Map<unknown, string>;
 interface RenderContext {
     renderer: Renderer;
-    document: OpenAPIV3.Document;
+    /**
+     * dereferenced schema
+     */
+    document: NoReference<Document>;
     baseUrl: string;
+    baseUrls: string[];
     slugger: Slugger;
+    dereferenceMap: DereferenceMap;
     /**
      * Generate TypeScript definitions from response schema.
      *
@@ -132,6 +148,7 @@ interface APIInfoProps {
     method: string;
     route: string;
     baseUrls: string[];
+    head: ReactNode;
     children: ReactNode;
 }
 interface PropertyProps {
@@ -232,15 +249,15 @@ declare function Root({ children, baseUrl, className, shikiOptions, ...props }:
     shikiOptions: RenderContext['shikiOptions'];
 } & HTMLAttributes<HTMLDivElement>): ReactNode;
 
-declare function APIInfo({ children, className, route, badgeClassname, baseUrls, method, ...props }: APIInfoProps & HTMLAttributes<HTMLDivElement> & {
+declare function APIInfo({ className, route, badgeClassname, baseUrls, method, head, ...props }: APIInfoProps & HTMLAttributes<HTMLDivElement> & {
     badgeClassname?: string;
 }): react_jsx_runtime.JSX.Element;
-declare function API({ children, ...props }: HTMLAttributes<HTMLDivElement>): React.ReactElement;
-declare function Property({ name, type, required, deprecated, children, }: PropertyProps): React.ReactElement;
-declare function APIExample(props: HTMLAttributes<HTMLDivElement>): React.ReactElement;
+declare function API({ children, ...props }: HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
+declare function Property({ name, type, required, deprecated, children, }: PropertyProps): react_jsx_runtime.JSX.Element;
+declare function APIExample(props: HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
 declare function ObjectCollapsible(props: {
     name: string;
     children: ReactNode;
-}): React.ReactElement;
+}): react_jsx_runtime.JSX.Element;
 
 export { API, APIExample, APIInfo, APIPlayground, ObjectCollapsible, Property, Root, useSchemaContext };

package/dist/ui/index.js

@@ -3,8 +3,8 @@ import { cn } from 'fumadocs-ui/components/api';
 import { Fragment } from 'react';
 import { Accordions, Accordion } from 'fumadocs-ui/components/accordion';
 import { cva } from 'class-variance-authority';
-import { f as CopyRouteButton, B as BaseUrlSelect } from './client-client-Ddkf37Pm.js';
-export { A as APIPlayground, R as Root, u as useSchemaContext } from './client-client-Ddkf37Pm.js';
+import { f as CopyRouteButton, B as BaseUrlSelect } from './client-client-D9KEBAUd.js';
+export { A as APIPlayground, R as Root, u as useSchemaContext } from './client-client-D9KEBAUd.js';
 
 const badgeVariants = cva('rounded-xl border px-1.5 py-1 text-xs font-medium leading-[12px]', {
     variants: {
@@ -35,7 +35,7 @@ function getBadgeColor(method) {
 function Route({ route }) {
     const segments = route.split('/').filter((part)=>part.length > 0);
     return /*#__PURE__*/ jsx("div", {
-        className: "not-prose flex flex-row items-center gap-1 overflow-auto text-nowrap text-xs",
+        className: "not-prose flex flex-row items-center gap-0.5 overflow-auto text-nowrap text-xs",
         children: segments.map((part, index)=>/*#__PURE__*/ jsxs(Fragment, {
                 children: [
                     /*#__PURE__*/ jsx("span", {
@@ -53,11 +53,12 @@ function Route({ route }) {
             }, index))
     });
 }
-function APIInfo({ children, className, route, badgeClassname, baseUrls, method = 'GET', ...props }) {
+function APIInfo({ className, route, badgeClassname, baseUrls, method = 'GET', head, ...props }) {
     return /*#__PURE__*/ jsxs("div", {
         className: cn('min-w-0 flex-1', className),
         ...props,
         children: [
+            head,
             /*#__PURE__*/ jsxs("div", {
                 className: "sticky top-[var(--fd-api-info-top)] z-[4] mb-4 border-b border-fd-foreground/10 bg-fd-card/50 px-4 py-1.5 shadow-lg backdrop-blur-lg max-lg:-mx-3 max-md:-mx-4 md:rounded-xl md:border md:px-1.5",
                 children: [
@@ -86,7 +87,7 @@ function APIInfo({ children, className, route, badgeClassname, baseUrls, method
             }),
             /*#__PURE__*/ jsx("div", {
                 className: "prose-no-margin",
-                children: children
+                children: props.children
             })
         ]
     });

package/dist/ui/{playground-client-DPxpLHKJ.js → playground-client-C0GkAwm2.js}

@@ -1,11 +1,11 @@
 'use client';
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import * as React from 'react';
-import { createContext, forwardRef, useId, useContext, useState, useCallback, useRef, useMemo, useEffect } from 'react';
+import { forwardRef, useId, createContext, useContext, useState, useCallback, useRef, useEffect, useMemo } from 'react';
 import { FormProvider, Controller, useFormContext, useFieldArray, useForm, useWatch } from 'react-hook-form';
 import { Accordions, Accordion } from 'fumadocs-ui/components/accordion';
 import { cn, buttonVariants } from 'fumadocs-ui/components/api';
-import { C as CircleX, a as CircleCheck, b as ChevronDown, c as ChevronUp, d as Check, u as useSchemaContext, T as Trash2, P as Plus, e as useApiContext, S as SchemaContext } from './client-client-Ddkf37Pm.js';
+import { C as CircleCheck, a as CircleX, b as ChevronDown, c as ChevronUp, d as Check, u as useSchemaContext, T as Trash2, P as Plus, e as useApiContext, S as SchemaContext } from './client-client-D9KEBAUd.js';
 import { Slot } from '@radix-ui/react-slot';
 import { cva } from 'class-variance-authority';
 import { useOnChange } from 'fumadocs-core/utils/use-on-change';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "5.7.5",
+  "version": "5.8.0",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -32,10 +32,11 @@
   ],
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^11.7.2",
-    "@fumari/json-schema-to-typescript": "^1.1.1",
+    "@fumari/json-schema-to-typescript": "^1.1.2",
     "@radix-ui/react-select": "^2.1.2",
     "@radix-ui/react-slot": "^1.1.0",
-    "class-variance-authority": "^0.7.0",
+    "@scalar/openapi-parser": "^0.8.10",
+    "class-variance-authority": "^0.7.1",
     "fast-glob": "^3.3.1",
     "github-slugger": "^2.0.0",
     "hast-util-to-jsx-runtime": "^2.3.2",
@@ -44,17 +45,17 @@
     "react-hook-form": "^7.53.2",
     "remark": "^15.0.1",
     "remark-rehype": "^11.1.1",
-    "shiki": "^1.23.1",
-    "fumadocs-core": "14.5.4",
-    "fumadocs-ui": "14.5.4"
+    "shiki": "^1.24.0",
+    "fumadocs-core": "14.5.5",
+    "fumadocs-ui": "14.5.5"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "22.9.3",
+    "@types/node": "22.10.1",
     "@types/openapi-sampler": "^1.0.3",
     "@types/react": "^18.3.12",
-    "bunchee": "^5.6.1",
-    "lucide-react": "^0.460.0",
+    "bunchee": "^6.0.0",
+    "lucide-react": "^0.462.0",
     "next": "15.0.3",
     "openapi-types": "^12.1.3",
     "eslint-config-custom": "0.0.0",