docusaurus-theme-openapi-docs 3.0.2 → 4.0.0

package/lib/theme/ApiExplorer/Request/index.d.ts

@@ -1,6 +1,6 @@
 import React from "react";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 declare function Request({ item }: {
-    item: NonNullable<ApiItem>;
+    item: ApiItem;
 }): React.JSX.Element | null;
 export default Request;

package/lib/theme/ApiExplorer/Request/index.js

@@ -57,7 +57,7 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 // @ts-nocheck
 const react_1 = __importStar(require("react"));
-const internal_1 = require("@docusaurus/theme-common/internal");
+const client_1 = require("@docusaurus/plugin-content-docs/client");
 const Accept_1 = __importDefault(require("@theme/ApiExplorer/Accept"));
 const Authorization_1 = __importDefault(
   require("@theme/ApiExplorer/Authorization")
@@ -80,7 +80,7 @@ const react_hook_form_1 = require("react-hook-form");
 const makeRequest_1 = __importDefault(require("./makeRequest"));
 function Request({ item }) {
   const postman = new postman_collection_1.default.Request(item.postman);
-  const metadata = (0, internal_1.useDoc)();
+  const metadata = (0, client_1.useDoc)();
   const { proxy, hide_send_button: hideSendButton } = metadata.frontMatter;
   const pathParams = (0, hooks_1.useTypedSelector)(
     (state) => state.params.path

package/lib/theme/ApiExplorer/Response/index.d.ts

@@ -1,6 +1,6 @@
 import React from "react";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 declare function Response({ item }: {
-    item: NonNullable<ApiItem>;
+    item: ApiItem;
 }): React.JSX.Element | null;
 export default Response;

package/lib/theme/ApiExplorer/Response/index.js

@@ -12,8 +12,9 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+// @ts-ignore
+const client_1 = require("@docusaurus/plugin-content-docs/client");
 const theme_common_1 = require("@docusaurus/theme-common");
-const internal_1 = require("@docusaurus/theme-common/internal");
 const ApiCodeBlock_1 = __importDefault(
   require("@theme/ApiExplorer/ApiCodeBlock")
 );
@@ -41,7 +42,7 @@ function formatXml(xml) {
   return formatted.substring(1, formatted.length - 3);
 }
 function Response({ item }) {
-  const metadata = (0, internal_1.useDoc)();
+  const metadata = (0, client_1.useDoc)();
   const hideSendButton = metadata.frontMatter.hide_send_button;
   const prismTheme = (0, theme_common_1.usePrismTheme)();
   const code = (0, hooks_1.useTypedSelector)((state) => state.response.code);

package/lib/theme/ApiItem/index.js

@@ -17,15 +17,15 @@ const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
 const ExecutionEnvironment_1 = __importDefault(
   require("@docusaurus/ExecutionEnvironment")
 );
+const client_1 = require("@docusaurus/plugin-content-docs/client");
 const theme_common_1 = require("@docusaurus/theme-common");
-const internal_1 = require("@docusaurus/theme-common/internal");
 const useDocusaurusContext_1 = __importDefault(
   require("@docusaurus/useDocusaurusContext")
 );
 const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
 const slice_1 = require("@theme/ApiExplorer/Authorization/slice");
 const persistanceMiddleware_1 = require("@theme/ApiExplorer/persistanceMiddleware");
-const Layout_1 = __importDefault(require("@theme/ApiItem/Layout"));
+const Layout_1 = __importDefault(require("@theme/DocItem/Layout"));
 const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
 const clsx_1 = __importDefault(require("clsx"));
 const react_redux_1 = require("react-redux");
@@ -122,7 +122,7 @@ function ApiItem(props) {
   }
   if (api) {
     return react_1.default.createElement(
-      internal_1.DocProvider,
+      client_1.DocProvider,
       { content: props.content },
       react_1.default.createElement(
         theme_common_1.HtmlClassNameProvider,
@@ -169,7 +169,7 @@ function ApiItem(props) {
     );
   } else if (schema) {
     return react_1.default.createElement(
-      internal_1.DocProvider,
+      client_1.DocProvider,
       { content: props.content },
       react_1.default.createElement(
         theme_common_1.HtmlClassNameProvider,
@@ -193,7 +193,7 @@ function ApiItem(props) {
   }
   // Non-API docs
   return react_1.default.createElement(
-    internal_1.DocProvider,
+    client_1.DocProvider,
     { content: props.content },
     react_1.default.createElement(
       theme_common_1.HtmlClassNameProvider,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -42,7 +42,7 @@
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "^3.0.2",
+    "docusaurus-plugin-openapi-docs": "^4.0.0",
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
@@ -69,5 +69,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "071a66e28184054dde1df825509c731bf819a3ed"
+  "gitHead": "79d74177cfd54d2750dde1e15c6ea166f9ca4be9"
 }

package/src/plugin-content-docs.d.ts

@@ -0,0 +1,18 @@
+/* ============================================================================
+ * 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/plugin-content-docs/client" {
+  export function DocProvider({
+    children,
+    content,
+  }: {
+    children: ReactNode;
+    content: PropDocContent;
+  });
+}

package/src/theme/ApiExplorer/Request/index.tsx

@@ -8,7 +8,7 @@
 // @ts-nocheck
 import React, { useState } from "react";
 
-import { useDoc } from "@docusaurus/theme-common/internal";
+import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import Accept from "@theme/ApiExplorer/Accept";
 import Authorization from "@theme/ApiExplorer/Authorization";
 import Body from "@theme/ApiExplorer/Body";
@@ -31,7 +31,7 @@ import { FormProvider, useForm } from "react-hook-form";
 
 import makeRequest from "./makeRequest";
 
-function Request({ item }: { item: NonNullable<ApiItem> }) {
+function Request({ item }: { item: ApiItem }) {
   const postman = new sdk.Request(item.postman);
   const metadata = useDoc();
   const { proxy, hide_send_button: hideSendButton } = metadata.frontMatter;

package/src/theme/ApiExplorer/Response/index.tsx

@@ -7,8 +7,9 @@
 
 import React from "react";
 
+// @ts-ignore
+import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import { usePrismTheme } from "@docusaurus/theme-common";
-import { useDoc } from "@docusaurus/theme-common/internal";
 import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import SchemaTabs from "@theme/SchemaTabs";
@@ -38,7 +39,7 @@ function formatXml(xml: string) {
   return formatted.substring(1, formatted.length - 3);
 }
 
-function Response({ item }: { item: NonNullable<ApiItem> }) {
+function Response({ item }: { item: ApiItem }) {
   const metadata = useDoc();
   const hideSendButton = metadata.frontMatter.hide_send_button;
   const prismTheme = usePrismTheme();

package/src/theme/ApiItem/index.tsx

@@ -11,14 +11,14 @@ import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
+import { DocProvider } from "@docusaurus/plugin-content-docs/client";
 import { HtmlClassNameProvider } from "@docusaurus/theme-common";
-import { DocProvider } from "@docusaurus/theme-common/internal";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import { createAuth } from "@theme/ApiExplorer/Authorization/slice";
 import { createPersistanceMiddleware } from "@theme/ApiExplorer/persistanceMiddleware";
-import DocItemLayout from "@theme/ApiItem/Layout";
 import type { Props } from "@theme/DocItem";
+import DocItemLayout from "@theme/DocItem/Layout";
 import DocItemMetadata from "@theme/DocItem/Metadata";
 import clsx from "clsx";
 import { ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";

package/lib/theme/ApiItem/Layout/index.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="@docusaurus/theme-classic" />
-/// <reference types="react" />
-import type { Props } from "@theme/DocItem/Layout";
-export default function DocItemLayout({ children }: Props): JSX.Element;

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

@@ -1,114 +0,0 @@
-"use strict";
-/* ============================================================================
- * 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.
- * ========================================================================== */
-var __importDefault =
-  (this && this.__importDefault) ||
-  function (mod) {
-    return mod && mod.__esModule ? mod : { default: mod };
-  };
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const theme_common_1 = require("@docusaurus/theme-common");
-const internal_1 = require("@docusaurus/theme-common/internal");
-const DocBreadcrumbs_1 = __importDefault(require("@theme/DocBreadcrumbs"));
-const Content_1 = __importDefault(require("@theme/DocItem/Content"));
-const Footer_1 = __importDefault(require("@theme/DocItem/Footer"));
-const Paginator_1 = __importDefault(require("@theme/DocItem/Paginator"));
-const Desktop_1 = __importDefault(require("@theme/DocItem/TOC/Desktop"));
-const Mobile_1 = __importDefault(require("@theme/DocItem/TOC/Mobile"));
-const DocVersionBadge_1 = __importDefault(require("@theme/DocVersionBadge"));
-const DocVersionBanner_1 = __importDefault(require("@theme/DocVersionBanner"));
-const Unlisted_1 = __importDefault(require("@theme/Unlisted"));
-const clsx_1 = __importDefault(require("clsx"));
-const styles_module_css_1 = __importDefault(require("./styles.module.css"));
-/**
- * Decide if the toc should be rendered, on mobile or desktop viewports
- */
-function useDocTOC() {
-  const { frontMatter, toc } = (0, internal_1.useDoc)();
-  const windowSize = (0, theme_common_1.useWindowSize)();
-  const hidden = frontMatter.hide_table_of_contents;
-  const canRender = !hidden && toc.length > 0;
-  const mobile = canRender
-    ? react_1.default.createElement(Mobile_1.default, null)
-    : undefined;
-  const desktop =
-    canRender && (windowSize === "desktop" || windowSize === "ssr")
-      ? react_1.default.createElement(Desktop_1.default, null)
-      : undefined;
-  return {
-    hidden,
-    mobile,
-    desktop,
-  };
-}
-function DocItemLayout({ children }) {
-  const docTOC = useDocTOC();
-  const {
-    metadata: { unlisted },
-    frontMatter: { api },
-  } = (0, internal_1.useDoc)();
-  return react_1.default.createElement(
-    "div",
-    { className: "row" },
-    react_1.default.createElement(
-      "div",
-      {
-        className: (0, clsx_1.default)(
-          "col",
-          !docTOC.hidden && styles_module_css_1.default.docItemCol
-        ),
-      },
-      unlisted && react_1.default.createElement(Unlisted_1.default, null),
-      react_1.default.createElement(DocVersionBanner_1.default, null),
-      react_1.default.createElement(
-        "div",
-        { className: styles_module_css_1.default.docItemContainer },
-        react_1.default.createElement(
-          "article",
-          null,
-          react_1.default.createElement(DocBreadcrumbs_1.default, null),
-          react_1.default.createElement(DocVersionBadge_1.default, null),
-          docTOC.mobile,
-          react_1.default.createElement(Content_1.default, null, children),
-          react_1.default.createElement(
-            "div",
-            { className: "row" },
-            react_1.default.createElement(
-              "div",
-              {
-                className: (0, clsx_1.default)(
-                  "col",
-                  api ? "col--7" : "col--12"
-                ),
-              },
-              react_1.default.createElement(Footer_1.default, null)
-            )
-          )
-        ),
-        react_1.default.createElement(
-          "div",
-          { className: "row" },
-          react_1.default.createElement(
-            "div",
-            {
-              className: (0, clsx_1.default)("col", api ? "col--7" : "col--12"),
-            },
-            react_1.default.createElement(Paginator_1.default, null)
-          )
-        )
-      )
-    ),
-    docTOC.desktop &&
-      react_1.default.createElement(
-        "div",
-        { className: "col col--3" },
-        docTOC.desktop
-      )
-  );
-}
-exports.default = DocItemLayout;

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

@@ -1,17 +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.
- */
-
-.docItemContainer header + *,
-.docItemContainer article > *:first-child {
-  margin-top: 0;
-}
-
-@media (min-width: 997px) {
-  .docItemCol {
-    max-width: 75% !important;
-  }
-}

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

@@ -1,84 +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 { useWindowSize } from "@docusaurus/theme-common";
-import { useDoc } from "@docusaurus/theme-common/internal";
-import DocBreadcrumbs from "@theme/DocBreadcrumbs";
-import DocItemContent from "@theme/DocItem/Content";
-import DocItemFooter from "@theme/DocItem/Footer";
-import type { Props } from "@theme/DocItem/Layout";
-import DocItemPaginator from "@theme/DocItem/Paginator";
-import DocItemTOCDesktop from "@theme/DocItem/TOC/Desktop";
-import DocItemTOCMobile from "@theme/DocItem/TOC/Mobile";
-import DocVersionBadge from "@theme/DocVersionBadge";
-import DocVersionBanner from "@theme/DocVersionBanner";
-import Unlisted from "@theme/Unlisted";
-import clsx from "clsx";
-
-import styles from "./styles.module.css";
-
-/**
- * Decide if the toc should be rendered, on mobile or desktop viewports
- */
-function useDocTOC() {
-  const { frontMatter, toc } = useDoc();
-  const windowSize = useWindowSize();
-
-  const hidden = frontMatter.hide_table_of_contents;
-  const canRender = !hidden && toc.length > 0;
-
-  const mobile = canRender ? <DocItemTOCMobile /> : undefined;
-
-  const desktop =
-    canRender && (windowSize === "desktop" || windowSize === "ssr") ? (
-      <DocItemTOCDesktop />
-    ) : undefined;
-
-  return {
-    hidden,
-    mobile,
-    desktop,
-  };
-}
-
-export default function DocItemLayout({ children }: Props): JSX.Element {
-  const docTOC = useDocTOC();
-  const {
-    metadata: { unlisted },
-    frontMatter: { api },
-  } = useDoc();
-
-  return (
-    <div className="row">
-      <div className={clsx("col", !docTOC.hidden && styles.docItemCol)}>
-        {unlisted && <Unlisted />}
-        <DocVersionBanner />
-        <div className={styles.docItemContainer}>
-          <article>
-            <DocBreadcrumbs />
-            <DocVersionBadge />
-            {docTOC.mobile}
-            <DocItemContent>{children}</DocItemContent>
-            <div className="row">
-              <div className={clsx("col", api ? "col--7" : "col--12")}>
-                <DocItemFooter />
-              </div>
-            </div>
-          </article>
-          <div className="row">
-            <div className={clsx("col", api ? "col--7" : "col--12")}>
-              <DocItemPaginator />
-            </div>
-          </div>
-        </div>
-      </div>
-      {docTOC.desktop && <div className="col col--3">{docTOC.desktop}</div>}
-    </div>
-  );
-}

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

@@ -1,17 +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.
- */
-
-.docItemContainer header + *,
-.docItemContainer article > *:first-child {
-  margin-top: 0;
-}
-
-@media (min-width: 997px) {
-  .docItemCol {
-    max-width: 75% !important;
-  }
-}