npm - docusaurus-theme-openapi-docs - Versions diffs - 1.1.12 → 1.2.1 - Mend

docusaurus-theme-openapi-docs 1.1.12 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (67) hide show

package/src/theme/ApiDemoPanel/buildPostmanRequest.ts CHANGED Viewed

@@ -261,6 +261,25 @@ function buildPostmanRequest(
       continue;
     }
+    if (a.type === "oauth2") {
+      let token;
+      if (auth.data[a.key]) {
+        token = auth.data[a.key].token;
+      }
+      if (token === undefined) {
+        otherHeaders.push({
+          key: "Authorization",
+          value: "Bearer <TOKEN>",
+        });
+        continue;
+      }
+      otherHeaders.push({
+        key: "Authorization",
+        value: `Bearer ${token}`,
+      });
+      continue;
+    }
     // Basic Auth
     if (a.type === "http" && a.scheme === "basic") {
       const { username, password } = auth.data[a.key];
@@ -276,8 +295,8 @@ function buildPostmanRequest(
     // API Key
     if (a.type === "apiKey" && a.in === "header") {
-      const { apikey } = auth.data[a.key];
-      if (apikey === undefined) {
+      const { apiKey } = auth.data[a.key];
+      if (apiKey === undefined) {
         otherHeaders.push({
           key: a.name,
           value: "<API_KEY_VALUE>",
@@ -286,7 +305,7 @@ function buildPostmanRequest(
       }
       otherHeaders.push({
         key: a.name,
-        value: apikey,
+        value: apiKey,
       });
       continue;
     }

package/src/theme/ApiDemoPanel/index.tsx CHANGED Viewed

@@ -14,13 +14,11 @@ import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 import { Provider } from "react-redux";
 import { ThemeConfig } from "../../types";
-import Accept from "./Accept";
 import { createAuth } from "./Authorization/slice";
-import Body from "./Body";
 import Curl from "./Curl";
 import MethodEndpoint from "./MethodEndpoint";
-import ParamOptions from "./ParamOptions";
 import { createPersistanceMiddleware } from "./persistanceMiddleware";
+import Request from "./Request";
 import Response from "./Response";
 import SecuritySchemes from "./SecuritySchemes";
 import Server from "./Server";
@@ -95,21 +93,14 @@ function ApiDemoPanel({
     <Provider store={store2}>
       <div className={styles.apiDemoPanelContainer}>
         <MethodEndpoint method={method} path={path} />
-        <SecuritySchemes infoPath={infoPath} />
-        <div className={styles.optionsPanel}>
-          <ParamOptions />
-          <Body
-            jsonRequestBodyExample={item.jsonRequestBodyExample}
-            requestBodyMetadata={item.requestBody}
-          />
-          <Accept />
-        </div>
         <Server />
+        <SecuritySchemes infoPath={infoPath} />
+        <Request item={item} />
+        <Response />
         <Curl
           postman={postman}
           codeSamples={(item as any)["x-code-samples"] ?? []}
         />
-        <Response />
       </div>
     </Provider>
   );

package/src/theme/ApiDemoPanel/persistanceMiddleware.ts CHANGED Viewed

@@ -19,7 +19,7 @@ export function createPersistanceMiddleware(options: ThemeConfig["api"]) {
       const state = storeAPI.getState();
-      const storage = createStorage(options?.authPersistance);
+      const storage = createStorage("sessionStorage");
       if (action.type === setAuthData.type) {
         for (const [key, value] of Object.entries(state.auth.data)) {

package/src/theme/ApiDemoPanel/react-modal.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+declare module "react-modal";

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

@@ -71,6 +71,62 @@
   border-top: unset !important;
 }
+:global(.theme-api-markdown .details__demo-panel) {
+  margin-bottom: 1rem;
+  background: var(--openapi-card-background-color);
+  border-radius: var(--openapi-card-border-radius);
+}
+:global(.theme-api-markdown .details__demo-panel > summary) {
+  padding-left: 1rem;
+  padding-top: 1rem;
+  cursor: pointer;
+}
+:global(.theme-api-markdown .details__demo-panel > div > div > pre) {
+  border-top-left-radius: 0;
+  border-top-right-radius: 0;
+}
+:global(.theme-api-markdown .details__demo-panel > summary::marker) {
+  display: none;
+  content: "";
+}
+:global(.theme-api-markdown
+    .details__demo-panel
+    > summary::-webkit-details-marker) {
+  display: none;
+  content: "";
+}
+:global(.theme-api-markdown .details__demo-panel > pre) {
+  margin-bottom: 0;
+  padding-top: 0;
+}
+:global(.theme-api-markdown .details__request-summary) {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+:global(.theme-api-markdown .details__request-summary > button) {
+  margin-bottom: 1rem;
+  margin-right: 1rem;
+}
+:global(.theme-api-markdown .details__response-summary) {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+:global(.theme-api-markdown .details__response-summary > button) {
+  margin-bottom: 1rem;
+  margin-right: 1rem;
+}
 :global(.theme-api-markdown code) {
   max-width: 600px;
   max-height: 500px;

package/src/theme/ApiTabs/styles.module.css CHANGED Viewed

@@ -12,14 +12,19 @@
   height: 2.5rem;
   margin-top: 0 !important;
   margin-right: 0.5rem;
-  border: 1px solid var(--openapi-code-dim-dark);
+  border: 1px solid var(--ifm-color-primary);
   border-radius: var(--ifm-global-radius);
+  color: var(--ifm-color-primary);
   font-weight: var(--ifm-font-weight-normal);
-  color: var(--openapi-code-dim-dark);
+}
+.tabItem:not(.responseTabActive) {
+  opacity: 0.65;
 }
 .tabItem:hover {
-  color: var(--ifm-color-emphasis-500) !important;
+  opacity: 1;
+  background-color: var(--ifm-color-emphasis-100);
 }
 .tabItem:last-child {
@@ -74,8 +79,7 @@
 }
 .responseTabActive {
-  border: 1px solid var(--ifm-color-primary);
-  color: var(--ifm-color-primary);
+  background-color: var(--ifm-color-emphasis-100);
 }
 .responseSchemaContainer {

package/src/theme/ParamsItem/index.js CHANGED Viewed

@@ -53,7 +53,11 @@ function ParamsItem({
   ));
   const renderDefaultValue = guard(
-    schema.items ? schema.items.default : schema.default,
+    schema && schema.items
+      ? schema.items.default
+      : schema
+      ? schema.default
+      : undefined,
     (value) => (
       <div>
         <ReactMarkdown children={`**Default value:** \`${value}\``} />

package/src/theme/SchemaTabs/styles.module.css CHANGED Viewed

@@ -12,14 +12,19 @@
   height: 1.8rem;
   margin-top: 0 !important;
   margin-right: 0.5rem;
-  border: 1px solid var(--openapi-code-dim-dark);
+  border: 1px solid var(--ifm-color-primary);
   border-radius: var(--ifm-global-radius);
-  color: var(--openapi-code-dim-dark);
+  color: var(--ifm-color-primary);
   font-size: 12px;
 }
+.tabItem:not(.schemaTabActive) {
+  opacity: 0.65;
+}
 .tabItem:hover {
-  color: var(--ifm-color-emphasis-500) !important;
+  opacity: 1;
+  background-color: var(--ifm-color-emphasis-100);
 }
 .tabItem:last-child {
@@ -49,9 +54,8 @@
   display: none;
 }
-.tabItem.schemaTabActive {
-  border: 1px solid var(--ifm-color-primary);
-  color: var(--ifm-color-primary);
+.schemaTabActive {
+  background-color: var(--ifm-color-emphasis-100);
 }
 .schemaTabLabel {