docusaurus-theme-openapi-docs 1.0.6 → 1.1.0

package/lib/theme/ApiDemoPanel/CodeTabs/index.js

@@ -29,8 +29,13 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-// A very rough duck type, but good enough to guard against mistakes while
+const {
+  useScrollPositionBlocker,
+  useTabGroupChoice
+} = require("@docusaurus/theme-common/internal"); // A very rough duck type, but good enough to guard against mistakes while
 // allowing customization
+
+
 function isTabItem(comp) {
   return "value" in comp.props;
 }
@@ -87,12 +92,12 @@ function TabsComponent(props) {
   const {
     tabGroupChoices,
     setTabGroupChoices
-  } = (0, _themeCommon.useTabGroupChoice)();
+  } = useTabGroupChoice();
   const [selectedValue, setSelectedValue] = (0, _react.useState)(defaultValue);
   const tabRefs = [];
   const {
     blockElementScrollPositionUntilNextRender
-  } = (0, _themeCommon.useScrollPositionBlocker)();
+  } = useScrollPositionBlocker();
 
   if (groupId != null) {
     const relevantTabGroupChoice = tabGroupChoices[groupId];

package/lib/theme/ApiDemoPanel/FloatingButton/index.js

@@ -22,8 +22,10 @@ function FloatingButton({
   onClick,
   children
 }) {
-  return <div className={_stylesModule.default.floatingButton}>
-      {label && <button onClick={onClick}>{label}</button>}
+  return <div tabIndex={0} className={_stylesModule.default.floatingButton}>
+      {label && <button tabIndex={0} onClick={onClick}>
+          {label}
+        </button>}
       {children}
     </div>;
 }

package/lib/theme/ApiDemoPanel/FloatingButton/styles.module.css

@@ -9,7 +9,6 @@
   border-radius: var(--ifm-global-radius);
   color: var(--ifm-color-white);
   cursor: pointer;
-  outline: none;
   padding: 0.4rem 0.5rem;
   opacity: 0;
   visibility: hidden;
@@ -20,7 +19,9 @@
   right: calc(var(--ifm-pre-padding) / 2);
 }
 
-.floatingButton:hover button {
+.floatingButton:hover button,
+.floatingButton:focus-visible button,
+.floatingButton button:focus-visible {
   visibility: visible;
   opacity: 1;
 }

package/lib/theme/ApiDemoPanel/LiveEditor/index.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _react = _interopRequireDefault(require("react"));
+var _react = _interopRequireWildcard(require("react"));
 
 var _themeCommon = require("@docusaurus/theme-common");
 
@@ -19,6 +19,10 @@ var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
@@ -29,9 +33,18 @@ function Live({
   onEdit
 }) {
   const isBrowser = (0, _useIsBrowser.default)();
-  return <>
-      <_reactLive.LiveEditor key={String(isBrowser)} className={_stylesModule.default.playgroundEditor} onChange={onEdit} />
-    </>;
+  const [editorDisabled, setEditorDisabled] = (0, _react.useState)(false); // TODO: Temporary solution for disabling tab key
+
+  const handleKeydown = event => {
+    if (event.key === "Tab") {
+      event.preventDefault();
+      setEditorDisabled(true);
+    }
+  };
+
+  return <div onClick={() => setEditorDisabled(false)}>
+      <_reactLive.LiveEditor key={String(isBrowser)} className={_stylesModule.default.playgroundEditor} onChange={onEdit} disabled={editorDisabled} onKeyDown={handleKeydown} />
+    </div>;
 }
 
 const LiveComponent = (0, _reactLive.withLive)(Live);

package/lib/theme/ApiDemoPanel/LiveEditor/styles.module.css

@@ -3,7 +3,8 @@
   margin-bottom: var(--ifm-leading);
   border-radius: var(--ifm-global-radius);
   box-shadow: var(--ifm-global-shadow-lw);
-  overflow: hidden;
+  overflow: auto;
+  max-height: 500px;
 }
 
 .playgroundHeader {

package/lib/theme/ApiDemoPanel/ParamOptions/styles.module.css

@@ -41,10 +41,6 @@
   display: block;
 }
 
-.showMoreButton:focus {
-  outline: 0;
-}
-
 .showMoreButton:hover {
   /* text-decoration: underline; */
   /* background-color: red; */

package/lib/theme/ApiDemoPanel/Server/index.js

@@ -73,7 +73,7 @@ function Server() {
   }
 
   return <div className={_stylesModule.default.optionsPanel}>
-      <button className={_stylesModule.default.showMoreButton} onClick={() => setIsEditing(false)}>
+      <button className={_stylesModule.default.showMoreButton} onClick={() => setIsEditing(false)} tabIndex={0}>
         Hide
       </button>
       <_FormItem.default label="Endpoint">

package/lib/theme/ApiDemoPanel/Server/styles.module.css

@@ -28,10 +28,6 @@
   display: block;
 }
 
-.showMoreButton:focus {
-  outline: 0;
-}
-
 .showMoreButton:hover {
   /* text-decoration: underline; */
   /* background-color: red; */

package/lib/theme/ApiItem/Content/index.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItemContent;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _internal = require("@docusaurus/theme-common/internal");
+
+var _Heading = _interopRequireDefault(require("@theme/Heading"));
+
+var _MDXContent = _interopRequireDefault(require("@theme/MDXContent"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+// @ts-ignore
+
+/**
+ Title can be declared inside md content or declared through
+ front matter and added manually. To make both cases consistent,
+ the added title is added under the same div.markdown block
+ See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
+
+ We render a "synthetic title" if:
+ - user doesn't ask to hide it with front matter
+ - the markdown content does not already contain a top-level h1 heading
+*/
+function useSyntheticTitle() {
+  const {
+    metadata,
+    frontMatter,
+    contentTitle
+  } = (0, _internal.useDoc)();
+  const shouldRender = !frontMatter.hide_title && typeof contentTitle === "undefined";
+
+  if (!shouldRender) {
+    return null;
+  }
+
+  return metadata.title;
+}
+
+function DocItemContent({
+  children
+}) {
+  const syntheticTitle = useSyntheticTitle();
+  return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docMarkdown, "theme-api-markdown", "markdown")}>
+      {syntheticTitle && <header>
+          <_Heading.default as="h1">{syntheticTitle}</_Heading.default>
+        </header>}
+      <_MDXContent.default>{children}</_MDXContent.default>
+    </div>;
+}

package/lib/theme/ApiItem/Footer/index.js

@@ -0,0 +1,78 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItemFooter;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _internal = require("@docusaurus/theme-common/internal");
+
+var _EditThisPage = _interopRequireDefault(require("@theme/EditThisPage"));
+
+var _LastUpdated = _interopRequireDefault(require("@theme/LastUpdated"));
+
+var _TagsListInline = _interopRequireDefault(require("@theme/TagsListInline"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+function TagsRow(props) {
+  return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooterTagsRow, "row margin-bottom--sm")}>
+      <div className="col">
+        <_TagsListInline.default {...props} />
+      </div>
+    </div>;
+}
+
+function EditMetaRow({
+  editUrl,
+  lastUpdatedAt,
+  lastUpdatedBy,
+  formattedLastUpdatedAt
+}) {
+  return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooterEditMetaRow, "row")}>
+      <div className="col">{editUrl && <_EditThisPage.default editUrl={editUrl} />}</div>
+
+      <div className={(0, _clsx.default)("col", _stylesModule.default.lastUpdated)}>
+        {(lastUpdatedAt || lastUpdatedBy) && <_LastUpdated.default lastUpdatedAt={lastUpdatedAt} formattedLastUpdatedAt={formattedLastUpdatedAt} lastUpdatedBy={lastUpdatedBy} />}
+      </div>
+    </div>;
+}
+
+function DocItemFooter() {
+  const {
+    metadata
+  } = (0, _internal.useDoc)();
+  const {
+    editUrl,
+    lastUpdatedAt,
+    formattedLastUpdatedAt,
+    lastUpdatedBy,
+    tags
+  } = metadata;
+  const canDisplayTagsRow = tags.length > 0;
+  const canDisplayEditMetaRow = !!(editUrl || lastUpdatedAt || lastUpdatedBy);
+  const canDisplayFooter = canDisplayTagsRow || canDisplayEditMetaRow;
+
+  if (!canDisplayFooter) {
+    return null;
+  }
+
+  return <footer className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooter, "docusaurus-mt-lg")}>
+      {canDisplayTagsRow && <TagsRow tags={tags} />}
+      {canDisplayEditMetaRow && <EditMetaRow editUrl={editUrl} lastUpdatedAt={lastUpdatedAt} lastUpdatedBy={lastUpdatedBy} formattedLastUpdatedAt={formattedLastUpdatedAt} />}
+    </footer>;
+}

package/lib/theme/ApiItem/Footer/styles.module.css

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+
+.lastUpdated {
+  margin-top: 0.2rem;
+  font-style: italic;
+  font-size: smaller;
+}
+
+@media (min-width: 997px) {
+  .lastUpdated {
+    text-align: right;
+  }
+}

package/lib/theme/ApiItem/Layout/index.js

@@ -0,0 +1,93 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItemLayout;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _internal = require("@docusaurus/theme-common/internal");
+
+var _DocBreadcrumbs = _interopRequireDefault(require("@theme/DocBreadcrumbs"));
+
+var _DocVersionBadge = _interopRequireDefault(require("@theme/DocVersionBadge"));
+
+var _DocVersionBanner = _interopRequireDefault(require("@theme/DocVersionBanner"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _Content = _interopRequireDefault(require("../Content"));
+
+var _Footer = _interopRequireDefault(require("../Footer"));
+
+var _Paginator = _interopRequireDefault(require("../Paginator"));
+
+var _Desktop = _interopRequireDefault(require("../TOC/Desktop"));
+
+var _Mobile = _interopRequireDefault(require("../TOC/Mobile"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+// @ts-ignore
+
+/**
+ * Decide if the toc should be rendered, on mobile or desktop viewports
+ */
+function useDocTOC() {
+  const {
+    frontMatter,
+    toc
+  } = (0, _internal.useDoc)();
+  const windowSize = (0, _themeCommon.useWindowSize)();
+  const hidden = frontMatter.hide_table_of_contents;
+  const canRender = !hidden && toc.length > 0;
+  const mobile = canRender ? <_Mobile.default /> : undefined;
+  const desktop = canRender && (windowSize === "desktop" || windowSize === "ssr") ? <_Desktop.default /> : undefined;
+  return {
+    hidden,
+    mobile,
+    desktop
+  };
+}
+
+function DocItemLayout({
+  children
+}) {
+  const docTOC = useDocTOC();
+  const {
+    frontMatter: {
+      api
+    }
+  } = (0, _internal.useDoc)();
+  return <div className="row">
+      <div className={(0, _clsx.default)("col", !docTOC.hidden && _stylesModule.default.docItemCol)}>
+        <_DocVersionBanner.default />
+        <div className={_stylesModule.default.docItemContainer}>
+          <article>
+            <_DocBreadcrumbs.default />
+            <_DocVersionBadge.default />
+            {docTOC.mobile}
+            <_Content.default>{children}</_Content.default>
+            <div className={(0, _clsx.default)("col", api ? "col--7" : "col--12")}>
+              <_Footer.default />
+            </div>
+          </article>
+          <div className={(0, _clsx.default)("col", api ? "col--7" : "col--12")}>
+            <_Paginator.default />
+          </div>
+        </div>
+      </div>
+      {docTOC.desktop && <div className="col col--3">{docTOC.desktop}</div>}
+    </div>;
+}

package/lib/theme/ApiItem/{styles.module.css → Layout/styles.module.css}

@@ -1,3 +1,10 @@
+/**
+ * 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.
+ */
+
 :root {
   --openapi-required: var(--ifm-color-danger);
   --openapi-code-blue: var(--ifm-color-info);
@@ -6,6 +13,21 @@
   --openapi-code-green: var(--ifm-color-success);
 }
 
+:global(.docs-wrapper) {
+  height: 100%;
+}
+
+.docItemContainer header + *,
+.docItemContainer article > *:first-child {
+  margin-top: 0;
+}
+
+@media (min-width: 997px) {
+  .docItemCol {
+    max-width: 75% !important;
+  }
+}
+
 .apiItemContainer article > *:first-child,
 .apiItemContainer header + * {
   margin-top: 0;
@@ -70,10 +92,6 @@
   padding-top: 5px;
 }
 
-:global(.theme-api-markdown details li:last-child) {
-  border-left: none;
-}
-
 :global(.theme-api-markdown details p) {
   margin-bottom: 0;
 }
@@ -147,6 +165,11 @@
   border-bottom-color: var(--ifm-color-success);
 }
 
+:global(.language-python) {
+  max-height: 500px;
+  overflow: auto;
+}
+
 :global(.code__tab--go::after) {
   content: "";
   width: 32px;
@@ -165,6 +188,11 @@
   border-bottom-color: var(--ifm-color-info);
 }
 
+:global(.language-go) {
+  max-height: 500px;
+  overflow: auto;
+}
+
 :global(.code__tab--javascript::after) {
   content: "";
   width: 32px;
@@ -183,6 +211,11 @@
   border-bottom-color: var(--ifm-color-warning);
 }
 
+:global(.language-javascript) {
+  max-height: 500px;
+  overflow: auto;
+}
+
 :global(.code__tab--bash::after) {
   content: "";
   width: 32px;
@@ -200,3 +233,8 @@
 :global(.code__tab--bash.tabs__item--active) {
   border-bottom-color: var(--ifm-color-danger);
 }
+
+:global(.language-bash) {
+  max-height: 500px;
+  overflow: auto;
+}

package/lib/theme/ApiItem/Metadata/index.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItemMetadata;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _internal = require("@docusaurus/theme-common/internal");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+// @ts-ignore
+function DocItemMetadata() {
+  var _assets$image;
+
+  const {
+    metadata,
+    frontMatter,
+    assets
+  } = (0, _internal.useDoc)();
+  return <_themeCommon.PageMetadata title={metadata.title} description={metadata.description} keywords={frontMatter.keywords} image={(_assets$image = assets.image) !== null && _assets$image !== void 0 ? _assets$image : frontMatter.image} />;
+}

package/lib/theme/ApiItem/Paginator/index.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItemPaginator;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _internal = require("@docusaurus/theme-common/internal");
+
+var _DocPaginator = _interopRequireDefault(require("@theme/DocPaginator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+// @ts-ignore
+
+/**
+ * This extra component is needed, because <DocPaginator> should remain generic.
+ * DocPaginator is used in non-docs contexts too: generated-index pages...
+ */
+function DocItemPaginator() {
+  const {
+    metadata
+  } = (0, _internal.useDoc)();
+  return <_DocPaginator.default previous={metadata.previous} next={metadata.next} />;
+}

package/lib/theme/ApiItem/TOC/Desktop/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItemTOCDesktop;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _internal = require("@docusaurus/theme-common/internal");
+
+var _TOC = _interopRequireDefault(require("@theme/TOC"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+// @ts-ignore
+function DocItemTOCDesktop() {
+  const {
+    toc,
+    frontMatter
+  } = (0, _internal.useDoc)();
+  return <_TOC.default toc={toc} minHeadingLevel={frontMatter.toc_min_heading_level} maxHeadingLevel={frontMatter.toc_max_heading_level} className={_themeCommon.ThemeClassNames.docs.docTocDesktop} />;
+}

package/lib/theme/ApiItem/TOC/Mobile/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItemTOCMobile;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _internal = require("@docusaurus/theme-common/internal");
+
+var _TOCCollapsible = _interopRequireDefault(require("@theme/TOCCollapsible"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+// @ts-ignore
+function DocItemTOCMobile() {
+  const {
+    toc,
+    frontMatter
+  } = (0, _internal.useDoc)();
+  return <_TOCCollapsible.default toc={toc} minHeadingLevel={frontMatter.toc_min_heading_level} maxHeadingLevel={frontMatter.toc_max_heading_level} className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docTocMobile, _stylesModule.default.tocMobile)} />;
+}

package/lib/theme/ApiItem/TOC/Mobile/styles.module.css

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+@media (min-width: 997px) {
+  /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+  .tocMobile {
+    display: none;
+  }
+}
+
+@media print {
+  .tocMobile {
+    display: none;
+  }
+}