docusaurus-theme-openapi-docs 0.0.0-618 → 0.0.0-684

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

@@ -1,272 +0,0 @@
-/* ============================================================================
- * 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 DiscriminatorTabsComponent(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 resizeObserver = new ResizeObserver((entries) => {
-      for (let entry of entries) {
-        if (entry.target.offsetWidth < entry.target.scrollWidth) {
-          setShowTabArrows(true);
-        } else {
-          setShowTabArrows(false);
-        }
-      }
-    });
-
-    resizeObserver.observe(tabItemListContainerRef.current);
-
-    return () => {
-      resizeObserver.disconnect();
-    };
-  }, []);
-
-  const handleRightClick = () => {
-    tabItemListContainerRef.current.scrollLeft += 90;
-  };
-
-  const handleLeftClick = () => {
-    tabItemListContainerRef.current.scrollLeft -= 90;
-  };
-
-  return (
-    <div className={clsx("tabs__container", "discriminatorTabs")}>
-      <div className={styles.discriminatorTabsTopSection}>
-        <div className={clsx(styles.discriminatorTabsContainer)}>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowLeft)}
-              onClick={handleLeftClick}
-            />
-          )}
-          <ul
-            ref={tabItemListContainerRef}
-            role="tablist"
-            aria-orientation="horizontal"
-            className={clsx(
-              styles.discriminatorTabsListContainer,
-              "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.discriminatorTabActive]: selectedValue === value,
-                    }
-                  )}
-                >
-                  <span className={styles.discriminatorTabLabel}>
-                    {label ?? value}
-                  </span>
-                </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.discriminatorTabsContainer
-            ),
-          }
-        )
-      ) : (
-        <div
-          className={clsx("margin-vert--md", styles.discriminatorTabsContainer)}
-        >
-          {children.map((tabItem, i) =>
-            cloneElement(tabItem, {
-              key: i,
-              hidden: tabItem.props.value !== selectedValue,
-            })
-          )}
-        </div>
-      )}
-    </div>
-  );
-}
-
-export default function DiscriminatorTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <DiscriminatorTabsComponent // Remount tabs after hydration
-      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
-      key={String(isBrowser)}
-      {...props}
-    />
-  );
-}

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

@@ -1,119 +0,0 @@
-/**
- * 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: 1.8rem;
-  margin-top: 0 !important;
-  margin-right: 0.5rem;
-  border: 1px solid var(--ifm-color-primary);
-  border-radius: var(--ifm-global-radius);
-  color: var(--ifm-color-primary);
-  font-size: 12px;
-}
-
-.tabItem:not(.discriminatorTabActive) {
-  opacity: 0.65;
-}
-
-.tabItem:hover {
-  opacity: 1;
-  background-color: var(--ifm-color-emphasis-100);
-}
-
-.tabItem:last-child {
-  margin-right: 0 !important;
-}
-
-/* Open API Schema Tabs */
-.discriminatorTabs {
-  margin-left: -20px !important;
-}
-
-.discriminatorTabsTopSection {
-  margin-top: 1rem;
-  margin-left: 1rem;
-  display: flex;
-  justify-content: space-between;
-  align-items: center;
-}
-
-.discriminatorTabsTopSection + hr {
-  display: none;
-}
-
-.discriminatorTabsContainer {
-  display: flex;
-  align-items: center;
-  max-width: 390px;
-  padding-left: 3px;
-  overflow: hidden;
-}
-
-.discriminatorTabsListContainer {
-  padding: 0 0.25rem;
-  overflow-y: hidden;
-  overflow-x: scroll;
-  scroll-behavior: smooth;
-}
-
-.discriminatorTabsListContainer::-webkit-scrollbar {
-  display: none;
-}
-
-.tabItem.discriminatorTabActive {
-  background-color: var(--ifm-color-emphasis-100);
-}
-
-.discriminatorTabLabel {
-  white-space: nowrap;
-}
-
-.discriminatorTabsContainer {
-  max-width: 600px;
-}
-
-/* Tab Arrows */
-.tabArrow {
-  content: "";
-  height: 1.25rem;
-  width: 1.25rem;
-  padding: 0 0.75rem;
-  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) {
-  .discriminatorTabsTopSection {
-    flex-direction: column;
-    align-items: flex-start;
-  }
-
-  .discriminatorTabsContainer {
-    width: 100%;
-  }
-
-  .tabItem {
-    height: 100%;
-  }
-}

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

@@ -1,295 +0,0 @@
-/* ============================================================================
- * 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 { setAccept } from "@theme/ApiDemoPanel/Accept/slice";
-import { setContentType } from "@theme/ApiDemoPanel/ContentType/slice";
-import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
-import clsx from "clsx";
-
-import styles from "./styles.module.css";
-
-const {
-  useScrollPositionBlocker,
-  useTabGroupChoice,
-} = require("@docusaurus/theme-common/internal");
-
-function isTabItem(comp) {
-  return typeof comp.props.value !== "undefined";
-}
-
-function MimeTabsComponent(props) {
-  const {
-    lazy,
-    block,
-    defaultValue: defaultValueProp,
-    values: valuesProp,
-    groupId,
-    className,
-    schemaType,
-  } = 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 dispatch = useTypedDispatch();
-  const isRequestSchema = schemaType?.toLowerCase() === "request";
-
-  const handleTabChange = (event) => {
-    event.preventDefault();
-    const newTab = event.currentTarget;
-    const newTabIndex = tabRefs.indexOf(newTab);
-    const newTabValue = values[newTabIndex].value;
-
-    if (newTabValue !== selectedValue) {
-      if (isRequestSchema) {
-        dispatch(setContentType(newTabValue));
-      } else {
-        dispatch(setAccept(newTabValue));
-      }
-
-      blockElementScrollPositionUntilNextRender(newTab);
-      setSelectedValue(newTabValue);
-
-      if (groupId != null) {
-        setTabGroupChoices(groupId, newTabValue);
-      }
-    }
-  };
-
-  const contentTypeVal = useTypedSelector((state) => state.contentType.value);
-  const acceptTypeVal = useTypedSelector((state) => state.accept.value);
-
-  useEffect(() => {
-    if (tabRefs.length > 1) {
-      if (isRequestSchema) {
-        setSelectedValue(contentTypeVal);
-      } else {
-        setSelectedValue(acceptTypeVal);
-      }
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [contentTypeVal, acceptTypeVal]);
-
-  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 resizeObserver = new ResizeObserver((entries) => {
-      for (let entry of entries) {
-        if (entry.target.offsetWidth < entry.target.scrollWidth) {
-          setShowTabArrows(true);
-        } else {
-          setShowTabArrows(false);
-        }
-      }
-    });
-
-    resizeObserver.observe(tabItemListContainerRef.current);
-
-    return () => {
-      resizeObserver.disconnect();
-    };
-  }, []);
-
-  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}
-            />
-          )}
-          <div
-            ref={tabItemListContainerRef}
-            role="tablist"
-            aria-orientation="horizontal"
-            className={clsx(
-              styles.mimeTabsListContainer,
-              "tabs",
-              {
-                "tabs--block": block,
-              },
-              className
-            )}
-          >
-            {values.map(({ value, label, attributes }) => {
-              return (
-                <div
-                  role="tab"
-                  tabIndex={selectedValue === value ? 0 : -1}
-                  aria-selected={selectedValue === value}
-                  key={value}
-                  ref={(tabControl) => tabRefs.push(tabControl)}
-                  onKeyDown={handleKeydown}
-                  onFocus={handleTabChange}
-                  onClick={(e) => handleTabChange(e)}
-                  {...attributes}
-                  className={clsx(
-                    "tabs__item",
-                    styles.tabItem,
-                    attributes?.className,
-                    {
-                      [styles.mimeTabActive]: selectedValue === value,
-                    }
-                  )}
-                >
-                  {/* <div
-                    className={clsx(styles.mimeTabDot, mimeTabDotStyle)}
-                  /> */}
-                  {label ?? value}
-                </div>
-              );
-            })}
-          </div>
-          {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}
-    />
-  );
-}