fumadocs-openapi 6.0.1 → 6.0.3

package/dist/server/api-page.js

@@ -0,0 +1,59 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import Slugger from 'github-slugger';
+import { Operation } from '../render/operation.js';
+import { createMethod } from '../server/create-method.js';
+import { createRenders } from '../render/renderer.js';
+import { processDocument, } from '../utils/process-document.js';
+import { getUrl } from '../utils/server-url.js';
+export async function APIPage(props) {
+    const { operations, hasHead = true, webhooks, disableCache = process.env.NODE_ENV === 'development', } = props;
+    const processed = await processDocument(props.document, disableCache);
+    const ctx = await getContext(processed, props);
+    const { document } = processed;
+    return (_jsxs(ctx.renderer.Root, { baseUrl: ctx.baseUrl, servers: ctx.servers, children: [operations?.map((item) => {
+                const pathItem = document.paths?.[item.path];
+                if (!pathItem)
+                    return null;
+                const operation = pathItem[item.method];
+                if (!operation)
+                    return null;
+                const method = createMethod(item.method, pathItem, operation);
+                return (_jsx(Operation, { method: method, path: item.path, ctx: ctx, hasHead: hasHead }, `${item.path}:${item.method}`));
+            }), webhooks?.map((item) => {
+                const webhook = document.webhooks?.[item.name];
+                if (!webhook)
+                    return;
+                const hook = webhook[item.method];
+                if (!hook)
+                    return;
+                const method = createMethod(item.method, webhook, hook);
+                return (_jsx(Operation, { type: "webhook", method: method, ctx: {
+                        ...ctx,
+                        baseUrl: 'http://localhost:8080',
+                    }, path: `/${item.name}`, hasHead: hasHead }, `${item.name}:${item.method}`));
+            })] }));
+}
+export async function getContext(schema, options = {}) {
+    const document = schema.document;
+    const servers = document.servers && document.servers.length > 0
+        ? document.servers
+        : [{ url: 'https://example.com' }];
+    const server = servers[0];
+    return {
+        schema,
+        proxyUrl: options.proxyUrl,
+        showResponseSchema: options.showResponseSchema,
+        renderer: {
+            ...createRenders(options.shikiOptions),
+            ...options.renderer,
+        },
+        shikiOptions: options.shikiOptions,
+        generateTypeScriptSchema: options.generateTypeScriptSchema,
+        generateCodeSamples: options.generateCodeSamples,
+        baseUrl: getUrl(server.url, server.variables
+            ? Object.fromEntries(Object.entries(server.variables).map(([k, v]) => [k, v.default]))
+            : {}),
+        servers,
+        slugger: new Slugger(),
+    };
+}

package/dist/server/create-method.d.ts

@@ -0,0 +1,7 @@
+import type { MethodInformation, OperationObject, PathItemObject } from '../types.js';
+import type { NoReference } from '../utils/schema.js';
+/**
+ * Summarize method endpoint information
+ */
+export declare function createMethod(method: string, path: NoReference<PathItemObject>, operation: NoReference<OperationObject>): MethodInformation;
+//# sourceMappingURL=create-method.d.ts.map

package/dist/server/create-method.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-method.d.ts","sourceRoot":"","sources":["../../src/server/create-method.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,cAAc,EACf,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD;;GAEG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC,EACjC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,GACtC,iBAAiB,CAQnB"}

package/dist/server/create-method.js

@@ -0,0 +1,12 @@
+/**
+ * Summarize method endpoint information
+ */
+export function createMethod(method, path, operation) {
+    return {
+        description: path.description,
+        summary: path.summary,
+        ...operation,
+        parameters: [...(operation.parameters ?? []), ...(path.parameters ?? [])],
+        method: method.toUpperCase(),
+    };
+}

package/dist/server/create.d.ts

@@ -0,0 +1,16 @@
+import { type FC } from 'react';
+import { type ApiPageProps } from '../server/api-page.js';
+import type { DocumentInput } from '../utils/process-document.js';
+import { createProxy } from '../server/proxy.js';
+export interface OpenAPIOptions extends Omit<Partial<ApiPageProps>, 'document'> {
+    /**
+     * @deprecated Pass document to `APIPage` instead
+     */
+    documentOrPath?: DocumentInput;
+}
+export interface OpenAPIServer {
+    APIPage: FC<ApiPageProps>;
+    createProxy: typeof createProxy;
+}
+export declare function createOpenAPI(options?: OpenAPIOptions): OpenAPIServer;
+//# sourceMappingURL=create.d.ts.map

package/dist/server/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/server/create.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAW,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,WAAW,cACf,SAAQ,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC;IAC/C;;OAEG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC;IAC1B,WAAW,EAAE,OAAO,WAAW,CAAC;CACjC;AAED,wBAAgB,aAAa,CAAC,OAAO,GAAE,cAAmB,GAAG,aAAa,CAOzE"}

package/dist/server/create.js

@@ -0,0 +1,11 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { APIPage } from '../server/api-page.js';
+import { createProxy } from '../server/proxy.js';
+export function createOpenAPI(options = {}) {
+    return {
+        createProxy,
+        APIPage(props) {
+            return _jsx(APIPage, { ...options, ...props });
+        },
+    };
+}

package/dist/server/index.d.ts

@@ -1,221 +1,3 @@
-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 { NextRequest } from 'next/server';
-import { BuildPageTreeOptions } from 'fumadocs-core/source';
-
-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;
-
-interface ResponsesProps {
-    items: string[];
-    children: ReactNode;
-}
-interface ResponseProps {
-    value: string;
-    children: ReactNode;
-}
-interface APIInfoProps {
-    method: string;
-    route: string;
-    head: ReactNode;
-    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;
-    servers: ServerObject[];
-    children: ReactNode;
-}
-interface Renderer {
-    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: ComponentType<ObjectCollapsibleProps>;
-    Property: ComponentType<PropertyProps>;
-    APIPlayground: ComponentType<{
-        path: string;
-        method: MethodInformation;
-        ctx: RenderContext;
-    }>;
-}
-
-/**
- * Sample info of endpoint
- */
-interface EndpointSample {
-    /**
-     * Request URL, including path and query parameters
-     */
-    url: string;
-    method: string;
-    body?: {
-        schema: ParsedSchema;
-        mediaType: string;
-        sample: unknown;
-    };
-    responses: Record<string, ResponseSample>;
-    parameters: ParameterSample[];
-}
-interface ResponseSample {
-    mediaType: string;
-    sample: unknown;
-    schema: ParsedSchema;
-}
-interface ParameterSample {
-    name: string;
-    in: string;
-    schema: ParsedSchema;
-    sample: unknown;
-}
-
-interface CodeSample {
-    lang: string;
-    label: string;
-    source: string | ((endpoint: EndpointSample) => string | undefined) | false;
-}
-
-type DocumentInput = string | OpenAPIV3_1.Document | OpenAPIV3.Document;
-type ProcessedDocument = {
-    document: NoReference<Document>;
-    dereferenceMap: DereferenceMap;
-    downloaded: Document;
-};
-
-type Document = OpenAPIV3_1.Document;
-type OperationObject = OpenAPIV3_1.OperationObject;
-type ReferenceObject = OpenAPIV3_1.ReferenceObject;
-type ServerObject = NoReference<OpenAPIV3_1.ServerObject>;
-type MethodInformation = NoReference<OperationObject> & {
-    method: string;
-};
-type Awaitable<T> = T | Promise<T>;
-/**
- * Dereferenced value and its original `$ref` value
- */
-type DereferenceMap = Map<unknown, string>;
-interface RenderContext {
-    /**
-     * The url of proxy to avoid CORS issues
-     */
-    proxyUrl?: string;
-    renderer: Renderer;
-    baseUrl: string;
-    servers: ServerObject[];
-    slugger: Slugger;
-    /**
-     * dereferenced schema
-     */
-    schema: ProcessedDocument;
-    /**
-     * Generate TypeScript definitions from response schema.
-     *
-     * Pass `false` to disable it.
-     *
-     * @param endpoint - the API endpoint
-     * @param code - status code
-     */
-    generateTypeScriptSchema?: ((endpoint: EndpointSample, code: string) => Awaitable<string>) | false;
-    /**
-     * Generate code samples for endpoint.
-     */
-    generateCodeSamples?: (endpoint: EndpointSample) => Awaitable<CodeSample[]>;
-    shikiOptions?: Omit<CodeToHastOptionsCommon, 'lang'> & CodeOptionsThemes<BuiltinTheme>;
-    /**
-     * Show full response schema instead of only example response & Typescript definitions
-     */
-    showResponseSchema?: boolean;
-}
-
-type ApiPageContextProps = Pick<Partial<RenderContext>, 'shikiOptions' | 'generateTypeScriptSchema' | 'generateCodeSamples' | 'proxyUrl' | 'showResponseSchema'>;
-interface ApiPageProps extends ApiPageContextProps {
-    document: DocumentInput;
-    hasHead: boolean;
-    renderer?: Partial<Renderer>;
-    /**
-     * An array of operations
-     */
-    operations?: OperationItem[];
-    webhooks?: WebhookItem[];
-    /**
-     * By default, it is disabled on dev mode
-     */
-    disableCache?: boolean;
-}
-interface WebhookItem {
-    name: string;
-    method: OpenAPIV3_1.HttpMethods;
-}
-interface OperationItem {
-    path: string;
-    method: OpenAPIV3_1.HttpMethods;
-}
-
-declare const keys: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD"];
-type Proxy = {
-    [K in (typeof keys)[number]]: (req: NextRequest) => Promise<Response>;
-};
-declare function createProxy(allowedUrls?: string[]): Proxy;
-
-interface OpenAPIOptions extends Omit<Partial<ApiPageProps>, 'document'> {
-    /**
-     * @deprecated Pass document to `APIPage` instead
-     */
-    documentOrPath?: DocumentInput;
-}
-interface OpenAPIServer {
-    APIPage: FC<ApiPageProps>;
-    createProxy: typeof createProxy;
-}
-declare function createOpenAPI(options?: OpenAPIOptions): OpenAPIServer;
-
-/**
- * Source API Integration
- *
- * Add this to page tree builder options
- */
-declare const attachFile: BuildPageTreeOptions['attachFile'];
-
-export { type OpenAPIOptions, type OpenAPIServer, attachFile, createOpenAPI };
+export * from './create.js';
+export * from './source-api.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/server/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}