@gitbook/react-openapi 1.0.1 → 1.0.3

package/src/utils.ts

@@ -1,6 +1,8 @@
-import type { AnyObject, OpenAPIV3 } from '@gitbook/openapi-parser';
+import type { AnyObject, OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
 
-export function checkIsReference(input: unknown): input is OpenAPIV3.ReferenceObject {
+export function checkIsReference(
+    input: unknown,
+): input is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject {
     return typeof input === 'object' && !!input && '$ref' in input;
 }
 
@@ -11,10 +13,88 @@ export function createStateKey(key: string, scope?: string) {
 /**
  * Resolve the description of an object.
  */
-export function resolveDescription(object: AnyObject) {
-    return 'x-description-html' in object && typeof object['x-description-html'] === 'string'
-        ? object['x-description-html']
+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()
         : typeof object.description === 'string'
-          ? object.description
+          ? object.description.trim()
           : undefined;
 }
+
+/**
+ * Extract descriptions from an object.
+ */
+export function extractDescriptions(object: AnyObject) {
+    return {
+        description: object.description,
+        ['x-gitbook-description-html']:
+            'x-gitbook-description-html' in object
+                ? object['x-gitbook-description-html']
+                : undefined,
+    };
+}
+
+/**
+ * Resolve the first example from an object.
+ */
+export function resolveFirstExample(object: AnyObject) {
+    if ('examples' in object && typeof object.examples === 'object' && object.examples) {
+        const keys = Object.keys(object.examples);
+        const firstKey = keys[0];
+        if (firstKey && object.examples[firstKey]) {
+            return object.examples[firstKey];
+        }
+    }
+    if ('example' in object && object.example !== undefined) {
+        return object.example;
+    }
+    return undefined;
+}
+
+/**
+ * Resolve the schema of a parameter.
+ * Extract the description, example and deprecated from parameter.
+ */
+export function resolveParameterSchema(
+    parameter: OpenAPIV3.ParameterBaseObject,
+): OpenAPIV3.SchemaObject {
+    const schema = checkIsReference(parameter.schema) ? undefined : parameter.schema;
+    return {
+        // Description of the parameter is defined at the parameter level
+        // we use display it if the schema doesn't override it
+        ...extractDescriptions(parameter),
+        example: resolveFirstExample(parameter),
+        // Deprecated can be defined at the parameter level
+        deprecated: parameter.deprecated,
+        ...schema,
+    };
+}
+
+/**
+ * Transform a parameter object to a property object.
+ */
+export function parameterToProperty(
+    parameter: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject,
+): {
+    propertyName: string | undefined;
+    schema: OpenAPIV3.SchemaObject;
+    required: boolean | undefined;
+} {
+    if (checkIsReference(parameter)) {
+        return {
+            propertyName: parameter.$ref ?? 'Unknown ref',
+            schema: {},
+            required: undefined,
+        };
+    }
+    return {
+        propertyName: parameter.name,
+        schema: resolveParameterSchema(parameter),
+        required: parameter.required,
+    };
+}

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/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>;
-}