docusaurus-theme-openapi-docs 1.6.0 → 2.0.0-beta.0

package/lib/theme/SchemaTabs/index.js

@@ -5,141 +5,49 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, {
-  Children,
-  cloneElement,
-  isValidElement,
-  useEffect,
-  useRef,
-  useState,
-} from "react";
+import React, { cloneElement, useRef, useEffect, useState } from "react";
 
-import { duplicates } from "@docusaurus/theme-common";
+import {
+  useScrollPositionBlocker,
+  useTabs,
+} from "@docusaurus/theme-common/internal";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import clsx from "clsx";
+import flatten from "lodash/flatten";
 
-import styles from "./styles.module.css"; // A very rough duck type, but good enough to guard against mistakes while
-
-const {
-  useScrollPositionBlocker,
-  useTabGroupChoice,
-} = require("@docusaurus/theme-common/internal");
-
-// allowing customization
-
-function isTabItem(comp) {
-  return typeof comp.props.value !== "undefined";
-}
-
-function SchemaTabsComponent(props) {
-  const {
-    lazy,
-    block,
-    defaultValue: defaultValueProp,
-    values: valuesProp,
-    groupId,
-    className,
-  } = props;
-  const children = Children.map(props.children, (child) => {
-    if (isValidElement(child) && isTabItem(child)) {
-      return child;
-    } // 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
-        typeof child.type === "string" ? child.type : child.type.name
-      }>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`
-    );
-  });
-  const values =
-    valuesProp ?? // We 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
-
-  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
-        .map((a) => a.value)
-        .join(
-          ", "
-        )}. If you intend to show no default tab, use defaultValue={null} instead.`
-    );
-  }
-
-  const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoice();
-  const [selectedValue, setSelectedValue] = useState(defaultValue);
+function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   const tabRefs = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
-
-  if (groupId != null) {
-    const relevantTabGroupChoice = tabGroupChoices[groupId];
-
-    if (
-      relevantTabGroupChoice != null &&
-      relevantTabGroupChoice !== selectedValue &&
-      values.some((value) => value.value === relevantTabGroupChoice)
-    ) {
-      setSelectedValue(relevantTabGroupChoice);
-    }
-  }
-
   const handleTabChange = (event) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
-    const newTabValue = values[newTabIndex].value;
-
+    const newTabValue = tabValues[newTabIndex].value;
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
-      setSelectedValue(newTabValue);
-
-      if (groupId != null) {
-        setTabGroupChoices(groupId, newTabValue);
-      }
+      selectValue(newTabValue);
     }
   };
-
   const handleKeydown = (event) => {
     let focusElement = null;
-
     switch (event.key) {
+      case "Enter": {
+        handleTabChange(event);
+        break;
+      }
       case "ArrowRight": {
         const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
-        focusElement = tabRefs[nextTab] || tabRefs[0];
+        focusElement = tabRefs[nextTab] ?? tabRefs[0];
         break;
       }
-
       case "ArrowLeft": {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1];
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
         break;
       }
-
       default:
         break;
     }
-
     focusElement?.focus();
   };
 
@@ -174,94 +82,102 @@ function SchemaTabsComponent(props) {
 
   return (
     <div className="tabs__container">
-      <div className={styles.schemaTabsTopSection}>
-        <div className={styles.schemaTabsContainer}>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowLeft)}
-              onClick={handleLeftClick}
-            />
-          )}
-          <ul
-            ref={tabItemListContainerRef}
-            role="tablist"
-            aria-orientation="horizontal"
-            className={clsx(
-              styles.schemaTabsListContainer,
-              "tabs",
-              {
-                "tabs--block": block,
-              },
-              className
-            )}
-          >
-            {values.map(({ value, label, attributes }) => {
-              return (
-                <li
-                  role="tab"
-                  tabIndex={selectedValue === value ? 0 : -1}
-                  aria-selected={selectedValue === value}
-                  key={value}
-                  ref={(tabControl) => tabRefs.push(tabControl)}
-                  onKeyDown={handleKeydown}
-                  onFocus={handleTabChange}
-                  onClick={handleTabChange}
-                  {...attributes}
-                  className={clsx(
-                    "tabs__item",
-                    styles.tabItem,
-                    attributes?.className,
-                    {
-                      [styles.schemaTabActive]: selectedValue === value,
-                    }
-                  )}
-                >
-                  <span className={styles.schemaTabLabel}>
-                    {label ?? value}
-                  </span>
-                </li>
-              );
-            })}
-          </ul>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowRight)}
-              onClick={handleRightClick}
-            />
+      <div className="openapi-tabs__schema-container">
+        {showTabArrows && (
+          <button
+            className="openapi-tabs__arrow left"
+            onClick={handleLeftClick}
+          />
+        )}
+        <ul
+          ref={tabItemListContainerRef}
+          role="tablist"
+          aria-orientation="horizontal"
+          className={clsx(
+            "openapi-tabs__schema-list-container",
+            "tabs",
+            {
+              "tabs--block": block,
+            },
+            className
           )}
-        </div>
+        >
+          {tabValues.map(({ value, label, attributes }) => (
+            <li
+              // TODO extract TabListItem
+              role="tab"
+              tabIndex={selectedValue === value ? 0 : -1}
+              aria-selected={selectedValue === value}
+              key={value}
+              ref={(tabControl) => tabRefs.push(tabControl)}
+              onKeyDown={handleKeydown}
+              onClick={handleTabChange}
+              {...attributes}
+              className={clsx(
+                "tabs__item",
+                "openapi-tabs__schema-item",
+                attributes?.className,
+                {
+                  active: selectedValue === value,
+                }
+              )}
+            >
+              <span className="openapi-tabs__schema-label">
+                {label ?? value}
+              </span>
+            </li>
+          ))}
+        </ul>
+        {showTabArrows && (
+          <button
+            className="openapi-tabs__arrow right"
+            onClick={handleRightClick}
+          />
+        )}
       </div>
-      <hr />
-      {lazy ? (
-        cloneElement(
-          children.filter(
-            (tabItem) => tabItem.props.value === selectedValue
-          )[0] ?? // TODO: see if there's a better way to handle this
-            children.filter(
-              (tabItem) => tabItem.props.value === defaultValue
-            )[0],
-          {
-            className: styles.marginVertical,
-          }
-        )
-      ) : (
-        <div className={styles.marginVertical}>
-          {children.map((tabItem, i) =>
-            cloneElement(tabItem, {
-              key: i,
-              hidden: tabItem.props.value !== selectedValue,
-            })
-          )}
-        </div>
+    </div>
+  );
+}
+function TabContent({ lazy, children, selectedValue }) {
+  // eslint-disable-next-line no-param-reassign
+  children = Array.isArray(children) ? children : [children];
+  const flattenedChildren = flatten(children);
+
+  if (lazy) {
+    const selectedTabItem = flattenedChildren.find(
+      (tabItem) => tabItem.props.value === selectedValue
+    );
+    if (!selectedTabItem) {
+      // fail-safe or fail-fast? not sure what's best here
+      return null;
+    }
+    return cloneElement(selectedTabItem, { className: "margin-top--md" });
+  }
+  return (
+    <div className="margin-top--md">
+      {children.map((tabItem, i) =>
+        cloneElement(tabItem, {
+          key: i,
+          hidden: tabItem.props.value !== selectedValue,
+        })
       )}
     </div>
   );
 }
-
+function TabsComponent(props) {
+  const tabs = useTabs(props);
+  return (
+    <div className="tabs-container">
+      <TabList {...props} {...tabs} />
+      <TabContent {...props} {...tabs} />
+    </div>
+  );
+}
 export default function SchemaTabs(props) {
   const isBrowser = useIsBrowser();
   return (
-    <SchemaTabsComponent // 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/theme/styles.scss

@@ -0,0 +1,117 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+/* API Demo Panel */
+@use "./ApiDemoPanel/CodeTabs/CodeTabs";
+@use "./ApiDemoPanel/FloatingButton/FloatingButton";
+@use "./ApiDemoPanel/FormFileUpload/FormFileUpload";
+@use "./ApiDemoPanel/FormItem/FormItem";
+@use "./ApiDemoPanel/FormMultiSelect/FormMultiSelect";
+@use "./ApiDemoPanel/FormSelect/FormSelect";
+@use "./ApiDemoPanel/FormTextInput/FormTextInput";
+@use "./ApiDemoPanel/LiveEditor/LiveEditor";
+@use "./ApiDemoPanel/MethodEndpoint/MethodEndpoint";
+@use "./ApiDemoPanel/ParamOptions/ParamOptions";
+@use "./ApiDemoPanel/Request/Request";
+@use "./ApiDemoPanel/Response/Response";
+@use "./ApiDemoPanel/Server/Server";
+/* Schema Styling */
+@use "./ParamsItem/ParamsItem";
+@use "./SchemaItem/SchemaItem";
+/* Tabs Styling */
+@use "./ApiTabs/ApiTabs";
+@use "./DiscriminatorTabs/DiscriminatorTabs";
+@use "./MimeTabs/MimeTabs";
+@use "./SchemaTabs/SchemaTabs";
+/* Code Samples */
+@use "./ResponseSamples/ResponseSamples";
+/* Markdown Styling */
+@use "./Markdown/Details/Details";
+
+:root {
+  --openapi-required: var(--ifm-color-danger);
+  --openapi-deprecated: var(--ifm-color-warning);
+  --openapi-nullable: var(--ifm-color-info);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
+  --openapi-card-background-color: var(--ifm-color-gray-100);
+  --openapi-card-border-radius: var(--ifm-pre-border-radius);
+  --openapi-input-border: var(--ifm-color-primary);
+  --openapi-input-background: var(--openapi-card-background-color);
+}
+
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+}
+
+.docs-wrapper {
+  height: 100%;
+}
+
+@media (min-width: 997px) {
+  .docItemCol {
+    max-width: 75% !important;
+  }
+
+  /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+  .tocMobile {
+    display: none;
+  }
+}
+
+/* Begin OpenAPI theme styles */
+// [data-theme="dark"] {
+//   --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+// }
+
+// .theme-api-markdown div[class^="collapsibleContent"] {
+//   margin-top: 0 !important;
+//   padding-left: 2px;
+// }
+
+/* Demo panel details */
+
+// .theme-api-markdown .openapi-demo__details > div > div > pre {
+//   border-top-left-radius: 0;
+//   border-top-right-radius: 0;
+// }
+
+/* Code block */
+
+// .theme-api-markdown code {
+//   max-width: 600px;
+//   max-height: 500px;
+//   overflow: auto;
+// }
+
+/* Version button */
+
+// .version-button div {
+//   display: block;
+// }
+
+// .version-button div > button > span::after {
+//   border-color: currentcolor transparent;
+//   border-style: solid;
+//   border-width: 0.4em 0.4em 0;
+//   content: "";
+//   margin-left: 0.3em;
+//   position: relative;
+//   transform: translateY(-50%);
+//   display: inline-block;
+//   font-size: 0.8rem;
+//   top: 1px;
+// }
+
+.openapi__logo {
+  width: 250px;
+}
+
+.openapi__heading {
+  font-size: var(--ifm-h1-font-size);
+}

package/lib/theme-openapi.d.ts

@@ -213,7 +213,7 @@ declare module "@theme/ApiDemoPanel/Response" {
 }
 
 declare module "@theme/ApiDemoPanel/Response/slice" {
-  export { setResponse };
+  export { setResponse, setCode, setHeaders, clearCode, clearHeaders };
   export default response as Reducer<State, AnyAction>;
 }
 

package/lib-next/index.js

@@ -11,7 +11,7 @@ export default function docusaurusThemeOpenAPI() {
   return {
     name: "docusaurus-theme-openapi",
     getClientModules() {
-      const modules = [require.resolve("./theme/styles.css")];
+      const modules = [require.resolve("./theme/styles.scss")];
       return modules;
     },
     getThemePath() {

package/lib-next/markdown/utils.js

@@ -14,7 +14,7 @@ export function create(tag, props) {
   return `<${tag}${propString}>${render(children)}</${tag}>`;
 }
 export function guard(value, cb) {
-  if (value !== undefined) {
+  if (!!value) {
     const children = cb(value);
     return render(children);
   }

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

@@ -267,12 +267,14 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
   if (exampleBody) {
     return (
       <FormItem label="Body" required={required}>
-        <SchemaTabs lazy>
+        <SchemaTabs className="openapi-tabs__schema" lazy>
+          {/* @ts-ignore */}
           <TabItem label="Default" value="default" default>
             <LiveApp action={dispatch} language={language}>
               {defaultBody}
             </LiveApp>
           </TabItem>
+          {/* @ts-ignore */}
           <TabItem label="Example" value="example">
             {exampleBody && (
               <LiveApp action={dispatch} language={language}>
@@ -287,7 +289,8 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
   if (examplesBodies && examplesBodies.length > 0) {
     return (
       <FormItem label="Body" required={required}>
-        <SchemaTabs lazy>
+        <SchemaTabs className="openapi-tabs__schema" lazy>
+          {/* @ts-ignore */}
           <TabItem label="Default" value="default" default>
             <LiveApp action={dispatch} language={language}>
               {defaultBody}
@@ -295,6 +298,7 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
           </TabItem>
           {examplesBodies.map((example) => {
             return (
+              // @ts-ignore
               <TabItem
                 label={example.label}
                 value={example.label}