docusaurus-theme-openapi-docs 1.1.4 → 1.1.7

package/lib-next/theme/MimeTabs/index.js

@@ -0,0 +1,260 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React, {
+  Children,
+  cloneElement,
+  isValidElement,
+  useEffect,
+  useRef,
+  useState,
+} from "react";
+
+import { duplicates } from "@docusaurus/theme-common";
+import useIsBrowser from "@docusaurus/useIsBrowser";
+import clsx from "clsx";
+
+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 MimeTabsComponent(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);
+  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;
+
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      setSelectedValue(newTabValue);
+
+      if (groupId != null) {
+        setTabGroupChoices(groupId, 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();
+  };
+
+  const tabItemListContainerRef = useRef(null);
+  const [showTabArrows, setShowTabArrows] = useState(false);
+
+  useEffect(() => {
+    const tabOffsetWidth = tabItemListContainerRef.current.offsetWidth;
+    const tabScrollWidth = tabItemListContainerRef.current.scrollWidth;
+
+    if (tabOffsetWidth < tabScrollWidth) {
+      setShowTabArrows(true);
+    }
+  }, []);
+
+  const handleRightClick = () => {
+    tabItemListContainerRef.current.scrollLeft += 90;
+  };
+
+  const handleLeftClick = () => {
+    tabItemListContainerRef.current.scrollLeft -= 90;
+  };
+
+  return (
+    <div className="tabs__container">
+      <div className={styles.mimeTabsTopSection}>
+        {/* <strong>MIME Type</strong> */}
+        <div className={styles.mimeTabsContainer}>
+          {showTabArrows && (
+            <button
+              className={clsx(styles.tabArrow, styles.tabArrowLeft)}
+              onClick={handleLeftClick}
+            />
+          )}
+          <ul
+            ref={tabItemListContainerRef}
+            role="tablist"
+            aria-orientation="horizontal"
+            className={clsx(
+              styles.mimeTabsListContainer,
+              "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.mimeTabActive]: selectedValue === value,
+                    }
+                  )}
+                >
+                  {/* <div
+                    className={clsx(styles.mimeTabDot, mimeTabDotStyle)}
+                  /> */}
+                  {label ?? value}
+                </li>
+              );
+            })}
+          </ul>
+          {showTabArrows && (
+            <button
+              className={clsx(styles.tabArrow, styles.tabArrowRight)}
+              onClick={handleRightClick}
+            />
+          )}
+        </div>
+      </div>
+      {/* <hr /> */}
+      {lazy ? (
+        cloneElement(
+          children.filter(
+            (tabItem) => tabItem.props.value === selectedValue
+          )[0],
+          {
+            className: clsx("margin-vert--md", styles.mimeSchemaContainer),
+          }
+        )
+      ) : (
+        <div className={clsx("margin-vert--md", styles.mimeSchemaContainer)}>
+          {children.map((tabItem, i) =>
+            cloneElement(tabItem, {
+              key: i,
+              hidden: tabItem.props.value !== selectedValue,
+            })
+          )}
+        </div>
+      )}
+    </div>
+  );
+}
+
+export default function MimeTabs(props) {
+  const isBrowser = useIsBrowser();
+  return (
+    <MimeTabsComponent // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key={String(isBrowser)}
+      {...props}
+    />
+  );
+}

package/lib-next/theme/MimeTabs/styles.module.css

@@ -0,0 +1,125 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.tabItem {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  height: 2rem;
+  margin-top: 0 !important;
+  margin-right: 0.5rem;
+  /* border: 1px solid var(--openapi-code-dim-dark);
+  border-radius: 0; */
+  font-weight: var(--ifm-font-weight-normal);
+  /* color: var(--openapi-code-dim-dark); */
+  font-size: 12px;
+}
+
+.tabItem:active {
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+/* .tabItem:hover {
+  color: var(--ifm-color-emphasis-500) !important;
+} */
+
+.tabItem:last-child {
+  margin-right: 0 !important;
+}
+
+/* Open API Response Code Tabs */
+.mimeTabsTopSection {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.mimeTabsContainer {
+  display: flex;
+  align-items: center;
+  max-width: 390px;
+  /* padding-left: 1rem; */
+  overflow: hidden;
+}
+
+.mimeTabsListContainer {
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+}
+
+.mimeTabsListContainer::-webkit-scrollbar {
+  display: none;
+}
+
+/* Response Code Tabs - Colored Dots */
+.mimeTabDot {
+  width: 12.5px;
+  height: 12.5px;
+  margin-right: 5px;
+  border-radius: 50%;
+}
+
+.mimeTabDotSuccess {
+  background-color: var(--ifm-color-success);
+}
+
+.mimeTabDotDanger {
+  background-color: var(--ifm-color-danger);
+}
+
+.mimeTabDotInfo {
+  background-color: var(--ifm-color-info);
+}
+
+.mimeTabActive {
+  border-bottom-color: var(--ifm-tabs-color-active-border);
+  border-bottom-left-radius: 0;
+  border-bottom-right-radius: 0;
+  color: var(--ifm-tabs-color-active);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.mimeSchemaContainer {
+  max-width: 600px;
+}
+
+/* Tab Arrows */
+.tabArrow {
+  content: "";
+  height: 1.25rem;
+  width: 1.25rem;
+  border: none;
+  min-width: 1.25rem;
+  background: var(--ifm-menu-link-sublist-icon) 50% / 2rem 2rem;
+  filter: var(--ifm-menu-link-sublist-icon-filter);
+}
+
+.tabArrow:hover {
+  cursor: pointer;
+}
+
+.tabArrowLeft {
+  transform: rotate(270deg);
+}
+
+.tabArrowRight {
+  transform: rotate(90deg);
+}
+
+@media screen and (max-width: 500px) {
+  .mimeTabsTopSection {
+    flex-direction: column;
+    align-items: flex-start;
+  }
+
+  .mimeTabsContainer {
+    width: 100%;
+    margin-top: var(--ifm-spacing-vertical);
+    padding: 0;
+  }
+}

package/lib-next/theme/ParamsItem/index.js

@@ -7,6 +7,7 @@
 
 import React from "react";
 
+import CodeBlock from "@theme/CodeBlock";
 import ReactMarkdown from "react-markdown";
 
 import { createDescription } from "../../markdown/createDescription";
@@ -33,7 +34,21 @@ function ParamsItem({
 
   const renderDescription = guard(description, (description) => (
     <div>
-      <ReactMarkdown children={createDescription(description)} />
+      <ReactMarkdown
+        children={createDescription(description)}
+        components={{
+          pre: "div",
+          code({ node, inline, className, children, ...props }) {
+            const match = /language-(\w+)/.exec(className || "");
+            if (inline) return <code>{children}</code>;
+            return !inline && match ? (
+              <CodeBlock className={className}>{children}</CodeBlock>
+            ) : (
+              <CodeBlock>{children}</CodeBlock>
+            );
+          },
+        }}
+      />
     </div>
   ));
 

package/lib-next/theme/SchemaItem/index.js

@@ -7,6 +7,7 @@
 
 import React from "react";
 
+import CodeBlock from "@theme/CodeBlock";
 import ReactMarkdown from "react-markdown";
 
 import { createDescription } from "../../markdown/createDescription";
@@ -23,13 +24,28 @@ function SchemaItem({
   schemaName,
   defaultValue,
 }) {
-  const renderRequired = guard(required, () => (
-    <strong className={styles.required}> required</strong>
-  ));
+  const renderRequired = guard(
+    Array.isArray(required) ? required.includes(name) : required,
+    () => <strong className={styles.required}> required</strong>
+  );
 
   const renderSchemaDescription = guard(schemaDescription, (description) => (
-    <div className={styles.schemaDescription}>
-      <ReactMarkdown children={createDescription(description)} />
+    <div>
+      <ReactMarkdown
+        children={createDescription(description)}
+        components={{
+          pre: "div",
+          code({ node, inline, className, children, ...props }) {
+            const match = /language-(\w+)/.exec(className || "");
+            if (inline) return <code>{children}</code>;
+            return !inline && match ? (
+              <CodeBlock className={className}>{children}</CodeBlock>
+            ) : (
+              <CodeBlock>{children}</CodeBlock>
+            );
+          },
+        }}
+      />
     </div>
   ));
 
@@ -39,11 +55,14 @@ function SchemaItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(defaultValue, (value) => (
-    <div className={styles.schemaQualifierMessage}>
-      <ReactMarkdown children={`**Default value:** \`${value}\``} />
-    </div>
-  ));
+  const renderDefaultValue = guard(
+    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
+    (value) => (
+      <div className={styles.schemaQualifierMessage}>
+        <ReactMarkdown children={`**Default value:** \`${value}\``} />
+      </div>
+    )
+  );
 
   const schemaContent = (
     <div>

package/lib-next/theme/SchemaTabs/styles.module.css

@@ -39,7 +39,7 @@
 }
 
 .schemaTabsListContainer {
-  padding: 0 0.25rem;
+  /* padding: 0 0.25rem; */
   overflow-y: hidden;
   overflow-x: scroll;
   scroll-behavior: smooth;
@@ -95,8 +95,4 @@
   .schemaTabsContainer {
     width: 100%;
   }
-
-  .tabItem {
-    height: 100%;
-  }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "1.1.4",
+  "version": "1.1.7",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -50,7 +50,7 @@
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "^1.1.4",
+    "docusaurus-plugin-openapi-docs": "^1.1.6",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "process": "^0.11.10",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "dadb0aa5d3516b3020ff1d94288efd6f136e02ba"
+  "gitHead": "604cd3723c770fd306318d594e8fb4e68c39724c"
 }

package/src/markdown/utils.ts

@@ -24,9 +24,6 @@ export function guard<T>(
   value: T | undefined | string,
   cb: (value: T) => Children
 ): string {
-  if (typeof value === "boolean") {
-    value = value.toString();
-  }
   if (value) {
     const children = cb(value as T);
     return render(children);

package/src/theme/ApiDemoPanel/Body/index.tsx

@@ -188,7 +188,7 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }: Props) {
   let language = "plaintext";
   let exampleBodyString = ""; //"body content";
 
-  if (contentType === "application/json") {
+  if (contentType === "application/json" || contentType.endsWith("+json")) {
     if (jsonRequestBodyExample) {
       exampleBodyString = JSON.stringify(jsonRequestBodyExample, null, 2);
     }

package/src/theme/ApiItem/Layout/styles.module.css

@@ -175,6 +175,7 @@
 
 :global(.code__tab--python.tabs__item--active) {
   border-bottom-color: var(--ifm-color-success);
+  background-color: var(--ifm-color-emphasis-100);
 }
 
 :global(.language-python) {
@@ -198,6 +199,7 @@
 
 :global(.code__tab--go.tabs__item--active) {
   border-bottom-color: var(--ifm-color-info);
+  background-color: var(--ifm-color-emphasis-100);
 }
 
 :global(.language-go) {
@@ -221,6 +223,7 @@
 
 :global(.code__tab--javascript.tabs__item--active) {
   border-bottom-color: var(--ifm-color-warning);
+  background-color: var(--ifm-color-emphasis-100);
 }
 
 :global(.language-javascript) {
@@ -244,6 +247,7 @@
 
 :global(.code__tab--bash.tabs__item--active) {
   border-bottom-color: var(--ifm-color-danger);
+  background-color: var(--ifm-color-emphasis-100);
 }
 
 :global(.language-bash) {