docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

package/lib-next/theme/ApiDemoPanel/Accept/slice.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import { createSlice } from "@reduxjs/toolkit";
 const initialState = {};
 export const slice = createSlice({

package/lib-next/theme/ApiDemoPanel/Authorization/auth-types.js

@@ -4,23 +4,26 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 export function getAuthDataKeys(security) {
   // Bearer Auth
   if (security.type === "http" && security.scheme === "bearer") {
     return ["token"];
   }
-
   if (security.type === "oauth2") {
     return ["token"];
-  } // Basic Auth
+  }
 
+  // Basic Auth
   if (security.type === "http" && security.scheme === "basic") {
     return ["username", "password"];
-  } // API Auth
+  }
 
+  // API Auth
   if (security.type === "apiKey") {
     return ["apiKey"];
-  } // none
+  }
 
+  // none
   return [];
 }

package/lib-next/theme/ApiDemoPanel/Authorization/index.js

@@ -4,23 +4,21 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React from "react";
 import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import FormItem from "../FormItem";
 import FormSelect from "../FormSelect";
 import FormTextInput from "../FormTextInput";
 import { setAuthData, setSelectedAuth } from "./slice";
-
 function Authorization() {
   const data = useTypedSelector((state) => state.auth.data);
   const options = useTypedSelector((state) => state.auth.options);
   const selected = useTypedSelector((state) => state.auth.selected);
   const dispatch = useTypedDispatch();
-
   if (selected === undefined) {
     return null;
   }
-
   const selectedAuth = options[selected];
   const optionKeys = Object.keys(options);
   return (
@@ -57,7 +55,6 @@ function Authorization() {
             </FormItem>
           );
         }
-
         if (a.type === "oauth2") {
           return (
             <FormItem label="Bearer Token" key={a.key + "-oauth2"}>
@@ -78,7 +75,6 @@ function Authorization() {
             </FormItem>
           );
         }
-
         if (a.type === "http" && a.scheme === "basic") {
           return (
             <React.Fragment key={a.key + "-basic"}>
@@ -118,7 +114,6 @@ function Authorization() {
             </React.Fragment>
           );
         }
-
         if (a.type === "apiKey") {
           return (
             <FormItem label={`${a.key}`} key={a.key + "-apikey"}>
@@ -139,11 +134,9 @@ function Authorization() {
             </FormItem>
           );
         }
-
         return null;
       })}
     </div>
   );
 }
-
 export default Authorization;

package/lib-next/theme/ApiDemoPanel/Authorization/slice.js

@@ -4,18 +4,23 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import { createSlice } from "@reduxjs/toolkit";
 import { createStorage, hashArray } from "../storage-utils";
-import { getAuthDataKeys } from "./auth-types"; // The global definitions
+import { getAuthDataKeys } from "./auth-types";
+
+// The global definitions
 // "securitySchemes": {
 //   "BearerAuth": { "type": "http", "scheme": "BeAreR" },
 //   "BasicAuth": { "type": "http", "scheme": "basic" }
 // },
+
 // The operation level requirements
 // "security": [
 //   { "BearerAuth": [] },
 //   { "BearerAuth": [], "BasicAuth": [] }
 // ],
+
 // SLICE_STATE
 // data:
 //   BearerAuth:
@@ -29,6 +34,7 @@ import { getAuthDataKeys } from "./auth-types"; // The global definitions
 //    "BearerAuth and BasicAuth": [{ key: "BearerAuth", scopes: [], ...rest }, { key: "BasicAuth", scopes: [], ...rest }]
 //
 // selected: "BearerAuth and BasicAuth"
+
 // LOCAL_STORAGE
 // hash(SLICE_STATE.options) -> "BearerAuth and BasicAuth"
 // BearerAuth                -> { token: xxx }
@@ -38,45 +44,37 @@ export function createAuth({ security, securitySchemes, options: opts }) {
   const storage = createStorage("sessionStorage");
   let data = {};
   let options = {};
-
   for (const option of security ?? []) {
     const id = Object.keys(option).join(" and ");
-
     for (const [schemeID, scopes] of Object.entries(option)) {
       const scheme = securitySchemes?.[schemeID];
-
       if (scheme) {
         if (options[id] === undefined) {
           options[id] = [];
         }
-
         const dataKeys = getAuthDataKeys(scheme);
-
         for (const key of dataKeys) {
           if (data[schemeID] === undefined) {
             data[schemeID] = {};
           }
-
           let persisted = undefined;
-
           try {
             persisted = JSON.parse(storage.getItem(schemeID) ?? "")[key];
           } catch {}
-
           data[schemeID][key] = persisted;
         }
-
-        options[id].push({ ...scheme, key: schemeID, scopes });
+        options[id].push({
+          ...scheme,
+          key: schemeID,
+          scopes,
+        });
       }
     }
   }
-
   let persisted = undefined;
-
   try {
     persisted = storage.getItem(hashArray(Object.keys(options))) ?? undefined;
   } catch {}
-
   return {
     data,
     options,

package/lib-next/theme/ApiDemoPanel/Body/index.js

@@ -4,19 +4,20 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React from "react";
 import TabItem from "@theme/TabItem";
 import format from "xml-formatter";
-import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks"; // @ts-ignore
-
+import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
+// @ts-ignore
 import SchemaTabs from "../../SchemaTabs";
 import ContentType from "../ContentType";
 import FormSelect from "../FormSelect";
 import LiveApp from "../LiveEditor";
 import FormFileUpload from "./../FormFileUpload";
 import FormItem from "./../FormItem";
-import FormTextInput from "./../FormTextInput"; // @ts-ignore
-
+import FormTextInput from "./../FormTextInput";
+// @ts-ignore
 import json2xml from "./json2xml";
 import {
   clearFormBodyKey,
@@ -25,16 +26,16 @@ import {
   setFileRawBody,
   setStringFormBody,
 } from "./slice";
-
 function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample }) {
-  const contentType = useTypedSelector((state) => state.contentType.value); // NOTE: We used to check if body was required, but opted to always show the request body
+  const contentType = useTypedSelector((state) => state.contentType.value);
+
+  // NOTE: We used to check if body was required, but opted to always show the request body
   // to reduce confusion, see: https://github.com/cloud-annotations/docusaurus-openapi/issues/145
-  // No body
 
+  // No body
   if (contentType === undefined) {
     return null;
   }
-
   return (
     <>
       <ContentType />
@@ -45,11 +46,12 @@ function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample }) {
     </>
   );
 }
-
 function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
   const contentType = useTypedSelector((state) => state.contentType.value);
   const required = requestBodyMetadata?.required;
-  const dispatch = useTypedDispatch(); // Lot's of possible content-types:
+  const dispatch = useTypedDispatch();
+
+  // Lot's of possible content-types:
   // - application/json
   // - application/xml
   // - text/plain
@@ -60,10 +62,12 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
   // - multipart/form-data
   // - application/x-www-form-urlencoded
   // - image/svg+xml;charset=US-ASCII
+
   // Show editor:
   // - application/json
   // - application/xml
   // - */*
+
   // Show form:
   // - multipart/form-data
   // - application/x-www-form-urlencoded
@@ -71,7 +75,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
   const schema = requestBodyMetadata?.content?.[contentType]?.schema;
   const example = requestBodyMetadata?.content?.[contentType]?.example;
   const examples = requestBodyMetadata?.content?.[contentType]?.examples;
-
   if (schema?.format === "binary") {
     return (
       <FormItem label="Body" required={required}>
@@ -82,7 +85,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
               dispatch(clearRawBody());
               return;
             }
-
             dispatch(
               setFileRawBody({
                 src: `/path/to/${file.name}`,
@@ -94,7 +96,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
       </FormItem>
     );
   }
-
   if (
     (contentType === "multipart/form-data" ||
       contentType === "application/x-www-form-urlencoded") &&
@@ -128,7 +129,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
                         dispatch(clearFormBodyKey(key));
                         return;
                       }
-
                       dispatch(
                         setFileFormBody({
                           key: key,
@@ -143,7 +143,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
                 </FormItem>
               );
             }
-
             if (val.enum) {
               return (
                 <FormItem
@@ -158,7 +157,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
                     options={["---", ...val.enum]}
                     onChange={(e) => {
                       const val = e.target.value;
-
                       if (val === "---") {
                         dispatch(clearFormBodyKey(key));
                       } else {
@@ -173,8 +171,8 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
                   />
                 </FormItem>
               );
-            } // TODO: support all the other types.
-
+            }
+            // TODO: support all the other types.
             return (
               <FormItem
                 key={key}
@@ -202,22 +200,17 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
       </FormItem>
     );
   }
-
   let language = "plaintext";
   let defaultBody = ""; //"body content";
-
   let exampleBody;
   let examplesBodies = [];
-
   if (contentType === "application/json" || contentType.endsWith("+json")) {
     if (jsonRequestBodyExample) {
       defaultBody = JSON.stringify(jsonRequestBodyExample, null, 2);
     }
-
     if (example) {
       exampleBody = JSON.stringify(example, null, 2);
     }
-
     if (examples) {
       for (const [key, example] of Object.entries(examples)) {
         examplesBodies.push({
@@ -227,10 +220,8 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
         });
       }
     }
-
     language = "json";
   }
-
   if (contentType === "application/xml" || contentType.endsWith("+xml")) {
     if (jsonRequestBodyExample) {
       try {
@@ -243,7 +234,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
         defaultBody = json2xml(jsonRequestBodyExample);
       }
     }
-
     if (example) {
       try {
         exampleBody = format(json2xml(example, ""), {
@@ -255,11 +245,9 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
         exampleBody = json2xml(example);
       }
     }
-
     if (examples) {
       for (const [key, example] of Object.entries(examples)) {
         let formattedXmlBody;
-
         try {
           formattedXmlBody = format(example.value, {
             indentation: "  ",
@@ -269,7 +257,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
         } catch {
           formattedXmlBody = example.value;
         }
-
         examplesBodies.push({
           label: key,
           body: formattedXmlBody,
@@ -277,10 +264,8 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
         });
       }
     }
-
     language = "xml";
   }
-
   if (exampleBody) {
     return (
       <FormItem label="Body" required={required}>
@@ -301,7 +286,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
       </FormItem>
     );
   }
-
   if (examplesBodies && examplesBodies.length > 0) {
     return (
       <FormItem label="Body" required={required}>
@@ -331,7 +315,6 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
       </FormItem>
     );
   }
-
   return (
     <FormItem label="Body" required={required}>
       <LiveApp action={dispatch} language={language}>
@@ -340,5 +323,4 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
     </FormItem>
   );
 }
-
 export default BodyWrap;

package/lib-next/theme/ApiDemoPanel/Body/slice.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import { createSlice } from "@reduxjs/toolkit";
 const initialState = {};
 export const slice = createSlice({
@@ -50,7 +51,6 @@ export const slice = createSlice({
           },
         };
       }
-
       state.content[action.payload.key] = {
         type: "string",
         value: action.payload.value,
@@ -69,7 +69,6 @@ export const slice = createSlice({
           },
         };
       }
-
       state.content[action.payload.key] = {
         type: "file",
         value: action.payload.value,

package/lib-next/theme/ApiDemoPanel/CodeTabs/index.js

@@ -4,23 +4,23 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React, { useState, cloneElement, isValidElement } from "react";
 import { duplicates } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import clsx from "clsx";
 import { languageSet } from "../Curl";
 import styles from "./styles.module.css";
-
 const {
   useScrollPositionBlocker,
   useTabGroupChoice,
-} = require("@docusaurus/theme-common/internal"); // A very rough duck type, but good enough to guard against mistakes while
-// allowing customization
+} = require("@docusaurus/theme-common/internal");
 
+// A very rough duck type, but good enough to guard against mistakes while
+// allowing customization
 function isTabItem(comp) {
   return "value" in comp.props;
 }
-
 function TabsComponent(props) {
   const {
     lazy,
@@ -34,9 +34,9 @@ function TabsComponent(props) {
   const children = React.Children.map(props.children, (child) => {
     if (isValidElement(child) && isTabItem(child)) {
       return child;
-    } // child.type.name will give non-sensical values in prod because of
+    }
+    // child.type.name will give non-sensical values in prod because of
     // minification, but we assume it won't throw in prod.
-
     throw new Error(
       `Docusaurus error: Bad <Tabs> child <${
         // @ts-expect-error: guarding against unexpected cases
@@ -45,29 +45,28 @@ function TabsComponent(props) {
     );
   });
   const values =
-    valuesProp ?? // Only pick keys that we recognize. MDX would inject some keys by default
+    valuesProp ??
+    // Only pick keys that we recognize. MDX would inject some keys by default
     children.map(({ props: { value, label, attributes } }) => ({
       value,
       label,
       attributes,
     }));
   const dup = duplicates(values, (a, b) => a.value === b.value);
-
   if (dup.length > 0) {
     throw new Error(
       `Docusaurus error: Duplicate values "${dup
         .map((a) => a.value)
         .join(", ")}" found in <Tabs>. Every value needs to be unique.`
     );
-  } // When defaultValueProp is null, don't show a default tab
-
+  }
+  // When defaultValueProp is null, don't show a default tab
   const defaultValue =
     defaultValueProp === null
       ? defaultValueProp
       : defaultValueProp ??
         children.find((child) => child.props.default)?.props.value ??
         children[0].props.value;
-
   if (defaultValue !== null && !values.some((a) => a.value === defaultValue)) {
     throw new Error(
       `Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values
@@ -77,16 +76,13 @@ function TabsComponent(props) {
         )}. If you intend to show no default tab, use defaultValue={null} instead.`
     );
   }
-
   const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoice();
   const [selectedValue, setSelectedValue] = useState(defaultValue);
   const tabRefs = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
-
   if (groupId != null) {
     const relevantTabGroupChoice = tabGroupChoices[groupId];
-
     if (
       relevantTabGroupChoice != null &&
       relevantTabGroupChoice !== selectedValue &&
@@ -95,52 +91,42 @@ function TabsComponent(props) {
       setSelectedValue(relevantTabGroupChoice);
     }
   }
-
   const handleTabChange = (event) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
     const newTabValue = values[newTabIndex].value;
-
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
       setSelectedValue(newTabValue);
-
       if (action) {
         const newLanguage = languageSet.filter(
           (lang) => lang.language === newTabValue
         );
         action(newLanguage[0]);
       }
-
       if (groupId != null) {
         setTabGroupChoices(groupId, String(newTabValue));
       }
     }
   };
-
   const handleKeydown = (event) => {
     let focusElement = null;
-
     switch (event.key) {
       case "ArrowRight": {
         const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
         focusElement = tabRefs[nextTab] ?? tabRefs[0];
         break;
       }
-
       case "ArrowLeft": {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
         focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
         break;
       }
-
       default:
         break;
     }
-
     focusElement?.focus();
   };
-
   return (
     <div className={clsx("tabs-container", styles.tabList)}>
       <ul
@@ -202,11 +188,11 @@ function TabsComponent(props) {
     </div>
   );
 }
-
 export default function CodeTabs(props) {
   const isBrowser = useIsBrowser();
   return (
-    <TabsComponent // Remount tabs after hydration
+    <TabsComponent
+      // Remount tabs after hydration
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}

package/lib-next/theme/ApiDemoPanel/ContentType/index.js

@@ -4,21 +4,19 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React from "react";
 import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import FormItem from "./../FormItem";
 import FormSelect from "./../FormSelect";
 import { setContentType } from "./slice";
-
 function ContentType() {
   const value = useTypedSelector((state) => state.contentType.value);
   const options = useTypedSelector((state) => state.contentType.options);
   const dispatch = useTypedDispatch();
-
   if (options.length <= 1) {
     return null;
   }
-
   return (
     <FormItem label="Content-Type">
       <FormSelect
@@ -29,5 +27,4 @@ function ContentType() {
     </FormItem>
   );
 }
-
 export default ContentType;

package/lib-next/theme/ApiDemoPanel/ContentType/slice.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import { createSlice } from "@reduxjs/toolkit";
 const initialState = {};
 export const slice = createSlice({