docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

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

@@ -1,31 +0,0 @@
-"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

@@ -1,35 +0,0 @@
-"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

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

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

@@ -1,44 +0,0 @@
-:root {
-  /* VS Dark mode */
-  --openapi-monaco-background-color-dark: var(--ifm-color-gray-900);
-  --openapi-code-bright-dark: var(--ifm-color-secondary-lighter);
-  --openapi-code-dim-dark: var(--ifm-color-secondary-dark);
-  --openapi-code-blue-dark: var(--ifm-color-primary);
-  --openapi-code-green-dark: var(--ifm-color-success);
-  --openapi-code-select-dark: var(--ifm-color-secondary-lightest);
-
-  /* VS Light mode */
-  --openapi-monaco-background-color-light: var(--ifm-color-gray-100);
-  --openapi-code-bright-light: var(--ifm-color-black);
-  --openapi-code-dim-light: var(--ifm-color-black);
-  --openapi-code-blue-light: var(--ifm-color-primary);
-  --openapi-code-green-light: var(--ifm-color-success);
-  --openapi-code-select-light: var(--ifm-color-secondary-light);
-
-  --openapi-card-background-color: var(--ifm-color-gray-100);
-  --openapi-card-border-radius: var(--ifm-pre-border-radius);
-  --openapi-monaco-border-color: var(--openapi-card-background-color);
-  --openapi-input-border: var(--ifm-color-primary);
-}
-
-[data-theme="dark"] {
-  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
-}
-
-.optionsPanel:empty {
-  display: none;
-}
-
-.optionsPanel {
-  background: var(--openapi-card-background-color);
-  border-radius: var(--openapi-card-border-radius);
-  color: var(--ifm-pre-color);
-  line-height: var(--ifm-pre-line-height);
-  margin-bottom: var(--ifm-spacing-vertical);
-  margin-top: 0;
-  overflow: auto;
-  padding: var(--ifm-pre-padding);
-
-  /* hack for view calculation when monaco is hidden */
-  position: relative;
-}

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

@@ -1,55 +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 { ThemeClassNames } from "@docusaurus/theme-common"; // @ts-ignore
-
-import { useDoc } from "@docusaurus/theme-common/internal";
-import Heading from "@theme/Heading";
-import MDXContent from "@theme/MDXContent";
-import clsx from "clsx";
-/**
- 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 } = useDoc();
-  const shouldRender =
-    !frontMatter.hide_title && typeof contentTitle === "undefined";
-
-  if (!shouldRender) {
-    return null;
-  }
-
-  return metadata.title;
-}
-
-export default function DocItemContent({ children }) {
-  const syntheticTitle = useSyntheticTitle();
-  return (
-    <div
-      className={clsx(
-        ThemeClassNames.docs.docMarkdown,
-        "theme-api-markdown",
-        "markdown"
-      )}
-    >
-      {syntheticTitle && (
-        <header>
-          <Heading as="h1">{syntheticTitle}</Heading>
-        </header>
-      )}
-      <MDXContent>{children}</MDXContent>
-    </div>
-  );
-}

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

@@ -1,88 +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 { ThemeClassNames } from "@docusaurus/theme-common";
-import {
-  useDoc, // @ts-ignore
-} from "@docusaurus/theme-common/internal";
-import EditThisPage from "@theme/EditThisPage";
-import LastUpdated from "@theme/LastUpdated";
-import TagsListInline from "@theme/TagsListInline";
-import clsx from "clsx";
-import styles from "./styles.module.css";
-
-function TagsRow(props) {
-  return (
-    <div
-      className={clsx(
-        ThemeClassNames.docs.docFooterTagsRow,
-        "row margin-bottom--sm"
-      )}
-    >
-      <div className="col">
-        <TagsListInline {...props} />
-      </div>
-    </div>
-  );
-}
-
-function EditMetaRow({
-  editUrl,
-  lastUpdatedAt,
-  lastUpdatedBy,
-  formattedLastUpdatedAt,
-}) {
-  return (
-    <div className={clsx(ThemeClassNames.docs.docFooterEditMetaRow, "row")}>
-      <div className="col">{editUrl && <EditThisPage editUrl={editUrl} />}</div>
-
-      <div className={clsx("col", styles.lastUpdated)}>
-        {(lastUpdatedAt || lastUpdatedBy) && (
-          <LastUpdated
-            lastUpdatedAt={lastUpdatedAt}
-            formattedLastUpdatedAt={formattedLastUpdatedAt}
-            lastUpdatedBy={lastUpdatedBy}
-          />
-        )}
-      </div>
-    </div>
-  );
-}
-
-export default function DocItemFooter() {
-  const { metadata } = 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={clsx(ThemeClassNames.docs.docFooter, "docusaurus-mt-lg")}
-    >
-      {canDisplayTagsRow && <TagsRow tags={tags} />}
-      {canDisplayEditMetaRow && (
-        <EditMetaRow
-          editUrl={editUrl}
-          lastUpdatedAt={lastUpdatedAt}
-          lastUpdatedBy={lastUpdatedBy}
-          formattedLastUpdatedAt={formattedLastUpdatedAt}
-        />
-      )}
-    </footer>
-  );
-}

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

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

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

@@ -1,21 +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 { PageMetadata } from "@docusaurus/theme-common"; // @ts-ignore
-
-import { useDoc } from "@docusaurus/theme-common/internal";
-export default function DocItemMetadata() {
-  const { metadata, frontMatter, assets } = useDoc();
-  return (
-    <PageMetadata
-      title={metadata.title}
-      description={metadata.description}
-      keywords={frontMatter.keywords}
-      image={assets.image ?? frontMatter.image}
-    />
-  );
-}

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

@@ -1,19 +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"; // @ts-ignore
-
-import { useDoc } from "@docusaurus/theme-common/internal";
-import DocPaginator from "@theme/DocPaginator";
-/**
- * This extra component is needed, because <DocPaginator> should remain generic.
- * DocPaginator is used in non-docs contexts too: generated-index pages...
- */
-
-export default function DocItemPaginator() {
-  const { metadata } = useDoc();
-  return <DocPaginator previous={metadata.previous} next={metadata.next} />;
-}

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

@@ -1,22 +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 { ThemeClassNames } from "@docusaurus/theme-common"; // @ts-ignore
-
-import { useDoc } from "@docusaurus/theme-common/internal";
-import TOC from "@theme/TOC";
-export default function DocItemTOCDesktop() {
-  const { toc, frontMatter } = useDoc();
-  return (
-    <TOC
-      toc={toc}
-      minHeadingLevel={frontMatter.toc_min_heading_level}
-      maxHeadingLevel={frontMatter.toc_max_heading_level}
-      className={ThemeClassNames.docs.docTocDesktop}
-    />
-  );
-}

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

@@ -1,24 +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 { ThemeClassNames } from "@docusaurus/theme-common"; // @ts-ignore
-
-import { useDoc } from "@docusaurus/theme-common/internal";
-import TOCCollapsible from "@theme/TOCCollapsible";
-import clsx from "clsx";
-import styles from "./styles.module.css";
-export default function DocItemTOCMobile() {
-  const { toc, frontMatter } = useDoc();
-  return (
-    <TOCCollapsible
-      toc={toc}
-      minHeadingLevel={frontMatter.toc_min_heading_level}
-      maxHeadingLevel={frontMatter.toc_max_heading_level}
-      className={clsx(ThemeClassNames.docs.docTocMobile, styles.tocMobile)}
-    />
-  );
-}

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

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

package/src/theme/ApiDemoPanel/styles.module.css

@@ -1,44 +0,0 @@
-:root {
-  /* VS Dark mode */
-  --openapi-monaco-background-color-dark: var(--ifm-color-gray-900);
-  --openapi-code-bright-dark: var(--ifm-color-secondary-lighter);
-  --openapi-code-dim-dark: var(--ifm-color-secondary-dark);
-  --openapi-code-blue-dark: var(--ifm-color-primary);
-  --openapi-code-green-dark: var(--ifm-color-success);
-  --openapi-code-select-dark: var(--ifm-color-secondary-lightest);
-
-  /* VS Light mode */
-  --openapi-monaco-background-color-light: var(--ifm-color-gray-100);
-  --openapi-code-bright-light: var(--ifm-color-black);
-  --openapi-code-dim-light: var(--ifm-color-black);
-  --openapi-code-blue-light: var(--ifm-color-primary);
-  --openapi-code-green-light: var(--ifm-color-success);
-  --openapi-code-select-light: var(--ifm-color-secondary-light);
-
-  --openapi-card-background-color: var(--ifm-color-gray-100);
-  --openapi-card-border-radius: var(--ifm-pre-border-radius);
-  --openapi-monaco-border-color: var(--openapi-card-background-color);
-  --openapi-input-border: var(--ifm-color-primary);
-}
-
-[data-theme="dark"] {
-  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
-}
-
-.optionsPanel:empty {
-  display: none;
-}
-
-.optionsPanel {
-  background: var(--openapi-card-background-color);
-  border-radius: var(--openapi-card-border-radius);
-  color: var(--ifm-pre-color);
-  line-height: var(--ifm-pre-line-height);
-  margin-bottom: var(--ifm-spacing-vertical);
-  margin-top: 0;
-  overflow: auto;
-  padding: var(--ifm-pre-padding);
-
-  /* hack for view calculation when monaco is hidden */
-  position: relative;
-}

package/src/theme/ApiItem/Content/index.tsx

@@ -1,57 +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 { ThemeClassNames } from "@docusaurus/theme-common";
-// @ts-ignore
-import { useDoc } from "@docusaurus/theme-common/internal";
-import type { Props } from "@theme/DocItem/Content";
-import Heading from "@theme/Heading";
-import MDXContent from "@theme/MDXContent";
-import clsx from "clsx";
-
-/**
- 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(): string | null {
-  const { metadata, frontMatter, contentTitle } = useDoc();
-  const shouldRender =
-    !frontMatter.hide_title && typeof contentTitle === "undefined";
-  if (!shouldRender) {
-    return null;
-  }
-  return metadata.title;
-}
-
-export default function DocItemContent({ children }: Props): JSX.Element {
-  const syntheticTitle = useSyntheticTitle();
-
-  return (
-    <div
-      className={clsx(
-        ThemeClassNames.docs.docMarkdown,
-        "theme-api-markdown",
-        "markdown"
-      )}
-    >
-      {syntheticTitle && (
-        <header>
-          <Heading as="h1">{syntheticTitle}</Heading>
-        </header>
-      )}
-      <MDXContent>{children}</MDXContent>
-    </div>
-  );
-}

package/src/theme/ApiItem/Footer/index.tsx

@@ -1,101 +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 { ThemeClassNames } from "@docusaurus/theme-common";
-import {
-  useDoc,
-  type DocContextValue,
-  // @ts-ignore
-} from "@docusaurus/theme-common/internal";
-import EditThisPage from "@theme/EditThisPage";
-import LastUpdated from "@theme/LastUpdated";
-import TagsListInline, {
-  type Props as TagsListInlineProps,
-} from "@theme/TagsListInline";
-import clsx from "clsx";
-
-import styles from "./styles.module.css";
-
-function TagsRow(props: TagsListInlineProps) {
-  return (
-    <div
-      className={clsx(
-        ThemeClassNames.docs.docFooterTagsRow,
-        "row margin-bottom--sm"
-      )}
-    >
-      <div className="col">
-        <TagsListInline {...props} />
-      </div>
-    </div>
-  );
-}
-
-type EditMetaRowProps = Pick<
-  DocContextValue["metadata"],
-  "editUrl" | "lastUpdatedAt" | "lastUpdatedBy" | "formattedLastUpdatedAt"
->;
-function EditMetaRow({
-  editUrl,
-  lastUpdatedAt,
-  lastUpdatedBy,
-  formattedLastUpdatedAt,
-}: EditMetaRowProps) {
-  return (
-    <div className={clsx(ThemeClassNames.docs.docFooterEditMetaRow, "row")}>
-      <div className="col">{editUrl && <EditThisPage editUrl={editUrl} />}</div>
-
-      <div className={clsx("col", styles.lastUpdated)}>
-        {(lastUpdatedAt || lastUpdatedBy) && (
-          <LastUpdated
-            lastUpdatedAt={lastUpdatedAt}
-            formattedLastUpdatedAt={formattedLastUpdatedAt}
-            lastUpdatedBy={lastUpdatedBy}
-          />
-        )}
-      </div>
-    </div>
-  );
-}
-
-export default function DocItemFooter(): JSX.Element | null {
-  const { metadata } = 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={clsx(ThemeClassNames.docs.docFooter, "docusaurus-mt-lg")}
-    >
-      {canDisplayTagsRow && <TagsRow tags={tags} />}
-      {canDisplayEditMetaRow && (
-        <EditMetaRow
-          editUrl={editUrl}
-          lastUpdatedAt={lastUpdatedAt}
-          lastUpdatedBy={lastUpdatedBy}
-          formattedLastUpdatedAt={formattedLastUpdatedAt}
-        />
-      )}
-    </footer>
-  );
-}

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

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

package/src/theme/ApiItem/Metadata/index.tsx

@@ -1,24 +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 { PageMetadata } from "@docusaurus/theme-common";
-// @ts-ignore
-import { useDoc } from "@docusaurus/theme-common/internal";
-
-export default function DocItemMetadata(): JSX.Element {
-  const { metadata, frontMatter, assets } = useDoc();
-  return (
-    <PageMetadata
-      title={metadata.title}
-      description={metadata.description}
-      keywords={frontMatter.keywords}
-      image={assets.image ?? frontMatter.image}
-    />
-  );
-}

package/src/theme/ApiItem/Paginator/index.tsx

@@ -1,21 +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";
-
-// @ts-ignore
-import { useDoc } from "@docusaurus/theme-common/internal";
-import DocPaginator from "@theme/DocPaginator";
-
-/**
- * This extra component is needed, because <DocPaginator> should remain generic.
- * DocPaginator is used in non-docs contexts too: generated-index pages...
- */
-export default function DocItemPaginator(): JSX.Element {
-  const { metadata } = useDoc();
-  return <DocPaginator previous={metadata.previous} next={metadata.next} />;
-}