docusaurus-theme-openapi-docs 1.2.2 → 1.3.1

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

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 import React, { useState } from "react";
+import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import FloatingButton from "../FloatingButton";
-import { useTypedDispatch, useTypedSelector } from "../hooks";
 import FormItem from "./../FormItem";
 import FormSelect from "./../FormSelect";
 import FormTextInput from "./../FormTextInput";
@@ -27,6 +27,20 @@ function Server() {
     return null;
   }
 
+  if (!value) {
+    const defaultOption = options[0];
+    dispatch(setServer(JSON.stringify(defaultOption)));
+  } // Default to first option when existing server state is mismatched
+
+  if (value) {
+    const urlExists = options.find((s) => s.url === value.url);
+
+    if (!urlExists) {
+      const defaultOption = options[0];
+      dispatch(setServer(JSON.stringify(defaultOption)));
+    }
+  }
+
   if (!isEditing) {
     let url = "";
 
@@ -65,7 +79,15 @@ function Server() {
         <FormItem label="Base URL">
           <FormSelect
             options={options.map((s) => s.url)}
-            onChange={(e) => dispatch(setServer(e.target.value))}
+            onChange={(e) => {
+              dispatch(
+                setServer(
+                  JSON.stringify(
+                    options.filter((s) => s.url === e.target.value)[0]
+                  )
+                )
+              );
+            }}
             value={value?.url}
           />
           <small>{value?.description}</small>
@@ -79,12 +101,15 @@ function Server() {
                     options={value.variables[key].enum}
                     onChange={(e) => {
                       dispatch(
-                        setServerVariable({
-                          key,
-                          value: e.target.value,
-                        })
+                        setServerVariable(
+                          JSON.stringify({
+                            key,
+                            value: e.target.value,
+                          })
+                        )
                       );
                     }}
+                    value={value?.variables[key].default}
                   />
                 </FormItem>
               );
@@ -96,12 +121,15 @@ function Server() {
                   placeholder={value.variables?.[key].default}
                   onChange={(e) => {
                     dispatch(
-                      setServerVariable({
-                        key,
-                        value: e.target.value,
-                      })
+                      setServerVariable(
+                        JSON.stringify({
+                          key,
+                          value: e.target.value,
+                        })
+                      )
                     );
                   }}
+                  value={value?.variables?.[key].default}
                 />
               </FormItem>
             );

package/lib-next/theme/ApiDemoPanel/Server/slice.js

@@ -11,12 +11,14 @@ export const slice = createSlice({
   initialState,
   reducers: {
     setServer: (state, action) => {
-      state.value = state.options.find((s) => s.url === action.payload);
+      state.value = state.options.find(
+        (s) => s.url === JSON.parse(action.payload).url
+      );
     },
     setServerVariable: (state, action) => {
       if (state.value?.variables) {
-        state.value.variables[action.payload.key].default =
-          action.payload.value;
+        const parsedPayload = JSON.parse(action.payload);
+        state.value.variables[parsedPayload.key].default = parsedPayload.value;
       }
     },
   },

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

@@ -5,87 +5,25 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 import React from "react";
-import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import sdk from "@paloaltonetworks/postman-collection";
-import { Provider } from "react-redux";
-import { createAuth } from "./Authorization/slice";
 import Curl from "./Curl";
 import MethodEndpoint from "./MethodEndpoint";
-import { createPersistanceMiddleware } from "./persistanceMiddleware";
 import Request from "./Request";
 import Response from "./Response";
 import SecuritySchemes from "./SecuritySchemes";
-import { createStoreWithState } from "./store";
 import styles from "./styles.module.css";
 
 function ApiDemoPanel({ item, infoPath }) {
-  const { siteConfig } = useDocusaurusContext();
-  const themeConfig = siteConfig.themeConfig;
-  const options = themeConfig.api;
   const postman = new sdk.Request(item.postman);
-  const acceptArray = Array.from(
-    new Set(
-      Object.values(item.responses ?? {})
-        .map((response) => Object.keys(response.content ?? {}))
-        .flat()
-    )
-  );
-  const content = item.requestBody?.content ?? {};
-  const contentTypeArray = Object.keys(content);
-  const servers = item.servers ?? [];
-  const params = {
-    path: [],
-    query: [],
-    header: [],
-    cookie: [],
-  };
-  item.parameters?.forEach((param) => {
-    const paramType = param.in;
-    const paramsArray = params[paramType];
-    paramsArray.push(param);
-  });
-  const auth = createAuth({
-    security: item.security,
-    securitySchemes: item.securitySchemes,
-    options,
-  });
-  const persistanceMiddleware = createPersistanceMiddleware(options);
-  const store2 = createStoreWithState(
-    {
-      accept: {
-        value: acceptArray[0],
-        options: acceptArray,
-      },
-      contentType: {
-        value: contentTypeArray[0],
-        options: contentTypeArray,
-      },
-      server: {
-        value: servers[0],
-        options: servers,
-      },
-      response: {
-        value: undefined,
-      },
-      body: {
-        type: "empty",
-      },
-      params,
-      auth,
-    },
-    [persistanceMiddleware]
-  );
   const { path, method } = item;
   return (
-    <Provider store={store2}>
-      <div className={styles.apiDemoPanelContainer}>
-        <MethodEndpoint method={method} path={path} />
-        <SecuritySchemes infoPath={infoPath} />
-        <Request item={item} />
-        <Response />
-        <Curl postman={postman} codeSamples={item["x-code-samples"] ?? []} />
-      </div>
-    </Provider>
+    <div className={styles.apiDemoPanelContainer}>
+      <MethodEndpoint method={method} path={path} />
+      <SecuritySchemes infoPath={infoPath} />
+      <Request item={item} />
+      <Response />
+      <Curl postman={postman} codeSamples={item["x-code-samples"] ?? []} />
+    </div>
   );
 }
 

package/lib-next/theme/ApiDemoPanel/persistanceMiddleware.js

@@ -31,6 +31,26 @@ export function createPersistanceMiddleware(options) {
       }
     }
 
+    if (action.type === "contentType/setContentType") {
+      storage.setItem("contentType", action.payload);
+    }
+
+    if (action.type === "accept/setAccept") {
+      storage.setItem("accept", action.payload);
+    }
+
+    if (action.type === "server/setServer") {
+      storage.setItem("server", action.payload);
+    }
+
+    if (action.type === "server/setServerVariable") {
+      const server = storage.getItem("server") ?? "{}";
+      const variables = JSON.parse(action.payload);
+      let serverObject = JSON.parse(server);
+      serverObject.variables[variables.key].default = variables.value;
+      storage.setItem("server", JSON.stringify(serverObject));
+    }
+
     return result;
   };
 

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

@@ -154,12 +154,15 @@
   margin-bottom: 0;
 }
 
-:global(.theme-api-markdown li::before) {
+:global([class^="paramsItem"]::before),
+:global([class^="schemaItem"]::before) {
   position: absolute;
   top: 10px;
   left: 0;
-  width: 0.7rem; /* width of horizontal line */
-  height: 0.5rem; /* vertical position of line */
+  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: "";
@@ -410,3 +413,8 @@
   max-height: 500px;
   overflow: auto;
 }
+
+/* Prism code styles */
+:global(.prism-code.language-json) {
+  white-space: pre !important;
+}

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

@@ -7,9 +7,14 @@
 import React from "react";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { HtmlClassNameProvider } from "@docusaurus/theme-common";
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import clsx from "clsx";
+import { Provider } from "react-redux";
+import { createAuth } from "../ApiDemoPanel/Authorization/slice";
+import { createPersistanceMiddleware } from "../ApiDemoPanel/persistanceMiddleware";
 import DocItemLayout from "./Layout";
 import DocItemMetadata from "./Metadata";
+import { createStoreWithState } from "./store";
 
 const { DocProvider } = require("@docusaurus/theme-common/internal");
 
@@ -21,40 +26,113 @@ let ApiDemoPanel = (_) => (
   />
 );
 
+let DocItem = (props) => {
+  return (
+    <div
+      style={{
+        marginTop: "3.5em",
+      }}
+    />
+  );
+};
+
 if (ExecutionEnvironment.canUseDOM) {
   ApiDemoPanel = require("@theme/ApiDemoPanel").default;
-}
-
-export default function DocItem(props) {
-  const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
 
-  const DocContent = () => {
+  DocItem = function DocItem(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;
-    return (
-      <div className="row">
-        <div className={clsx("col", api ? "col--7" : "col--12")}>
-          <MDXComponent />
-        </div>
-        {api && (
-          <div className="col col--5">
-            <ApiDemoPanel item={api} infoPath={infoPath} />
+    const { siteConfig } = useDocusaurusContext();
+    const themeConfig = siteConfig.themeConfig;
+    const options = themeConfig.api;
+    const acceptArray = Array.from(
+      new Set(
+        Object.values(api?.responses ?? {})
+          .map((response) => Object.keys(response.content ?? {}))
+          .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,
+    });
+    const persistanceMiddleware = createPersistanceMiddleware(options);
+    const acceptValue = window?.sessionStorage.getItem("accept");
+    const contentTypeValue = window?.sessionStorage.getItem("contentType");
+    const server = window?.sessionStorage.getItem("server");
+    const serverObject = JSON.parse(server) ?? {};
+    const store2 = createStoreWithState(
+      {
+        accept: {
+          value: acceptValue || acceptArray[0],
+          options: acceptArray,
+        },
+        contentType: {
+          value: contentTypeValue || contentTypeArray[0],
+          options: contentTypeArray,
+        },
+        server: {
+          value: serverObject.url ? serverObject : undefined,
+          options: servers,
+        },
+        response: {
+          value: undefined,
+        },
+        body: {
+          type: "empty",
+        },
+        params,
+        auth,
+      },
+      [persistanceMiddleware]
+    );
+
+    const DocContent = () => {
+      return (
+        <div className="row">
+          <div className={clsx("col", api ? "col--7" : "col--12")}>
+            <MDXComponent />
           </div>
-        )}
-      </div>
+          {api && (
+            <div className="col col--5">
+              <ApiDemoPanel item={api} infoPath={infoPath} />
+            </div>
+          )}
+        </div>
+      );
+    };
+
+    return (
+      <Provider store={store2}>
+        <DocProvider content={props.content}>
+          <HtmlClassNameProvider className={docHtmlClassName}>
+            <DocItemMetadata />
+            <DocItemLayout>
+              <DocContent />
+            </DocItemLayout>
+          </HtmlClassNameProvider>
+        </DocProvider>
+      </Provider>
     );
   };
-
-  return (
-    <DocProvider content={props.content}>
-      <HtmlClassNameProvider className={docHtmlClassName}>
-        <DocItemMetadata />
-        <DocItemLayout>
-          <DocContent />
-        </DocItemLayout>
-      </HtmlClassNameProvider>
-    </DocProvider>
-  );
 }
+
+export default DocItem;

package/lib-next/theme/{ApiDemoPanel → ApiItem}/store.js

@@ -5,13 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 import { configureStore, combineReducers } from "@reduxjs/toolkit";
-import accept from "./Accept/slice";
-import auth from "./Authorization/slice";
-import body from "./Body/slice";
-import contentType from "./ContentType/slice";
-import params from "./ParamOptions/slice";
-import response from "./Response/slice";
-import server from "./Server/slice";
+import accept from "../ApiDemoPanel/Accept/slice";
+import auth from "../ApiDemoPanel/Authorization/slice";
+import body from "../ApiDemoPanel/Body/slice";
+import contentType from "../ApiDemoPanel/ContentType/slice";
+import params from "../ApiDemoPanel/ParamOptions/slice";
+import response from "../ApiDemoPanel/Response/slice";
+import server from "../ApiDemoPanel/Server/slice";
 const rootReducer = combineReducers({
   accept,
   contentType,

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

@@ -18,6 +18,9 @@ import { duplicates } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import clsx from "clsx";
 
+import { setAccept } from "../ApiDemoPanel/Accept/slice";
+import { setContentType } from "../ApiDemoPanel/ContentType/slice";
+import { useTypedDispatch, useTypedSelector } from "../ApiItem/hooks";
 import styles from "./styles.module.css"; // A very rough duck type, but good enough to guard against mistakes while
 
 const {
@@ -39,6 +42,7 @@ function MimeTabsComponent(props) {
     values: valuesProp,
     groupId,
     className,
+    schemaType,
   } = props;
   const children = Children.map(props.children, (child) => {
     if (isValidElement(child) && isTabItem(child)) {
@@ -105,12 +109,22 @@ function MimeTabsComponent(props) {
     }
   }
 
+  const dispatch = useTypedDispatch();
+  const isRequestSchema = schemaType?.toLowerCase() === "request";
+
   const handleTabChange = (event) => {
+    event.preventDefault();
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
     const newTabValue = values[newTabIndex].value;
 
     if (newTabValue !== selectedValue) {
+      if (isRequestSchema) {
+        dispatch(setContentType(newTabValue));
+      } else {
+        dispatch(setAccept(newTabValue));
+      }
+
       blockElementScrollPositionUntilNextRender(newTab);
       setSelectedValue(newTabValue);
 
@@ -120,6 +134,20 @@ function MimeTabsComponent(props) {
     }
   };
 
+  const contentTypeVal = useTypedSelector((state) => state.contentType.value);
+  const acceptTypeVal = useTypedSelector((state) => state.accept.value);
+
+  useEffect(() => {
+    if (tabRefs.length > 1) {
+      if (isRequestSchema) {
+        setSelectedValue(contentTypeVal);
+      } else {
+        setSelectedValue(acceptTypeVal);
+      }
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [contentTypeVal, acceptTypeVal]);
+
   const handleKeydown = (event) => {
     let focusElement = null;
 
@@ -197,7 +225,7 @@ function MimeTabsComponent(props) {
                   ref={(tabControl) => tabRefs.push(tabControl)}
                   onKeyDown={handleKeydown}
                   onFocus={handleTabChange}
-                  onClick={handleTabChange}
+                  onClick={(e) => handleTabChange(e)}
                   {...attributes}
                   className={clsx(
                     "tabs__item",

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

@@ -17,6 +17,7 @@
   font-weight: var(--ifm-font-weight-normal);
   /* color: var(--openapi-code-dim-dark); */
   font-size: 12px;
+  white-space: nowrap;
 }
 
 .tabItem:active {

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

@@ -9,6 +9,7 @@ import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
 import ReactMarkdown from "react-markdown";
+import rehypeRaw from "rehype-raw";
 
 import { createDescription } from "../../markdown/createDescription";
 import { getQualifierMessage, getSchemaName } from "../../markdown/schema";
@@ -28,7 +29,10 @@ function ParamsItem({
 
   const renderSchema = guard(getQualifierMessage(schema), (message) => (
     <div>
-      <ReactMarkdown children={createDescription(message)} />
+      <ReactMarkdown
+        children={createDescription(message)}
+        rehypePlugins={[rehypeRaw]}
+      />
     </div>
   ));
 
@@ -48,6 +52,7 @@ function ParamsItem({
             );
           },
         }}
+        rehypePlugins={[rehypeRaw]}
       />
     </div>
   ));

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

@@ -9,6 +9,7 @@ import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
 import ReactMarkdown from "react-markdown";
+import rehypeRaw from "rehype-raw";
 
 import { createDescription } from "../../markdown/createDescription";
 import { guard } from "../../markdown/utils";
@@ -45,13 +46,17 @@ function SchemaItem({
             );
           },
         }}
+        rehypePlugins={[rehypeRaw]}
       />
     </div>
   ));
 
   const renderQualifierMessage = guard(qualifierMessage, (message) => (
     <div className={styles.schemaQualifierMessage}>
-      <ReactMarkdown children={createDescription(message)} />
+      <ReactMarkdown
+        children={createDescription(message)}
+        rehypePlugins={[rehypeRaw]}
+      />
     </div>
   ));
 

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

@@ -227,7 +227,10 @@ function SchemaTabsComponent(props) {
         cloneElement(
           children.filter(
             (tabItem) => tabItem.props.value === selectedValue
-          )[0],
+          )[0] ?? // TODO: see if there's a better way to handle this
+            children.filter(
+              (tabItem) => tabItem.props.value === defaultValue
+            )[0],
           {
             className: "margin-vert--md",
           }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "1.2.2",
+  "version": "1.3.1",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -50,7 +50,7 @@
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "^1.2.2",
+    "docusaurus-plugin-openapi-docs": "^1.3.1",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "process": "^0.11.10",
@@ -60,6 +60,7 @@
     "react-modal": "^3.15.1",
     "react-redux": "^7.2.0",
     "redux-devtools-extension": "^2.13.8",
+    "rehype-raw": "^6.1.1",
     "webpack": "^5.61.0",
     "xml-formatter": "^2.6.1"
   },
@@ -70,5 +71,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "cfeb5216f143133a1c35587fef21f75a44b75854"
+  "gitHead": "5f41e8dc4981409902ae96a7d127a2ae7eb9a47d"
 }

package/src/theme/ApiDemoPanel/Accept/index.tsx

@@ -7,7 +7,7 @@
 
 import React from "react";
 
-import { useTypedDispatch, useTypedSelector } from "../hooks";
+import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import FormItem from "./../FormItem";
 import FormSelect from "./../FormSelect";
 import { setAccept } from "./slice";

package/src/theme/ApiDemoPanel/Authorization/index.tsx

@@ -7,10 +7,10 @@
 
 import React from "react";
 
+import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import FormItem from "../FormItem";
 import FormSelect from "../FormSelect";
 import FormTextInput from "../FormTextInput";
-import { useTypedDispatch, useTypedSelector } from "../hooks";
 import { setAuthData, setSelectedAuth } from "./slice";
 
 function Authorization() {