fumadocs-openapi 4.4.2 → 5.0.0

package/dist/index.d.ts

@@ -1,60 +1,132 @@
 import { OpenAPIV3 } from 'openapi-types';
-import { A as APIPlaygroundProps } from './playground-vSsfCaVw.js';
-export { P as PrimitiveRequestField, a as ReferenceSchema, R as RequestSchema } from './playground-vSsfCaVw.js';
+import Slugger from 'github-slugger';
+import { ComponentType, ReactNode } from 'react';
+
+interface BaseRequestField {
+    name: string;
+    description?: string;
+}
+interface BaseSchema {
+    description?: string;
+    isRequired: boolean;
+}
+type PrimitiveRequestField = BaseRequestField & PrimitiveSchema;
+interface PrimitiveSchema extends BaseSchema {
+    type: 'boolean' | 'string' | 'number';
+    defaultValue: string;
+}
+interface ReferenceSchema extends BaseSchema {
+    type: 'ref';
+    schema: string;
+}
+interface ArraySchema extends BaseSchema {
+    type: 'array';
+    /**
+     * Reference to item schema or the schema
+     */
+    items: string | RequestSchema;
+}
+interface FileSchema extends BaseSchema {
+    type: 'file';
+}
+interface ObjectSchema extends BaseSchema {
+    type: 'object';
+    properties: Record<string, ReferenceSchema>;
+    /**
+     * Reference to schema, or true if it's `any`
+     */
+    additionalProperties?: boolean | string;
+}
+interface SwitcherSchema extends BaseSchema {
+    type: 'switcher';
+    items: Record<string, ReferenceSchema | RequestSchema>;
+}
+interface NullSchema extends BaseSchema {
+    type: 'null';
+}
+type RequestSchema = PrimitiveSchema | ArraySchema | ObjectSchema | SwitcherSchema | NullSchema | FileSchema;
+interface APIPlaygroundProps {
+    route: string;
+    method: string;
+    bodyType: 'json' | 'form-data';
+    authorization?: PrimitiveRequestField;
+    path?: PrimitiveRequestField[];
+    query?: PrimitiveRequestField[];
+    header?: PrimitiveRequestField[];
+    body?: RequestSchema;
+    schemas: Record<string, RequestSchema>;
+}
 
 interface ResponsesProps {
     items: string[];
+    children: ReactNode;
 }
 interface ResponseProps {
     value: string;
+    children: ReactNode;
 }
 interface APIInfoProps {
     method: string;
     route: string;
+    children: ReactNode;
 }
 interface PropertyProps {
     name: string;
     type: string;
     required?: boolean;
     deprecated?: boolean;
+    children?: ReactNode;
 }
 interface ObjectCollapsibleProps {
     name: string;
+    children: ReactNode;
 }
 interface RequestProps {
     language: string;
     name: string;
     code: string;
 }
+interface ResponseTypeProps {
+    lang: string;
+    code: string;
+    label: string;
+}
 interface RootProps {
     baseUrl?: string;
+    children: ReactNode;
 }
 interface Renderer {
-    Root: (props: RootProps, child: string[]) => string;
-    API: (child: string[]) => string;
-    APIInfo: (props: APIInfoProps, child: string[]) => string;
-    APIExample: (child: string[]) => string;
-    Responses: (props: ResponsesProps, child: string[]) => string;
-    Response: (props: ResponseProps, child: string[]) => string;
-    Requests: (items: string[], child: string[]) => string;
-    Request: (props: RequestProps) => string;
-    ResponseTypes: (child: string[]) => string;
-    ExampleResponse: (json: string) => string;
-    TypeScriptResponse: (code: string) => string;
+    Root: ComponentType<RootProps>;
+    API: ComponentType<{
+        children: ReactNode;
+    }>;
+    APIInfo: ComponentType<APIInfoProps>;
+    APIExample: ComponentType<{
+        children: ReactNode;
+    }>;
+    Responses: ComponentType<ResponsesProps>;
+    Response: ComponentType<ResponseProps>;
+    Requests: ComponentType<{
+        items: string[];
+        children: ReactNode;
+    }>;
+    Request: ComponentType<RequestProps>;
+    ResponseTypes: ComponentType<{
+        children: ReactNode;
+    }>;
+    ResponseType: ComponentType<ResponseTypeProps>;
     /**
      * Collapsible to show object schemas
      */
-    ObjectCollapsible: (props: ObjectCollapsibleProps, child: string[]) => string;
-    Property: (props: PropertyProps, child: string[]) => string;
-    APIPlayground: (props: APIPlaygroundProps) => string;
+    ObjectCollapsible: ComponentType<ObjectCollapsibleProps>;
+    Property: ComponentType<PropertyProps>;
+    APIPlayground: ComponentType<APIPlaygroundProps>;
 }
 
-declare const defaultRenderer: Renderer;
-
 /**
  * Sample info of endpoint
  */
-interface Endpoint {
+interface EndpointSample {
     /**
      * Request URL, including path and query parameters
      */
@@ -65,13 +137,15 @@ interface Endpoint {
         mediaType: string;
         sample: unknown;
     };
-    responses: Record<string, Response>;
-    parameters: Parameter[];
+    responses: Record<string, ResponseSample>;
+    parameters: ParameterSample[];
 }
-interface Response {
+interface ResponseSample {
+    mediaType: string;
+    sample: unknown;
     schema: OpenAPIV3.SchemaObject;
 }
-interface Parameter {
+interface ParameterSample {
     name: string;
     in: string;
     schema: OpenAPIV3.SchemaObject;
@@ -99,6 +173,7 @@ interface RenderContext {
     renderer: Renderer;
     document: OpenAPIV3.Document;
     baseUrl: string;
+    slugger: Slugger;
     /**
      * Generate TypeScript definitions from response schema.
      *
@@ -107,11 +182,11 @@ interface RenderContext {
      * @param endpoint - the API endpoint
      * @param code - status code
      */
-    generateTypeScriptSchema?: ((endpoint: Endpoint, code: string) => Awaitable<string>) | false;
+    generateTypeScriptSchema?: ((endpoint: EndpointSample, code: string) => Awaitable<string>) | false;
     /**
      * Generate code samples for endpoint.
      */
-    generateCodeSamples?: (endpoint: Endpoint) => Awaitable<CodeSample[]>;
+    generateCodeSamples?: (endpoint: EndpointSample) => Awaitable<CodeSample[]>;
 }
 
 type DocumentContext = {
@@ -132,11 +207,9 @@ type DocumentContext = {
     type: 'file';
     routes: RouteInformation[];
 };
-interface GenerateOptions extends Pick<RenderContext, 'generateCodeSamples' | 'generateTypeScriptSchema'> {
+interface GenerateOptions {
     /**
-     * The imports of your MDX components.
-     *
-     * If not specified, import required components from `fumadocs-ui/components/api`.
+     * Additional imports of your MDX components.
      */
     imports?: {
         names: string[];
@@ -148,18 +221,17 @@ interface GenerateOptions extends Pick<RenderContext, 'generateCodeSamples' | 'g
      * A `full: true` property will be added by default.
      */
     frontmatter?: (title: string, description: string | undefined, context: DocumentContext) => Record<string, unknown>;
-    renderer?: Partial<Renderer>;
 }
 interface GenerateTagOutput {
     tag: string;
     content: string;
 }
 interface GenerateOperationOutput {
-    id: string;
     content: string;
+    method: MethodInformation;
     route: RouteInformation;
 }
-declare function generate(pathOrDocument: string | OpenAPIV3.Document, options?: GenerateOptions): Promise<string>;
+declare function generateAll(pathOrDocument: string | OpenAPIV3.Document, options?: GenerateOptions): Promise<string>;
 declare function generateOperations(pathOrDocument: string | OpenAPIV3.Document, options?: GenerateOptions): Promise<GenerateOperationOutput[]>;
 declare function generateTags(pathOrDocument: string | OpenAPIV3.Document, options?: GenerateOptions): Promise<GenerateTagOutput[]>;
 
@@ -187,13 +259,18 @@ interface Config extends GenerateOptions {
     /**
      * Group output using folders (Only works on `operation` mode)
      *
+     * @deprecated Use `groupBy` instead
      * @defaultValue false
      */
     groupByFolder?: boolean;
+    /**
+     * Group output using folders (Only works on `operation` mode)
+     *
+     * @defaultValue 'none'
+     */
+    groupBy?: 'tag' | 'route' | 'none';
     cwd?: string;
 }
-declare function generateFiles({ input, output, name: nameFn, per, cwd, groupByFolder, ...options }: Config): Promise<void>;
-
-declare function createElement(name: string, props: object, ...child: string[]): string;
+declare function generateFiles({ input, output, name: nameFn, per, cwd, groupBy, ...options }: Config): Promise<void>;
 
-export { type APIInfoProps, APIPlaygroundProps, type Config, type DocumentContext, type GenerateOperationOutput, type GenerateOptions, type GenerateTagOutput, type MethodInformation, type ObjectCollapsibleProps, type PropertyProps, type RenderContext, type Renderer, type RequestProps, type ResponseProps, type ResponsesProps, type RootProps, type RouteInformation, createElement, defaultRenderer, generate, generateFiles, generateOperations, generateTags };
+export { type Config, type DocumentContext, type GenerateOperationOutput, type GenerateOptions, type GenerateTagOutput, type MethodInformation, type RenderContext, type RouteInformation, generateAll, generateFiles, generateOperations, generateTags };