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

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

@@ -1,155 +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 zlib from "zlib";
-import React from "react";
-import BrowserOnly from "@docusaurus/BrowserOnly";
-import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
-import { HtmlClassNameProvider } from "@docusaurus/theme-common";
-import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import { createAuth } from "@theme/ApiDemoPanel/Authorization/slice";
-import { createPersistanceMiddleware } from "@theme/ApiDemoPanel/persistanceMiddleware";
-import DocItemLayout from "@theme/ApiItem/Layout";
-import DocItemMetadata from "@theme/DocItem/Metadata";
-import clsx from "clsx";
-import { Provider } from "react-redux";
-import { createStoreWithoutState, createStoreWithState } from "./store";
-const { DocProvider } = require("@docusaurus/theme-common/internal");
-let ApiDemoPanel = (_) => <div />;
-if (ExecutionEnvironment.canUseDOM) {
-  ApiDemoPanel = require("@theme/ApiDemoPanel").default;
-}
-export default function ApiItem(props) {
-  const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
-  const MDXComponent = props.content;
-  const { frontMatter } = MDXComponent;
-  const { info_path: infoPath } = frontMatter;
-  let { api } = frontMatter;
-  // decompress and parse
-  if (api) {
-    api = JSON.parse(zlib.inflateSync(Buffer.from(api, "base64")).toString());
-  }
-  const { siteConfig } = useDocusaurusContext();
-  const themeConfig = siteConfig.themeConfig;
-  const options = themeConfig.api;
-  const isBrowser = useIsBrowser();
-
-  // Regex for 2XX status
-  const statusRegex = new RegExp("(20[0-9]|2[1-9][0-9])");
-
-  // Define store2
-  let store2 = {};
-  const persistanceMiddleware = createPersistanceMiddleware(options);
-
-  // Init store for SSR
-  if (!isBrowser) {
-    store2 = createStoreWithoutState({}, [persistanceMiddleware]);
-  }
-
-  // Init store for CSR to hydrate components
-  if (isBrowser) {
-    // Create list of only 2XX response content types to create request samples from
-    let acceptArray = [];
-    for (const [code, content] of Object.entries(api?.responses ?? [])) {
-      if (statusRegex.test(code)) {
-        acceptArray.push(Object.keys(content.content ?? {}));
-      }
-    }
-    acceptArray = acceptArray.flat();
-    const content = api?.requestBody?.content ?? {};
-    const contentTypeArray = Object.keys(content);
-    const servers = api?.servers ?? [];
-    const params = {
-      path: [],
-      query: [],
-      header: [],
-      cookie: [],
-    };
-    api?.parameters?.forEach((param) => {
-      const paramType = param.in;
-      const paramsArray = params[paramType];
-      paramsArray.push(param);
-    });
-    const auth = createAuth({
-      security: api?.security,
-      securitySchemes: api?.securitySchemes,
-      options,
-    });
-    // TODO: determine way to rehydrate without flashing
-    // const acceptValue = window?.sessionStorage.getItem("accept");
-    // const contentTypeValue = window?.sessionStorage.getItem("contentType");
-    const server = window?.sessionStorage.getItem("server");
-    const serverObject = JSON.parse(server) ?? {};
-    store2 = createStoreWithState(
-      {
-        accept: {
-          value: acceptArray[0],
-          options: acceptArray,
-        },
-        contentType: {
-          value: contentTypeArray[0],
-          options: contentTypeArray,
-        },
-        server: {
-          value: serverObject.url ? serverObject : undefined,
-          options: servers,
-        },
-        response: {
-          value: undefined,
-        },
-        body: {
-          type: "empty",
-        },
-        params,
-        auth,
-      },
-      [persistanceMiddleware]
-    );
-  }
-  if (api) {
-    return (
-      <DocProvider content={props.content}>
-        <HtmlClassNameProvider className={docHtmlClassName}>
-          <DocItemMetadata />
-          <DocItemLayout>
-            <Provider store={store2}>
-              <div className={clsx("row", "theme-api-markdown")}>
-                <div className="col col--7">
-                  <MDXComponent />
-                </div>
-                <div className="col col--5">
-                  <BrowserOnly fallback={<div>Loading...</div>}>
-                    {() => {
-                      return <ApiDemoPanel item={api} infoPath={infoPath} />;
-                    }}
-                  </BrowserOnly>
-                </div>
-              </div>
-            </Provider>
-          </DocItemLayout>
-        </HtmlClassNameProvider>
-      </DocProvider>
-    );
-  }
-
-  // Non-API docs
-  return (
-    <DocProvider content={props.content}>
-      <HtmlClassNameProvider className={docHtmlClassName}>
-        <DocItemMetadata />
-        <DocItemLayout>
-          <div className="row">
-            <div className="col col--12">
-              <MDXComponent />
-            </div>
-          </div>
-        </DocItemLayout>
-      </HtmlClassNameProvider>
-    </DocProvider>
-  );
-}

package/lib-next/theme/ApiItem/store.js

@@ -1,38 +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 { configureStore, combineReducers } from "@reduxjs/toolkit";
-import accept from "@theme/ApiDemoPanel/Accept/slice";
-import auth from "@theme/ApiDemoPanel/Authorization/slice";
-import body from "@theme/ApiDemoPanel/Body/slice";
-import contentType from "@theme/ApiDemoPanel/ContentType/slice";
-import params from "@theme/ApiDemoPanel/ParamOptions/slice";
-import response from "@theme/ApiDemoPanel/Response/slice";
-import server from "@theme/ApiDemoPanel/Server/slice";
-const rootReducer = combineReducers({
-  accept,
-  contentType,
-  response,
-  server,
-  body,
-  params,
-  auth,
-});
-export const createStoreWithState = (preloadedState, middlewares) =>
-  configureStore({
-    reducer: rootReducer,
-    preloadedState,
-    middleware: (getDefaultMiddleware) =>
-      getDefaultMiddleware().concat(...middlewares),
-  });
-export const createStoreWithoutState = (preloadedState, middlewares) =>
-  configureStore({
-    reducer: rootReducer,
-    preloadedState,
-    middleware: (getDefaultMiddleware) =>
-      getDefaultMiddleware().concat(...middlewares),
-  });

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

@@ -1,48 +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 from "react";
-import { useColorMode } from "@docusaurus/theme-common";
-import useBaseUrl from "@docusaurus/useBaseUrl";
-import ThemedImage from "@theme/ThemedImage";
-export default function ApiLogo(props) {
-  const { colorMode } = useColorMode();
-  const { logo, darkLogo } = props;
-  const altText = () => {
-    if (colorMode === "dark") {
-      return darkLogo?.altText ?? logo?.altText;
-    }
-    return logo?.altText;
-  };
-  const lightLogoUrl = useBaseUrl(logo?.url);
-  const darkLogoUrl = useBaseUrl(darkLogo?.url);
-  if (logo && darkLogo) {
-    return (
-      <ThemedImage
-        alt={altText()}
-        sources={{
-          light: lightLogoUrl,
-          dark: darkLogoUrl,
-        }}
-        className="openapi__logo"
-      />
-    );
-  }
-  if (logo || darkLogo) {
-    return (
-      <ThemedImage
-        alt={altText()}
-        sources={{
-          light: lightLogoUrl ?? darkLogoUrl,
-          dark: lightLogoUrl ?? darkLogoUrl,
-        }}
-        className="openapi__logo"
-      />
-    );
-  }
-  return undefined;
-}

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

@@ -1,277 +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 ApiTabsComponent(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="tabs__container">
-      <div className={styles.responseTabsTopSection}>
-        <strong>Responses</strong>
-        <div className={styles.responseTabsContainer}>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowLeft)}
-              onClick={handleLeftClick}
-            />
-          )}
-          <ul
-            ref={tabItemListContainerRef}
-            role="tablist"
-            aria-orientation="horizontal"
-            className={clsx(
-              styles.responseTabsListContainer,
-              "tabs",
-              {
-                "tabs--block": block,
-              },
-              className
-            )}
-          >
-            {values.map(({ value, label, attributes }) => {
-              const responseStatusStyle =
-                parseInt(value) >= 400
-                  ? styles.responseStatusDanger
-                  : parseInt(value) >= 200 && parseInt(value) < 300
-                  ? styles.responseStatusSuccess
-                  : styles.responseStatusInfo;
-
-              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,
-                    responseStatusStyle,
-                    {
-                      [styles.active]: selectedValue === value,
-                    }
-                  )}
-                >
-                  <div className={styles.responseTabDot} />
-                  {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.responseSchemaContainer),
-          }
-        )
-      ) : (
-        <div
-          className={clsx("margin-vert--md", styles.responseSchemaContainer)}
-        >
-          {children.map((tabItem, i) =>
-            cloneElement(tabItem, {
-              key: i,
-              hidden: tabItem.props.value !== selectedValue,
-            })
-          )}
-        </div>
-      )}
-    </div>
-  );
-}
-
-export default function ApiTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <ApiTabsComponent // Remount tabs after hydration
-      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
-      key={String(isBrowser)}
-      {...props}
-    />
-  );
-}

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

@@ -1,120 +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: 2.5rem;
-  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-weight: var(--ifm-font-weight-normal);
-}
-
-.tabItem:not(.active) {
-  opacity: 0.65;
-}
-
-.tabItem:hover {
-  opacity: 1;
-}
-
-.tabItem:last-child {
-  margin-right: 0 !important;
-}
-
-/* Open API Response Code Tabs */
-.responseTabsTopSection {
-  margin-top: 2rem;
-  display: flex;
-  justify-content: space-between;
-  align-items: center;
-}
-
-.responseTabsContainer {
-  display: flex;
-  align-items: center;
-  max-width: 390px;
-  padding-left: 1rem;
-  overflow: hidden;
-}
-
-.responseTabsListContainer {
-  padding: 0 0.25rem;
-  overflow-y: hidden;
-  overflow-x: scroll;
-  scroll-behavior: smooth;
-}
-
-.responseTabsListContainer::-webkit-scrollbar {
-  display: none;
-}
-
-/* Response Code Tabs - Colored Dots */
-.responseTabDot {
-  width: 12.5px;
-  height: 12.5px;
-  margin-right: 5px;
-  border-radius: 50%;
-}
-
-.responseStatusSuccess > .responseTabDot {
-  background-color: var(--ifm-color-success);
-}
-
-.responseStatusDanger > .responseTabDot {
-  background-color: var(--ifm-color-danger);
-}
-
-.responseStatusInfo > .responseTabDot {
-  background-color: var(--ifm-color-info);
-}
-
-.active {
-  background-color: var(--ifm-color-emphasis-100);
-}
-
-.responseSchemaContainer {
-  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) {
-  .responseTabsTopSection {
-    flex-direction: column;
-    align-items: flex-start;
-  }
-
-  .responseTabsContainer {
-    width: 100%;
-    margin-top: var(--ifm-spacing-vertical);
-    padding: 0;
-  }
-}