docusaurus-theme-openapi-docs 2.0.0-beta.2 → 2.0.0-beta.3

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

@@ -1,150 +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 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;
-  const { api } = frontMatter;
-  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/_ApiTabs.scss

@@ -1,133 +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.
- * ========================================================================== */
-.openapi-tabs__container {
-  margin-left: -1px;
-  margin-bottom: var(--ifm-leading);
-}
-
-.openapi-tabs__response-code-item {
-  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);
-
-  &.success {
-    .openapi-tabs__response-dot {
-      background-color: var(--ifm-color-success);
-    }
-  }
-
-  &.danger {
-    .openapi-tabs__response-dot {
-      background-color: var(--ifm-color-danger);
-    }
-  }
-
-  &.info {
-    .openapi-tabs__response-dot {
-      background-color: var(--ifm-color-info);
-    }
-  }
-
-  &.active {
-    opacity: 1;
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-
-.openapi-tabs__response-code-item:not(.active) {
-  opacity: 0.65;
-}
-
-.openapi-tabs__response-code-item:hover {
-  opacity: 1;
-}
-
-.openapi-tabs__response-code-item:last-child {
-  margin-right: 0 !important;
-}
-
-/* Open API Response Code Tabs */
-.openapi-tabs__response-header-section {
-  margin-top: 2rem;
-  display: flex;
-  justify-content: space-between;
-  align-items: center;
-}
-
-.openapi-tabs__response-container {
-  display: flex;
-  align-items: center;
-  max-width: 390px;
-  padding-left: 1rem;
-  overflow: hidden;
-}
-
-.openapi-tabs__response-list-container {
-  padding: 0 0.25rem;
-  overflow-y: hidden;
-  overflow-x: scroll;
-  scroll-behavior: smooth;
-}
-
-.openapi-tabs__response-list-container::-webkit-scrollbar {
-  display: none;
-}
-
-/* Response Code Tabs - Colored Dots */
-.openapi-tabs__response-dot {
-  width: 12.5px;
-  height: 12.5px;
-  margin-right: 5px;
-  border-radius: 50%;
-}
-
-.openapi-tabs__response-schema-container {
-  max-width: 600px;
-}
-
-/* Tab Arrows */
-.openapi-tabs__arrow {
-  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);
-
-  &:hover {
-    cursor: pointer;
-  }
-
-  &.left {
-    transform: rotate(270deg);
-  }
-
-  &.right {
-    transform: rotate(90deg);
-  }
-}
-
-@media screen and (max-width: 500px) {
-  .openapi-tabs__response-header-section {
-    flex-direction: column;
-    align-items: flex-start;
-  }
-
-  .openapi-tabs__response-container {
-    width: 100%;
-    margin-top: var(--ifm-spacing-vertical);
-    padding: 0;
-  }
-}

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

@@ -1,191 +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, { cloneElement, useRef, useState, useEffect } from "react";
-
-import {
-  useScrollPositionBlocker,
-  useTabs,
-} from "@docusaurus/theme-common/internal";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import clsx from "clsx";
-
-function TabList({ className, block, selectedValue, selectValue, tabValues }) {
-  const tabRefs = [];
-  const { blockElementScrollPositionUntilNextRender } =
-    useScrollPositionBlocker();
-
-  const handleTabChange = (event) => {
-    const newTab = event.currentTarget;
-    const newTabIndex = tabRefs.indexOf(newTab);
-    const newTabValue = tabValues[newTabIndex].value;
-    if (newTabValue !== selectedValue) {
-      blockElementScrollPositionUntilNextRender(newTab);
-      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];
-        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="openapi-tabs__response-header-section">
-      <strong>Responses</strong>
-      <div className="openapi-tabs__response-container">
-        {showTabArrows && (
-          <button
-            className="openapi-tabs__arrow left"
-            onClick={handleLeftClick}
-          />
-        )}
-        <ul
-          ref={tabItemListContainerRef}
-          role="tablist"
-          aria-orientation="horizontal"
-          className={clsx(
-            "openapi-tabs__response-list-container",
-            "tabs",
-            {
-              "tabs--block": block,
-            },
-            className
-          )}
-        >
-          {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__response-code-item",
-                attributes?.className,
-                parseInt(value) >= 400
-                  ? "danger"
-                  : parseInt(value) >= 200 && parseInt(value) < 300
-                  ? "success"
-                  : "info",
-                {
-                  active: selectedValue === value,
-                }
-              )}
-            >
-              <div className="openapi-tabs__response-dot" />
-              {label ?? value}
-            </li>
-          ))}
-        </ul>
-        {showTabArrows && (
-          <button
-            className="openapi-tabs__arrow right"
-            onClick={handleRightClick}
-          />
-        )}
-      </div>
-    </div>
-  );
-}
-function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
-  if (lazy) {
-    const selectedTabItem = children.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="openapi-tabs__container">
-      <TabList {...props} {...tabs} />
-      <hr />
-      <TabContent {...props} {...tabs} />
-    </div>
-  );
-}
-export default function ApiTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <TabsComponent
-      // Remount tabs after hydration
-      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
-      key={String(isBrowser)}
-      {...props}
-    />
-  );
-}

package/lib-next/theme/DiscriminatorTabs/_DiscriminatorTabs.scss

@@ -1,94 +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.
- * ========================================================================== */
-.openapi-tabs__discriminator-item {
-  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;
-
-  &:not(.active) {
-    opacity: 0.65;
-  }
-
-  &.active {
-    background-color: var(--ifm-color-emphasis-100);
-  }
-
-  &:hover {
-    opacity: 1;
-    background-color: var(--ifm-color-emphasis-100);
-  }
-
-  &:last-child {
-    margin-right: 0 !important;
-  }
-}
-
-/* Open API Discriminator Tabs */
-.openapi-tabs__discriminator-top-section {
-  margin-top: 1rem;
-  margin-left: 0.9rem;
-  display: flex;
-  justify-content: space-between;
-  align-items: center;
-}
-
-.openapi-tabs__discriminator-top-section + hr {
-  display: none;
-}
-
-.openapi-tabs__discriminator-container {
-  display: flex;
-  align-items: center;
-  max-width: 600px;
-  padding-left: 3px;
-  overflow: hidden;
-}
-
-.openapi-tabs__discriminator-list-container {
-  padding: 0 0.25rem;
-  overflow-y: hidden;
-  overflow-x: scroll;
-  scroll-behavior: smooth;
-}
-
-.openapi-tabs__discriminator-list-container::-webkit-scrollbar {
-  display: none;
-}
-
-.openapi-tabs__discriminator-tab-label {
-  white-space: nowrap;
-}
-
-.openapi-discriminator__item {
-  list-style: none;
-  position: relative;
-  margin: 0 !important;
-  padding: 5px 0 5px 0 !important;
-  border-left: thin solid var(--openapi-tree-line-color) !important;
-}
-
-@media screen and (max-width: 500px) {
-  .openapi-tabs__discriminator-top-section {
-    flex-direction: column;
-    align-items: flex-start;
-  }
-
-  .openapi-tabs__discriminator-container {
-    width: 100%;
-  }
-
-  .openapi-tabs__discriminator-item {
-    height: 100%;
-  }
-}