@gitbook/react-openapi 1.3.6 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @gitbook/react-openapi
 
+## 1.4.0
+
+### Minor Changes
+
+- 12c9d76: Adapt OpenAPI blocks to eval adaptive exprs & prefill TryIt config
+
+### Patch Changes
+
+- 4927e96: Add support for YAML content type in request body/example
+- 61b8507: OpenAPI: Make responses without objects clickable
+- 98e42cf: Handle OpenAPI ignored responses
+- Updated dependencies [12c9d76]
+- Updated dependencies [7fefe49]
+- Updated dependencies [360aa1c]
+  - @gitbook/openapi-parser@3.0.2
+
 ## 1.3.6
 
 ### Patch Changes

package/dist/InteractiveSection.jsx

@@ -42,7 +42,7 @@ export function InteractiveSection(props) {
                     <div className={clsx('openapi-section-header-controls', "".concat(className, "-header-controls"))} onClick={function (event) {
                 event.stopPropagation();
             }}>
-                        {tabs.length > 1 ? (<OpenAPISelect stateKey={stateKey} items={tabs} onSelectionChange={function () {
+                        {tabs.length > 0 ? (<OpenAPISelect stateKey={stateKey} items={tabs} onSelectionChange={function () {
                     state.expand();
                 }} icon={selectIcon} placement="bottom end">
                                 {tabs.map(function (tab) { return (<OpenAPISelectItem key={tab.key} id={tab.key} value={tab}>

package/dist/OpenAPICodeSample.jsx

@@ -45,11 +45,14 @@ export function OpenAPICodeSample(props) {
  * Generate code samples for the operation.
  */
 function generateCodeSamples(props) {
-    var _a, _b;
+    var _a;
     var data = props.data, context = props.context;
     var searchParams = new URLSearchParams();
     var headersObject = {};
-    (_a = data.operation.parameters) === null || _a === void 0 ? void 0 : _a.forEach(function (param) {
+    // The parser can sometimes returns invalid parameters (an object instead of an array).
+    // It should get fixed in scalar, but in the meantime we just ignore the parameters in that case.
+    var params = Array.isArray(data.operation.parameters) ? data.operation.parameters : [];
+    params.forEach(function (param) {
         if (!param) {
             return;
         }
@@ -78,7 +81,7 @@ function generateCodeSamples(props) {
         data.path +
         (searchParams.size ? "?".concat(searchParams.toString()) : '');
     var genericHeaders = __assign(__assign({}, getSecurityHeaders(data.securities)), headersObject);
-    var mediaTypeRendererFactories = Object.entries((_b = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content) !== null && _b !== void 0 ? _b : {}).map(function (_a) {
+    var mediaTypeRendererFactories = Object.entries((_a = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
         var mediaType = _a[0], mediaTypeObject = _a[1];
         return function (generator) {
             var mediaTypeHeaders = __assign(__assign({}, genericHeaders), { 'Content-Type': mediaType });
@@ -138,7 +141,7 @@ function generateCodeSamples(props) {
 }
 function OpenAPICodeSampleFooter(props) {
     var data = props.data, context = props.context, renderers = props.renderers;
-    var method = data.method, path = data.path;
+    var method = data.method, path = data.path, securities = data.securities, servers = data.servers;
     var specUrl = context.specUrl;
     var hideTryItPanel = data['x-hideTryItPanel'] || data.operation['x-hideTryItPanel'];
     var hasMultipleMediaTypes = renderers.length > 1 || renderers.some(function (renderer) { return renderer.examples.length > 0; });
@@ -150,7 +153,7 @@ function OpenAPICodeSampleFooter(props) {
     }
     return (<div className="openapi-codesample-footer">
             {hasMultipleMediaTypes ? (<OpenAPIMediaTypeExamplesSelector method={data.method} path={data.path} renderers={renderers} selectIcon={context.icons.chevronDown} blockKey={context.blockKey}/>) : (<span />)}
-            {!hideTryItPanel && (<ScalarApiButton context={getOpenAPIClientContext(context)} method={method} path={path} specUrl={specUrl}/>)}
+            {!hideTryItPanel && (<ScalarApiButton context={getOpenAPIClientContext(context)} method={method} path={path} securities={securities} servers={servers} specUrl={specUrl}/>)}
         </div>);
 }
 /**

package/dist/OpenAPIPrefillContextProvider.d.ts

@@ -0,0 +1,22 @@
+import * as React from 'react';
+/**
+ * Prefill data that can be used to dynamically inject info into OpenAPI operation blocks.
+ *
+ * This is typically dynamic input context, such as visitor data or environment info.
+ */
+export type PrefillInputContextData = Record<string, unknown>;
+/**
+ * Context value is function that returns prefill data.
+ */
+type PrefillContextValue = () => PrefillInputContextData | null;
+/**
+ * Provide context to help prefill dynamic info like visitor data in OpenAPI blocks.
+ */
+export declare function OpenAPIPrefillContextProvider(props: React.PropsWithChildren<{
+    getPrefillInputContextData: () => PrefillInputContextData | null;
+}>): React.JSX.Element;
+/**
+ * Hook to access the prefill context function.
+ */
+export declare function useOpenAPIPrefillContext(): PrefillContextValue;
+export {};

package/dist/OpenAPIPrefillContextProvider.jsx

@@ -0,0 +1,19 @@
+'use client';
+import * as React from 'react';
+var OpenAPIPrefillContext = React.createContext(null);
+/**
+ * Provide context to help prefill dynamic info like visitor data in OpenAPI blocks.
+ */
+export function OpenAPIPrefillContextProvider(props) {
+    var getPrefillInputContextData = props.getPrefillInputContextData, children = props.children;
+    return (<OpenAPIPrefillContext.Provider value={getPrefillInputContextData}>
+            {children}
+        </OpenAPIPrefillContext.Provider>);
+}
+/**
+ * Hook to access the prefill context function.
+ */
+export function useOpenAPIPrefillContext() {
+    var _a;
+    return (_a = React.useContext(OpenAPIPrefillContext)) !== null && _a !== void 0 ? _a : (function () { return null; });
+}

package/dist/OpenAPIResponseExample.jsx

@@ -37,7 +37,10 @@ export function OpenAPIResponseExample(props) {
     var tabs = responses
         .filter(function (_a) {
         var _ = _a[0], responseObject = _a[1];
-        return responseObject && typeof responseObject === 'object';
+        return responseObject &&
+            typeof responseObject === 'object' &&
+            // Make sure the response is not hidden
+            !responseObject['x-hideSample'];
     })
         .map(function (_a) {
         var key = _a[0], responseObject = _a[1];

package/dist/OpenAPIResponses.jsx

@@ -34,6 +34,17 @@ export function OpenAPIResponses(props) {
                     },
                 ];
             }
+            if (!response.content) {
+                return [
+                    {
+                        key: 'default',
+                        label: '',
+                        body: (<pre className="openapi-example-empty">
+                                    <p>{t(context.translation, 'no_content')}</p>
+                                </pre>),
+                    },
+                ];
+            }
             return Object.entries((_a = response.content) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
                 var contentType = _a[0], mediaType = _a[1];
                 return ({

package/dist/OpenAPISpec.jsx

@@ -63,15 +63,18 @@ function getParameterGroupName(paramIn, context) {
 /** Deduplicate parameters by name and in.
  * Some specs have both parameters define at path and operation level.
  * We only want to display one of them.
+ * Parameters can have the wrong type (object instead of array) sometimes, we just return an empty array in that case.
  */
 function deduplicateParameters(parameters) {
     var seen = new Set();
-    return parameters.filter(function (param) {
-        var key = "".concat(param.name, ":").concat(param.in);
-        if (seen.has(key)) {
-            return false;
-        }
-        seen.add(key);
-        return true;
-    });
+    return Array.isArray(parameters)
+        ? parameters.filter(function (param) {
+            var key = "".concat(param.name, ":").concat(param.in);
+            if (seen.has(key)) {
+                return false;
+            }
+            seen.add(key);
+            return true;
+        })
+        : [];
 }

package/dist/ScalarApiButton.d.ts

@@ -1,11 +1,14 @@
 import type { OpenAPIV3_1 } from '@gitbook/openapi-parser';
 import type { OpenAPIClientContext } from './context';
+import type { OpenAPIOperationData } from './types';
 /**
  * Button which launches the Scalar API Client
  */
 export declare function ScalarApiButton(props: {
     method: OpenAPIV3_1.HttpMethods;
     path: string;
+    securities: OpenAPIOperationData['securities'];
+    servers: OpenAPIOperationData['servers'];
     specUrl: string;
     context: OpenAPIClientContext;
 }): import("react").JSX.Element;

package/dist/ScalarApiButton.jsx

@@ -1,14 +1,27 @@
 'use client';
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 import { ApiClientModalProvider, useApiClientModal } from '@scalar/api-client-react';
-import { useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
+import { Suspense, useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
 import { useOpenAPIOperationContext } from './OpenAPIOperationContext';
+import { useOpenAPIPrefillContext } from './OpenAPIPrefillContextProvider';
 import { t } from './translate';
+import { resolveTryItPrefillForOperation } from './util/tryit-prefill';
 /**
  * Button which launches the Scalar API Client
  */
 export function ScalarApiButton(props) {
-    var method = props.method, path = props.path, specUrl = props.specUrl, context = props.context;
+    var method = props.method, path = props.path, securities = props.securities, servers = props.servers, specUrl = props.specUrl, context = props.context;
     var _a = useState(false), isOpen = _a[0], setIsOpen = _a[1];
     var controllerRef = useRef(null);
     return (<div className="scalar scalar-activate">
@@ -24,12 +37,20 @@ export function ScalarApiButton(props) {
             </button>
 
             {isOpen &&
-            createPortal(<ScalarModal controllerRef={controllerRef} method={method} path={path} specUrl={specUrl}/>, document.body)}
+            createPortal(<Suspense fallback={null}>
+                        <ScalarModal controllerRef={controllerRef} method={method} path={path} securities={securities} servers={servers} specUrl={specUrl}/>
+                    </Suspense>, document.body)}
         </div>);
 }
 function ScalarModal(props) {
-    var method = props.method, path = props.path, specUrl = props.specUrl, controllerRef = props.controllerRef;
-    return (<ApiClientModalProvider configuration={{ url: specUrl }} initialRequest={{ method: method, path: path }}>
+    var method = props.method, path = props.path, securities = props.securities, servers = props.servers, specUrl = props.specUrl, controllerRef = props.controllerRef;
+    var getPrefillInputContextData = useOpenAPIPrefillContext();
+    var prefillInputContext = getPrefillInputContextData();
+    var prefillConfig = resolveTryItPrefillForOperation({
+        operation: { securities: securities, servers: servers },
+        prefillInputContext: prefillInputContext,
+    });
+    return (<ApiClientModalProvider configuration={__assign({ url: specUrl }, prefillConfig)} initialRequest={{ method: method, path: path }}>
             <ScalarModalController method={method} path={path} controllerRef={controllerRef}/>
         </ApiClientModalProvider>);
 }
@@ -41,7 +62,11 @@ function ScalarModalController(props) {
     var openClient = useMemo(function () {
         if (openScalarClient) {
             return function () {
-                openScalarClient({ method: method, path: path, _source: 'gitbook' });
+                openScalarClient({
+                    method: method,
+                    path: path,
+                    _source: 'gitbook',
+                });
                 trackClientOpening({ method: method, path: path });
             };
         }

package/dist/code-samples.js

@@ -9,7 +9,8 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-import { isCSV, isFormData, isFormUrlEncoded, isGraphQL, isJSON, isPDF, isPlainObject, isText, isXML, } from './contentTypeChecks';
+import yaml from 'js-yaml';
+import { isCSV, isFormData, isFormUrlEncoded, isGraphQL, isJSON, isPDF, isPlainObject, isText, isXML, isYAML, } from './contentTypeChecks';
 import { json2xml } from './json2xml';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 export var codeSampleGenerators = [
@@ -117,7 +118,8 @@ export var codeSampleGenerators = [
         syntax: 'python',
         generate: function (_a) {
             var method = _a.method, url = _a.url, headers = _a.headers, body = _a.body;
-            var code = 'import requests\n\n';
+            var contentType = headers === null || headers === void 0 ? void 0 : headers['Content-Type'];
+            var code = "".concat(isJSON(contentType) ? 'import json\n' : '', "import requests\n\n");
             if (body) {
                 var lines = BodyGenerators.getPythonBody(body, headers);
                 // add the generated code to the top
@@ -132,7 +134,6 @@ export var codeSampleGenerators = [
             if (headers && Object.keys(headers).length > 0) {
                 code += indent("headers=".concat(stringifyOpenAPI(headers), ",\n"), 4);
             }
-            var contentType = headers === null || headers === void 0 ? void 0 : headers['Content-Type'];
             if (body) {
                 if (body === 'files') {
                     code += indent("files=".concat(body, "\n"), 4);
@@ -223,6 +224,9 @@ var BodyGenerators = {
             // We use --data-binary to avoid cURL converting newlines to \r\n
             body = "--data-binary '@".concat(String(body), "'");
         }
+        else if (isYAML(contentType)) {
+            body = "--data-binary $'".concat(yaml.dump(body).replace(/'/g, '').replace(/\\n/g, '\n'), "'");
+        }
         else {
             body = "--data '".concat(stringifyOpenAPI(body, null, 2).replace(/\\n/g, '\n'), "'");
         }
@@ -299,6 +303,10 @@ var BodyGenerators = {
             code += '`;\n\n';
             body = 'xml';
         }
+        else if (isYAML(contentType)) {
+            code += "const yamlBody = `\n".concat(indent(yaml.dump(body), 4), "`;\n\n");
+            body = 'yamlBody';
+        }
         else if (isText(contentType)) {
             body = stringifyOpenAPI(body, null, 2);
         }
@@ -333,6 +341,10 @@ var BodyGenerators = {
             // Convert JSON to XML if needed
             body = JSON.stringify(convertBodyToXML(body));
         }
+        else if (isYAML(contentType)) {
+            code += "yamlBody = \"\"\"\n".concat(indent(yaml.dump(body), 4), "\"\"\"\n\n");
+            body = 'yamlBody';
+        }
         else {
             body = stringifyOpenAPI(body, function (_key, value) {
                 switch (value) {
@@ -374,6 +386,7 @@ var BodyGenerators = {
                 // Convert JSON to XML if needed
                 return "\"".concat(convertBodyToXML(body), "\"");
             },
+            yaml: function () { return "\"".concat(yaml.dump(body).replace(/"/g, '\\"'), "\""); },
             csv: function () { return "\"".concat(stringifyOpenAPI(body).replace(/"/g, ''), "\""); },
             default: function () { return "".concat(stringifyOpenAPI(body, null, 2)); },
         };
@@ -385,6 +398,8 @@ var BodyGenerators = {
             return typeHandlers.text();
         if (isXML(contentType))
             return typeHandlers.xml();
+        if (isYAML(contentType))
+            return typeHandlers.yaml();
         if (isCSV(contentType))
             return typeHandlers.csv();
         return typeHandlers.default();

package/dist/contentTypeChecks.d.ts

@@ -1,5 +1,6 @@
 export declare function isJSON(contentType?: string): boolean;
 export declare function isXML(contentType?: string): boolean;
+export declare function isYAML(contentType?: string): boolean;
 export declare function isGraphQL(contentType?: string): boolean;
 export declare function isCSV(contentType?: string): boolean;
 export declare function isPDF(contentType?: string): boolean;

package/dist/contentTypeChecks.js

@@ -4,6 +4,9 @@ export function isJSON(contentType) {
 export function isXML(contentType) {
     return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/xml')) || false;
 }
+export function isYAML(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/yaml')) || false;
+}
 export function isGraphQL(contentType) {
     return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/graphql')) || false;
 }

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './schemas';
 export * from './OpenAPIOperation';
 export * from './OpenAPIWebhook';
 export * from './OpenAPIOperationContext';
+export * from './OpenAPIPrefillContextProvider';
 export * from './resolveOpenAPIOperation';
 export * from './resolveOpenAPIWebhook';
 export type { OpenAPIOperationData, OpenAPIWebhookData } from './types';

package/dist/index.js

@@ -2,6 +2,7 @@ export * from './schemas';
 export * from './OpenAPIOperation';
 export * from './OpenAPIWebhook';
 export * from './OpenAPIOperationContext';
+export * from './OpenAPIPrefillContextProvider';
 export * from './resolveOpenAPIOperation';
 export * from './resolveOpenAPIWebhook';
 export { checkIsValidLocale } from './translations';