fumadocs-openapi 5.7.5 → 5.8.0

package/dist/server/index.d.ts

@@ -1,5 +1,5 @@
-import { OpenAPIV3 } from 'openapi-types';
 import { ComponentType, ReactNode, FC } from 'react';
+import { OpenAPIV3_1, OpenAPIV3 } from 'openapi-types';
 import Slugger from 'github-slugger';
 import { CodeToHastOptionsCommon, CodeOptionsThemes, BuiltinTheme } from 'shiki';
 import { BuildPageTreeOptions } from 'fumadocs-core/source';
@@ -73,6 +73,7 @@ interface APIInfoProps {
     method: string;
     route: string;
     baseUrls: string[];
+    head: ReactNode;
     children: ReactNode;
 }
 interface PropertyProps {
@@ -128,6 +129,11 @@ interface Renderer {
     APIPlayground: ComponentType<APIPlaygroundProps>;
 }
 
+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
  */
@@ -138,7 +144,7 @@ interface EndpointSample {
     url: string;
     method: string;
     body?: {
-        schema: OpenAPIV3.SchemaObject;
+        schema: ParsedSchema;
         mediaType: string;
         sample: unknown;
     };
@@ -148,12 +154,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;
 }
 
@@ -163,12 +169,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.
      *
@@ -185,26 +202,36 @@ interface RenderContext {
     shikiOptions?: Omit<CodeToHastOptionsCommon, 'lang'> & CodeOptionsThemes<BuiltinTheme>;
 }
 
+type DocumentInput = string | OpenAPIV3_1.Document | OpenAPIV3.Document;
+
 interface ApiPageProps extends Pick<RenderContext, 'generateCodeSamples' | 'generateTypeScriptSchema' | 'shikiOptions'> {
-    document: string | OpenAPIV3.Document;
+    document: DocumentInput;
+    hasHead: boolean;
+    renderer?: Partial<Renderer>;
     /**
      * An array of operations
      */
-    operations: Operation[];
-    hasHead: boolean;
-    renderer?: Partial<Renderer>;
+    operations?: OperationItem[];
+    webhooks?: WebhookItem[];
+    /**
+     * By default, it is disabled on dev mode
+     */
     disableCache?: boolean;
 }
-interface Operation {
+interface WebhookItem {
+    name: string;
+    method: OpenAPIV3_1.HttpMethods;
+}
+interface OperationItem {
     path: string;
-    method: OpenAPIV3.HttpMethods;
+    method: OpenAPIV3_1.HttpMethods;
 }
 
 interface OpenAPIOptions extends Omit<Partial<ApiPageProps>, 'document'> {
     /**
      * @deprecated Pass document to `APIPage` instead
      */
-    documentOrPath?: string | OpenAPIV3.Document;
+    documentOrPath?: DocumentInput;
 }
 interface OpenAPIServer {
     APIPage: FC<ApiPageProps>;