docusaurus-theme-openapi-docs 1.2.2 → 1.3.0

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

@@ -13,11 +13,11 @@ import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/type
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 
 import { ThemeConfig } from "../../../types";
+import { useTypedSelector } from "../../ApiItem/hooks";
 import Accept from "../Accept";
 import Authorization from "../Authorization";
 import Body from "../Body";
 import Execute from "../Execute";
-import { useTypedSelector } from "../hooks";
 import ParamOptions from "../ParamOptions";
 import Server from "../Server";
 import styles from "./styles.module.css";

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

@@ -9,7 +9,7 @@ import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
 
-import { useTypedDispatch, useTypedSelector } from "../hooks";
+import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import { clearResponse } from "./slice";
 
 // TODO: We probably shouldn't attempt to format XML...

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

@@ -9,7 +9,7 @@ import React from "react";
 
 import Link from "@docusaurus/Link";
 
-import { useTypedSelector } from "../hooks";
+import { useTypedSelector } from "../../ApiItem/hooks";
 
 function SecuritySchemes(props: any) {
   const options = useTypedSelector((state) => state.auth.options);

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

@@ -7,8 +7,8 @@
 
 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";
@@ -19,7 +19,6 @@ function Server() {
   const [isEditing, setIsEditing] = useState(false);
   const value = useTypedSelector((state) => state.server.value);
   const options = useTypedSelector((state) => state.server.options);
-
   const dispatch = useTypedDispatch();
 
   if (options.length <= 0) {
@@ -30,6 +29,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 = "";
     if (value) {
@@ -58,14 +71,21 @@ function Server() {
       </FloatingButton>
     );
   }
-
   return (
     <div className={styles.optionsPanel}>
       <FloatingButton onClick={() => setIsEditing(false)} label="Hide">
         <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,9 +99,12 @@ 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>
               );
@@ -91,8 +114,13 @@ function Server() {
                 <FormTextInput
                   placeholder={value.variables?.[key].default}
                   onChange={(e) => {
-                    dispatch(setServerVariable({ key, value: e.target.value }));
+                    dispatch(
+                      setServerVariable(
+                        JSON.stringify({ key, value: e.target.value })
+                      )
+                    );
                   }}
+                  value={value?.variables?.[key].default}
                 />
               </FormItem>
             );

package/src/theme/ApiDemoPanel/Server/slice.ts

@@ -21,15 +21,14 @@ export const slice = createSlice({
   initialState,
   reducers: {
     setServer: (state, action: PayloadAction<string>) => {
-      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: PayloadAction<{ key: string; value: string }>
-    ) => {
+    setServerVariable: (state, action: PayloadAction<string>) => {
       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/src/theme/ApiDemoPanel/index.tsx

@@ -7,21 +7,14 @@
 
 import React from "react";
 
-import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import sdk from "@paloaltonetworks/postman-collection";
-import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
-import { Provider } from "react-redux";
 
-import { ThemeConfig } from "../../types";
-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({
@@ -31,76 +24,20 @@ function ApiDemoPanel({
   item: NonNullable<ApiItem>;
   infoPath: string;
 }) {
-  const { siteConfig } = useDocusaurusContext();
-  const themeConfig = siteConfig.themeConfig as ThemeConfig;
-  const options = themeConfig.api;
   const postman = new sdk.Request(item.postman);
-
-  const acceptArray = Array.from(
-    new Set(
-      Object.values(item.responses ?? {})
-        .map((response: any) => Object.keys(response.content ?? {}))
-        .flat()
-    )
-  );
-
-  const content = item.requestBody?.content ?? {};
-
-  const contentTypeArray = Object.keys(content);
-
-  const servers = item.servers ?? [];
-
-  const params = {
-    path: [] as ParameterObject[],
-    query: [] as ParameterObject[],
-    header: [] as ParameterObject[],
-    cookie: [] as ParameterObject[],
-  };
-
-  item.parameters?.forEach(
-    (param: { in: "path" | "query" | "header" | "cookie" }) => {
-      const paramType = param.in;
-      const paramsArray: ParameterObject[] = params[paramType];
-      paramsArray.push(param as ParameterObject);
-    }
-  );
-
-  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 as any)["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 as any)["x-code-samples"] ?? []}
+      />
+    </div>
   );
 }
 

package/src/theme/ApiDemoPanel/persistanceMiddleware.ts

@@ -8,9 +8,9 @@
 import { Middleware } from "@reduxjs/toolkit";
 
 import { ThemeConfig } from "../../types";
+import { AppDispatch, RootState } from "../ApiItem/store";
 import { setAuthData, setSelectedAuth } from "./Authorization/slice";
 import { createStorage, hashArray } from "./storage-utils";
-import { AppDispatch, RootState } from "./store";
 
 export function createPersistanceMiddleware(options: ThemeConfig["api"]) {
   const persistanceMiddleware: Middleware<{}, RootState, AppDispatch> =
@@ -40,6 +40,26 @@ export function createPersistanceMiddleware(options: ThemeConfig["api"]) {
         }
       }
 
+      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;
     };
   return persistanceMiddleware;

package/src/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/src/theme/ApiItem/index.tsx

@@ -9,58 +9,134 @@ import React from "react";
 
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { HtmlClassNameProvider } from "@docusaurus/theme-common";
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import type { Props } from "@theme/DocItem";
 import clsx from "clsx";
+import { ServerObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
 import type { ApiItem as ApiItemType } from "docusaurus-plugin-openapi-docs/lib/types";
+import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+import { Provider } from "react-redux";
 
 import { DocFrontMatter } from "../../types";
+import { ThemeConfig } from "../../types";
+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");
 
 let ApiDemoPanel = (_: { item: any; infoPath: any }) => (
   <div style={{ marginTop: "3.5em" }} />
 );
-if (ExecutionEnvironment.canUseDOM) {
-  ApiDemoPanel = require("@theme/ApiDemoPanel").default;
-}
+
+let DocItem = (props: Props) => {
+  return <div style={{ marginTop: "3.5em" }} />;
+};
 
 interface ApiFrontMatter extends DocFrontMatter {
   readonly api?: ApiItemType;
 }
 
-export default function DocItem(props: Props): JSX.Element {
-  const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
+if (ExecutionEnvironment.canUseDOM) {
+  ApiDemoPanel = require("@theme/ApiDemoPanel").default;
 
-  const DocContent = () => {
+  DocItem = function DocItem(props: Props): JSX.Element {
+    const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
     const MDXComponent = props.content;
     const { frontMatter } = MDXComponent;
     const { info_path: infoPath } = frontMatter as DocFrontMatter;
     const { api } = frontMatter as ApiFrontMatter;
+    const { siteConfig } = useDocusaurusContext();
+    const themeConfig = siteConfig.themeConfig as ThemeConfig;
+    const options = themeConfig.api;
 
-    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 acceptArray = Array.from(
+      new Set(
+        Object.values(api?.responses ?? {})
+          .map((response: any) => Object.keys(response.content ?? {}))
+          .flat()
+      )
+    );
+
+    const content = api?.requestBody?.content ?? {};
+    const contentTypeArray = Object.keys(content);
+    const servers = api?.servers ?? [];
+
+    const params = {
+      path: [] as ParameterObject[],
+      query: [] as ParameterObject[],
+      header: [] as ParameterObject[],
+      cookie: [] as ParameterObject[],
+    };
+
+    api?.parameters?.forEach(
+      (param: { in: "path" | "query" | "header" | "cookie" }) => {
+        const paramType = param.in;
+        const paramsArray: ParameterObject[] = params[paramType];
+        paramsArray.push(param as ParameterObject);
+      }
+    );
+
+    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!) as ServerObject) ?? {};
+    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/src/theme/{ApiDemoPanel → ApiItem}/store.ts

@@ -7,13 +7,13 @@
 
 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,

package/src/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/src/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/src/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",
           }