@gitbook/react-openapi 1.0.2 → 1.0.4

package/src/utils.ts

@@ -1,7 +1,7 @@
 import type { AnyObject, OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
 
 export function checkIsReference(
-    input: unknown,
+    input: unknown
 ): input is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject {
     return typeof input === 'object' && !!input && '$ref' in input;
 }
@@ -13,7 +13,11 @@ export function createStateKey(key: string, scope?: string) {
 /**
  * Resolve the description of an object.
  */
-export function resolveDescription(object: AnyObject) {
+export function resolveDescription(object: OpenAPIV3.SchemaObject | AnyObject) {
+    if ('items' in object && object.items) {
+        return resolveDescription(object.items);
+    }
+
     return 'x-gitbook-description-html' in object &&
         typeof object['x-gitbook-description-html'] === 'string'
         ? object['x-gitbook-description-html'].trim()
@@ -28,7 +32,7 @@ export function resolveDescription(object: AnyObject) {
 export function extractDescriptions(object: AnyObject) {
     return {
         description: object.description,
-        ['x-gitbook-description-html']:
+        'x-gitbook-description-html':
             'x-gitbook-description-html' in object
                 ? object['x-gitbook-description-html']
                 : undefined,
@@ -57,7 +61,7 @@ export function resolveFirstExample(object: AnyObject) {
  * Extract the description, example and deprecated from parameter.
  */
 export function resolveParameterSchema(
-    parameter: OpenAPIV3.ParameterBaseObject,
+    parameter: OpenAPIV3.ParameterBaseObject
 ): OpenAPIV3.SchemaObject {
     const schema = checkIsReference(parameter.schema) ? undefined : parameter.schema;
     return {
@@ -75,7 +79,7 @@ export function resolveParameterSchema(
  * Transform a parameter object to a property object.
  */
 export function parameterToProperty(
-    parameter: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject,
+    parameter: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject
 ): {
     propertyName: string | undefined;
     schema: OpenAPIV3.SchemaObject;

package/dist/OpenAPIServerURL.d.ts

@@ -1,11 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-/**
- * Show the url of the server with variables replaced by their default values.
- */
-export declare function OpenAPIServerURL(props: {
-    servers: OpenAPIV3.ServerObject[];
-}): import("react").JSX.Element | null;
-/**
- * Get the default URL for the server.
- */
-export declare function getServersURL(servers: OpenAPIV3.ServerObject[]): string;

package/dist/OpenAPIServerURL.jsx

@@ -1,67 +0,0 @@
-import { OpenAPIServerURLVariable } from './OpenAPIServerURLVariable';
-/**
- * Show the url of the server with variables replaced by their default values.
- */
-export function OpenAPIServerURL(props) {
-    var _a;
-    var servers = props.servers;
-    var server = servers[0];
-    if (!server) {
-        return null;
-    }
-    var parts = parseServerURL((_a = server === null || server === void 0 ? void 0 : server.url) !== null && _a !== void 0 ? _a : '');
-    return (<span>
-            {parts.map(function (part, i) {
-            var _a;
-            if (part.kind === 'text') {
-                return <span key={i}>{part.text}</span>;
-            }
-            else {
-                var variable = (_a = server.variables) === null || _a === void 0 ? void 0 : _a[part.name];
-                if (!variable) {
-                    return <span key={i}>{"{".concat(part.name, "}")}</span>;
-                }
-                return (<OpenAPIServerURLVariable key={i} name={part.name} variable={variable}/>);
-            }
-        })}
-        </span>);
-}
-/**
- * Get the default URL for the server.
- */
-export function getServersURL(servers) {
-    var _a;
-    var server = servers[0];
-    if (!server) {
-        return '';
-    }
-    var parts = parseServerURL((_a = server === null || server === void 0 ? void 0 : server.url) !== null && _a !== void 0 ? _a : '');
-    return parts
-        .map(function (part) {
-        var _a, _b, _c;
-        if (part.kind === 'text') {
-            return part.text;
-        }
-        else {
-            return (_c = (_b = (_a = server.variables) === null || _a === void 0 ? void 0 : _a[part.name]) === null || _b === void 0 ? void 0 : _b.default) !== null && _c !== void 0 ? _c : "{".concat(part.name, "}");
-        }
-    })
-        .join('');
-}
-function parseServerURL(url) {
-    var parts = url.split(/{([^}]+)}/g);
-    var result = [];
-    for (var i = 0; i < parts.length; i++) {
-        var part = parts[i];
-        if (!part) {
-            continue;
-        }
-        if (i % 2 === 0) {
-            result.push({ kind: 'text', text: part });
-        }
-        else {
-            result.push({ kind: 'variable', name: part });
-        }
-    }
-    return result;
-}

package/dist/OpenAPIServerURLVariable.d.ts

@@ -1,8 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-/**
- * Interactive component to show the value of a server variable and let the user change it.
- */
-export declare function OpenAPIServerURLVariable(props: {
-    name: string;
-    variable: OpenAPIV3.ServerVariableObject;
-}): import("react").JSX.Element;

package/dist/OpenAPIServerURLVariable.jsx

@@ -1,8 +0,0 @@
-'use client';
-/**
- * Interactive component to show the value of a server variable and let the user change it.
- */
-export function OpenAPIServerURLVariable(props) {
-    var variable = props.variable;
-    return <span className="openapi-url-var">{variable.default}</span>;
-}

package/src/OpenAPIServerURL.tsx

@@ -1,73 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-import { OpenAPIServerURLVariable } from './OpenAPIServerURLVariable';
-
-/**
- * Show the url of the server with variables replaced by their default values.
- */
-export function OpenAPIServerURL(props: { servers: OpenAPIV3.ServerObject[] }) {
-    const { servers } = props;
-    const server = servers[0];
-
-    if (!server) {
-        return null;
-    }
-
-    const parts = parseServerURL(server?.url ?? '');
-
-    return (
-        <span>
-            {parts.map((part, i) => {
-                if (part.kind === 'text') {
-                    return <span key={i}>{part.text}</span>;
-                } else {
-                    const variable = server.variables?.[part.name];
-                    if (!variable) {
-                        return <span key={i}>{`{${part.name}}`}</span>;
-                    }
-
-                    return (
-                        <OpenAPIServerURLVariable key={i} name={part.name} variable={variable} />
-                    );
-                }
-            })}
-        </span>
-    );
-}
-
-/**
- * Get the default URL for the server.
- */
-export function getServersURL(servers: OpenAPIV3.ServerObject[]): string {
-    const server = servers[0];
-    if (!server) {
-        return '';
-    }
-    const parts = parseServerURL(server?.url ?? '');
-
-    return parts
-        .map((part) => {
-            if (part.kind === 'text') {
-                return part.text;
-            } else {
-                return server.variables?.[part.name]?.default ?? `{${part.name}}`;
-            }
-        })
-        .join('');
-}
-
-function parseServerURL(url: string) {
-    const parts = url.split(/{([^}]+)}/g);
-    const result: Array<{ kind: 'variable'; name: string } | { kind: 'text'; text: string }> = [];
-    for (let i = 0; i < parts.length; i++) {
-        const part = parts[i];
-        if (!part) {
-            continue;
-        }
-        if (i % 2 === 0) {
-            result.push({ kind: 'text', text: part });
-        } else {
-            result.push({ kind: 'variable', name: part });
-        }
-    }
-    return result;
-}

package/src/OpenAPIServerURLVariable.tsx

@@ -1,14 +0,0 @@
-'use client';
-
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-
-/**
- * Interactive component to show the value of a server variable and let the user change it.
- */
-export function OpenAPIServerURLVariable(props: {
-    name: string;
-    variable: OpenAPIV3.ServerVariableObject;
-}) {
-    const { variable } = props;
-    return <span className="openapi-url-var">{variable.default}</span>;
-}