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

package/lib-next/theme/SchemaItem/_SchemaItem.scss

@@ -1,53 +0,0 @@
-.openapi-schema__list-item {
-  list-style: none;
-  position: relative;
-  margin: 0 !important;
-  padding: 5px 0 5px 1rem;
-  border-left: thin solid var(--ifm-color-gray-500) !important;
-
-  // Horizontal line styling for schema properties
-  &::before {
-    position: absolute;
-    top: 10px;
-    left: 0;
-    width: 0.7rem;
-    /* width of horizontal line */
-    height: 0.5rem;
-    /* vertical position of line */
-    vertical-align: top;
-    border-bottom: thin solid var(--ifm-color-gray-500);
-    content: "";
-    display: inline-block;
-  }
-}
-
-.openapi-schema__list-item:hover {
-  background-color: var(--ifm-menu-color-background-active);
-}
-
-.openapi-schema__list-item:focus {
-  background-color: var(--ifm-menu-color-background-active);
-}
-
-.openapi-schema__name {
-  opacity: 0.6;
-}
-
-.openapi-schema__required {
-  font-size: var(--ifm-code-font-size);
-  color: var(--openapi-required);
-}
-
-.openapi-schema__deprecated {
-  font-size: var(--ifm-code-font-size);
-  color: var(--openapi-deprecated);
-}
-
-.openapi-schema__nullable {
-  font-size: var(--ifm-code-font-size);
-  color: var(--openapi-nullable);
-}
-
-.openapi-schema__strikethrough {
-  text-decoration: line-through;
-}

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

@@ -1,112 +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 CodeBlock from "@theme/CodeBlock";
-/* eslint-disable import/no-extraneous-dependencies*/
-import { createDescription } from "docusaurus-theme-openapi-docs/lib/markdown/createDescription";
-/* eslint-disable import/no-extraneous-dependencies*/
-import { guard } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
-import ReactMarkdown from "react-markdown";
-import rehypeRaw from "rehype-raw";
-
-function SchemaItem({
-  children: collapsibleSchemaContent,
-  collapsible,
-  name,
-  qualifierMessage,
-  required,
-  schemaName,
-  schema,
-}) {
-  let deprecated;
-  let schemaDescription;
-  let defaultValue;
-  let nullable;
-  if (schema) {
-    deprecated = schema.deprecated;
-    schemaDescription = schema.description;
-    defaultValue = schema.default;
-    nullable = schema.nullable;
-  }
-
-  const renderRequired = guard(
-    Array.isArray(required) ? required.includes(name) : required,
-    () => <strong className="openapi-schema__required"> required</strong>
-  );
-
-  const renderDeprecated = guard(deprecated, () => (
-    <strong className="openapi-schema__deprecated"> deprecated</strong>
-  ));
-
-  const renderNullable = guard(nullable, () => (
-    <strong className="openapi-schema__nullable"> nullable</strong>
-  ));
-
-  const renderSchemaDescription = guard(schemaDescription, (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>
-            );
-          },
-        }}
-        rehypePlugins={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderQualifierMessage = guard(qualifierMessage, (message) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(message)}
-        rehypePlugins={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderDefaultValue = guard(
-    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
-    (value) => (
-      <div className="">
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
-  );
-
-  const schemaContent = (
-    <div>
-      <strong className={deprecated && "openapi-schema__strikethrough"}>
-        {name}
-      </strong>
-      <span className="openapi-schema__name"> {schemaName}</span>
-      {renderNullable}
-      {!deprecated && renderRequired}
-      {renderDeprecated}
-      {renderQualifierMessage}
-      {renderDefaultValue}
-      {renderSchemaDescription}
-    </div>
-  );
-
-  return (
-    <li className="openapi-schema__list-item">
-      {collapsible ? collapsibleSchemaContent : schemaContent}
-    </li>
-  );
-}
-
-export default SchemaItem;

package/lib-next/theme/SchemaTabs/_SchemaTabs.scss

@@ -1,58 +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.
- */
-
-.openapi-tabs__schema-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;
-}
-
-.openapi-tabs__schema-item:not(.active) {
-  opacity: 0.65;
-}
-
-.openapi-tabs__schema-item:hover {
-  opacity: 1;
-  background-color: var(--ifm-color-emphasis-100);
-}
-
-.openapi-tabs__schema-item:last-child {
-  margin-right: 0 !important;
-}
-
-.openapi-tabs__schema-list-container {
-  overflow-y: hidden;
-  overflow-x: scroll;
-  scroll-behavior: smooth;
-
-  &::-webkit-scrollbar {
-    display: none;
-  }
-
-  &.active {
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-
-.openapi-tabs__schema-label {
-  white-space: nowrap;
-}
-
-.openapi-tabs__schema-container {
-  width: 100%;
-  margin-top: 1rem;
-  display: flex;
-  align-items: center;
-  overflow: hidden;
-}

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

@@ -1,186 +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, useEffect, useState } from "react";
-
-import {
-  useScrollPositionBlocker,
-  useTabs,
-} from "@docusaurus/theme-common/internal";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import clsx from "clsx";
-import flatten from "lodash/flatten";
-
-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="tabs__container">
-      <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
-          )}
-        >
-          {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>
-    </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 (
-    <TabsComponent
-      // Remount tabs after hydration
-      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
-      key={String(isBrowser)}
-      {...props}
-    />
-  );
-}

package/lib-next/theme/styles.scss

@@ -1,117 +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.
- * ========================================================================== */
-/* 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-next/theme-classic.d.ts

@@ -1,13 +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.
- * ========================================================================== */
-
-/// <reference types="@docusaurus/theme-classic" />
-
-declare module "@docusaurus/theme-common/internal" {
-  function useDoc(): any;
-  export const { useDoc };
-}