docusaurus-theme-openapi-docs 1.0.2 → 1.0.5

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

@@ -5,32 +5,35 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { useRef, useState, useEffect } from "react";
+import React, { useState, useEffect } from "react";
 
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import codegen from "@paloaltonetworks/postman-code-generators";
 import sdk from "@paloaltonetworks/postman-collection";
+import CodeBlock from "@theme/CodeBlock";
 import clsx from "clsx";
-import Highlight, { defaultProps } from "prism-react-renderer";
 
+import CodeTabs from "../CodeTabs";
 import { useTypedSelector } from "../hooks";
 import buildPostmanRequest from "./../buildPostmanRequest";
-import FloatingButton from "./../FloatingButton";
 import styles from "./styles.module.css";
 
 interface Language {
   tabName: string;
   highlight: string;
   language: string;
+  codeLanguage?: string;
   variant: string;
   options: { [key: string]: boolean };
+  source?: string;
 }
 
-const languageSet: Language[] = [
+export const languageSet: Language[] = [
   {
     tabName: "cURL",
     highlight: "bash",
     language: "curl",
+    codeLanguage: "bash",
     variant: "curl",
     options: {
       longFormat: false,
@@ -39,12 +42,12 @@ const languageSet: Language[] = [
     },
   },
   {
-    tabName: "Node",
-    highlight: "javascript",
-    language: "nodejs",
-    variant: "axios",
+    tabName: "Python",
+    highlight: "python",
+    language: "python",
+    codeLanguage: "python",
+    variant: "requests",
     options: {
-      ES6_enabled: true,
       followRedirect: true,
       trimRequestBody: true,
     },
@@ -53,6 +56,7 @@ const languageSet: Language[] = [
     tabName: "Go",
     highlight: "go",
     language: "go",
+    codeLanguage: "go",
     variant: "native",
     options: {
       followRedirect: true,
@@ -60,79 +64,41 @@ const languageSet: Language[] = [
     },
   },
   {
-    tabName: "Python",
-    highlight: "python",
-    language: "python",
-    variant: "requests",
+    tabName: "Node",
+    highlight: "javascript",
+    language: "nodejs",
+    codeLanguage: "javascript",
+    variant: "axios",
     options: {
+      ES6_enabled: true,
       followRedirect: true,
       trimRequestBody: true,
     },
   },
 ];
 
-const languageTheme = {
-  plain: {
-    color: "var(--ifm-code-color)",
-  },
-  styles: [
-    {
-      types: ["inserted", "attr-name"],
-      style: {
-        color: "var(--openapi-code-green)",
-      },
-    },
-    {
-      types: ["string", "url"],
-      style: {
-        color: "var(--openapi-code-green)",
-      },
-    },
-    {
-      types: ["builtin", "char", "constant", "function"],
-      style: {
-        color: "var(--openapi-code-blue)",
-      },
-    },
-    {
-      types: ["punctuation", "operator"],
-      style: {
-        color: "var(--openapi-code-dim)",
-      },
-    },
-    {
-      types: ["class-name"],
-      style: {
-        color: "var(--openapi-code-orange)",
-      },
-    },
-    {
-      types: ["tag", "arrow", "keyword"],
-      style: {
-        color: "var(--openapi-code-purple)",
-      },
-    },
-    {
-      types: ["boolean"],
-      style: {
-        color: "var(--openapi-code-red)",
-      },
-    },
-  ],
-};
-
 interface Props {
   postman: sdk.Request;
   codeSamples: any; // TODO: Type this...
 }
 
+function CodeTab({ children, hidden, className, onClick }: any): JSX.Element {
+  return (
+    <div
+      role="tabpanel"
+      className={clsx(styles.tabItem, className)}
+      {...{ hidden }}
+    >
+      {children}
+    </div>
+  );
+}
+
 function Curl({ postman, codeSamples }: Props) {
   // TODO: match theme for vscode.
 
   const { siteConfig } = useDocusaurusContext();
 
-  const [copyText, setCopyText] = useState("Copy");
-
   const contentType = useTypedSelector((state) => state.contentType.value);
   const accept = useTypedSelector((state) => state.accept.value);
   const server = useTypedSelector((state) => state.server.value);
@@ -152,7 +118,12 @@ function Curl({ postman, codeSamples }: Props) {
     ...codeSamples,
   ];
 
-  const [language, setLanguage] = useState(langs[0]);
+  const defaultLang: Language[] = languageSet.filter(
+    (lang) =>
+      lang.codeLanguage === localStorage.getItem("docusaurus.tab.code-samples")
+  );
+
+  const [language, setLanguage] = useState(defaultLang[0] ?? langs[0]);
 
   const [codeText, setCodeText] = useState("");
 
@@ -201,76 +172,26 @@ function Curl({ postman, codeSamples }: Props) {
     auth,
   ]);
 
-  const ref = useRef<HTMLDivElement>(null);
-
-  const handleCurlCopy = () => {
-    setCopyText("Copied");
-    setTimeout(() => {
-      setCopyText("Copy");
-    }, 2000);
-    if (ref.current?.innerText) {
-      navigator.clipboard.writeText(ref.current.innerText);
-    }
-  };
-
   if (language === undefined) {
     return null;
   }
 
   return (
     <>
-      <div className={clsx(styles.buttonGroup, "api-code-tab-group")}>
+      <CodeTabs groupId="code-samples" action={setLanguage}>
         {langs.map((lang) => {
           return (
-            <button
+            <CodeTab
+              value={lang.language}
+              label={""}
               key={lang.tabName || lang.label}
-              className={clsx(
-                language === lang ? styles.selected : undefined,
-                language === lang ? "api-code-tab--active" : undefined,
-                "api-code-tab"
-              )}
-              onClick={() => setLanguage(lang)}
+              attributes={{ className: `code__tab--${lang.codeLanguage}` }}
             >
-              {lang.tabName || lang.label}
-            </button>
+              <CodeBlock language={lang.codeLanguage}>{codeText}</CodeBlock>
+            </CodeTab>
           );
         })}
-      </div>
-
-      <Highlight
-        {...defaultProps}
-        theme={languageTheme}
-        code={codeText}
-        language={language.highlight || language.lang}
-      >
-        {({ className, tokens, getLineProps, getTokenProps }) => (
-          <FloatingButton onClick={handleCurlCopy} label={copyText}>
-            <pre
-              className={className}
-              style={{
-                background: "var(--openapi-card-background-color)",
-                paddingRight: "60px",
-                borderRadius:
-                  "2px 2px var(--openapi-card-border-radius) var(--openapi-card-border-radius)",
-              }}
-            >
-              <code ref={ref}>
-                {tokens.map((line, i) => (
-                  <span {...getLineProps({ line, key: i })}>
-                    {line.map((token, key) => {
-                      if (token.types.includes("arrow")) {
-                        token.types = ["arrow"];
-                      }
-                      return <span {...getTokenProps({ token, key })} />;
-                    })}
-                    {"\n"}
-                  </span>
-                ))}
-              </code>
-            </pre>
-          </FloatingButton>
-        )}
-      </Highlight>
+      </CodeTabs>
     </>
   );
 }

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

@@ -0,0 +1,59 @@
+/* ============================================================================
+ * 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 { usePrismTheme } from "@docusaurus/theme-common";
+import useIsBrowser from "@docusaurus/useIsBrowser";
+import { LiveProvider, LiveEditor, withLive } from "react-live";
+
+import { setStringRawBody } from "../Body/slice";
+import styles from "./styles.module.css";
+
+function Live({ onEdit }: any) {
+  const isBrowser = useIsBrowser();
+  return (
+    <>
+      <LiveEditor
+        key={String(isBrowser)}
+        className={styles.playgroundEditor}
+        onChange={onEdit}
+      />
+    </>
+  );
+}
+
+const LiveComponent = withLive(Live);
+
+function App({
+  children,
+  transformCode,
+  value,
+  language,
+  action,
+  ...props
+}: any): JSX.Element {
+  const prismTheme = usePrismTheme();
+  const [code, setCode] = React.useState(children);
+  action(setStringRawBody(code));
+  return (
+    <div className={styles.playgroundContainer}>
+      <LiveProvider
+        code={children.replace(/\n$/, "")}
+        transformCode={transformCode ?? ((code) => `${code};`)}
+        theme={prismTheme}
+        language={language}
+        {...props}
+      >
+        <LiveComponent onEdit={setCode} />
+      </LiveProvider>
+    </div>
+  );
+}
+
+const LiveApp = withLive(App);
+export default LiveApp;

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

@@ -0,0 +1,34 @@
+.playgroundContainer {
+  margin-top: 1rem;
+  margin-bottom: var(--ifm-leading);
+  border-radius: var(--ifm-global-radius);
+  box-shadow: var(--ifm-global-shadow-lw);
+  overflow: hidden;
+}
+
+.playgroundHeader {
+  letter-spacing: 0.08rem;
+  padding: 0.75rem;
+  text-transform: uppercase;
+  font-weight: bold;
+  background: var(--ifm-color-emphasis-200);
+  color: var(--ifm-color-content);
+  font-size: var(--ifm-code-font-size);
+}
+
+.playgroundHeader:first-of-type {
+  background: var(--ifm-color-emphasis-600);
+  color: var(--ifm-color-content-inverse);
+}
+
+.playgroundEditor {
+  font: var(--ifm-code-font-size) / var(--ifm-pre-line-height)
+    var(--ifm-font-family-monospace) !important;
+  /* rtl:ignore */
+  direction: ltr;
+}
+
+.playgroundPreview {
+  padding: 1rem;
+  background-color: var(--ifm-pre-background);
+}

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

@@ -15,14 +15,16 @@ function colorForMethod(method: string) {
   switch (method.toLowerCase()) {
     case "get":
       return "primary";
-    case "put":
-      return "warning";
-    case "patch":
-      return "warning";
     case "post":
       return "success";
     case "delete":
       return "danger";
+    case "put":
+      return "info";
+    case "patch":
+      return "warning";
+    case "head":
+      return "secondary";
     default:
       return undefined;
   }

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

@@ -7,11 +7,14 @@
 
 import React from "react";
 
+import Link from "@docusaurus/Link";
+
 import { useTypedSelector } from "../hooks";
 
-function SecuritySchemes() {
+function SecuritySchemes(props: any) {
   const options = useTypedSelector((state) => state.auth.options);
   const selected = useTypedSelector((state) => state.auth.selected);
+  const infoAuthPath = `/${props.infoPath}#authentication`;
 
   if (selected === undefined) return null;
 
@@ -28,7 +31,9 @@ function SecuritySchemes() {
         if (isApiKey || isBearer) {
           return (
             <React.Fragment key={selected}>
-              <b>Authorization: {auth.key}</b>
+              <b>
+                Authorization: <Link to={infoAuthPath}>{auth.key}</Link>
+              </b>
               <pre
                 style={{
                   display: "flex",

package/src/theme/ApiDemoPanel/index.tsx

@@ -27,7 +27,13 @@ import Server from "./Server";
 import { createStoreWithState } from "./store";
 import styles from "./styles.module.css";
 
-function ApiDemoPanel({ item }: { item: NonNullable<ApiItem> }) {
+function ApiDemoPanel({
+  item,
+  infoPath,
+}: {
+  item: NonNullable<ApiItem>;
+  infoPath: string;
+}) {
   const { siteConfig } = useDocusaurusContext();
   const themeConfig = siteConfig.themeConfig as ThemeConfig;
   const options = themeConfig.api;
@@ -89,9 +95,7 @@ function ApiDemoPanel({ item }: { item: NonNullable<ApiItem> }) {
     <Provider store={store2}>
       <div className={styles.apiDemoPanelContainer}>
         <MethodEndpoint method={method} path={path} />
-
-        <SecuritySchemes />
-
+        <SecuritySchemes infoPath={infoPath} />
         <div className={styles.optionsPanel}>
           <ParamOptions />
           <Body
@@ -100,14 +104,11 @@ function ApiDemoPanel({ item }: { item: NonNullable<ApiItem> }) {
           />
           <Accept />
         </div>
-
         <Server />
-
         <Curl
           postman={postman}
           codeSamples={(item as any)["x-code-samples"] ?? []}
         />
-
         <Response />
       </div>
     </Provider>

package/src/theme/ApiItem/icons/bash-original.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill="none" d="M4.24 4.24h119.53v119.53H4.24z"/><path fill="#293138" d="M109.01 28.64L71.28 6.24c-2.25-1.33-4.77-2-7.28-2s-5.03.67-7.28 2.01l-37.74 22.4c-4.5 2.67-7.28 7.61-7.28 12.96v44.8c0 5.35 2.77 10.29 7.28 12.96l37.73 22.4c2.25 1.34 4.76 2 7.28 2 2.51 0 5.03-.67 7.28-2l37.74-22.4c4.5-2.67 7.28-7.62 7.28-12.96V41.6c0-5.34-2.77-10.29-7.28-12.96zM79.79 98.59l.06 3.22c0 .39-.25.83-.55.99l-1.91 1.1c-.3.15-.56-.03-.56-.42l-.03-3.17c-1.63.68-3.29.84-4.34.42-.2-.08-.29-.37-.21-.71l.69-2.91c.06-.23.18-.46.34-.6.06-.06.12-.1.18-.13.11-.06.22-.07.31-.03 1.14.38 2.59.2 3.99-.5 1.78-.9 2.97-2.72 2.95-4.52-.02-1.64-.9-2.31-3.05-2.33-2.74.01-5.3-.53-5.34-4.57-.03-3.32 1.69-6.78 4.43-8.96l-.03-3.25c0-.4.24-.84.55-1l1.85-1.18c.3-.15.56.04.56.43l.03 3.25c1.36-.54 2.54-.69 3.61-.44.23.06.34.38.24.75l-.72 2.88c-.06.22-.18.44-.33.58a.77.77 0 01-.19.14c-.1.05-.19.06-.28.05-.49-.11-1.65-.36-3.48.56-1.92.97-2.59 2.64-2.58 3.88.02 1.48.77 1.93 3.39 1.97 3.49.06 4.99 1.58 5.03 5.09.05 3.44-1.79 7.15-4.61 9.41zm26.34-60.5l-35.7 22.05c-4.45 2.6-7.73 5.52-7.74 10.89v43.99c0 3.21 1.3 5.29 3.29 5.9-.65.11-1.32.19-1.98.19-2.09 0-4.15-.57-5.96-1.64l-37.73-22.4c-3.69-2.19-5.98-6.28-5.98-10.67V41.6c0-4.39 2.29-8.48 5.98-10.67l37.74-22.4c1.81-1.07 3.87-1.64 5.96-1.64s4.15.57 5.96 1.64l37.74 22.4c3.11 1.85 5.21 5.04 5.8 8.63-1.27-2.67-4.09-3.39-7.38-1.47z"/><path fill="#4FA847" d="M99.12 90.73l-9.4 5.62c-.25.15-.43.31-.43.61v2.46c0 .3.2.43.45.28l9.54-5.8c.25-.15.29-.42.29-.72v-2.17c0-.3-.2-.42-.45-.28z"/></svg>

package/src/theme/ApiItem/icons/go-original-wordmark.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><g fill="#00acd7" fill-rule="evenodd"><path d="M11.156 54.829c-.243 0-.303-.122-.182-.303l1.273-1.637c.12-.182.424-.303.666-.303H34.55c.243 0 .303.182.182.364l-1.03 1.576c-.121.181-.424.363-.606.363zM2.004 60.404c-.242 0-.303-.12-.182-.303l1.273-1.636c.121-.182.424-.303.667-.303h27.636c.242 0 .364.182.303.364l-.485 1.454c-.06.243-.303.364-.545.364zM16.67 65.98c-.242 0-.302-.182-.181-.364l.848-1.515c.122-.182.364-.363.607-.363h12.12c.243 0 .364.181.364.424l-.12 1.454c0 .243-.243.425-.425.425zM79.58 53.738c-3.819.97-6.425 1.697-10.182 2.666-.91.243-.97.303-1.758-.606-.909-1.03-1.576-1.697-2.848-2.303-3.819-1.878-7.516-1.333-10.97.91-4.121 2.666-6.242 6.605-6.182 11.514.06 4.849 3.394 8.849 8.182 9.516 4.121.545 7.576-.91 10.303-4 .545-.667 1.03-1.394 1.636-2.243H56.064c-1.272 0-1.575-.788-1.151-1.818.788-1.879 2.242-5.03 3.09-6.606.183-.364.607-.97 1.516-.97h22.06c-.12 1.637-.12 3.273-.363 4.91-.667 4.363-2.303 8.363-4.97 11.878-4.364 5.758-10.06 9.333-17.273 10.303-5.939.788-11.454-.364-16.302-4-4.485-3.394-7.03-7.879-7.697-13.454-.788-6.606 1.151-12.546 5.151-17.758 4.303-5.636 10-9.212 16.97-10.485 5.697-1.03 11.151-.363 16.06 2.97 3.212 2.121 5.515 5.03 7.03 8.545.364.546.122.849-.606 1.03z"/><path d="M99.64 87.253c-5.515-.122-10.546-1.697-14.788-5.334-3.576-3.09-5.818-7.03-6.545-11.697-1.091-6.848.787-12.909 4.909-18.302 4.424-5.819 9.757-8.849 16.97-10.122 6.181-1.09 12-.484 17.272 3.091 4.788 3.273 7.757 7.697 8.545 13.515 1.03 8.182-1.333 14.849-6.97 20.546-4 4.06-8.909 6.606-14.545 7.757-1.636.303-3.273.364-4.848.546zm14.424-24.485c-.06-.788-.06-1.394-.182-2-1.09-6-6.606-9.394-12.363-8.06-5.637 1.272-9.273 4.848-10.606 10.545-1.091 4.727 1.212 9.515 5.575 11.454 3.334 1.455 6.667 1.273 9.879-.363 4.788-2.485 7.394-6.364 7.697-11.576z" fill-rule="nonzero"/></g></svg>

package/src/theme/ApiItem/icons/javascript-original.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill="#F0DB4F" d="M1.408 1.408h125.184v125.185H1.408z"/><path fill="#323330" d="M116.347 96.736c-.917-5.711-4.641-10.508-15.672-14.981-3.832-1.761-8.104-3.022-9.377-5.926-.452-1.69-.512-2.642-.226-3.665.821-3.32 4.784-4.355 7.925-3.403 2.023.678 3.938 2.237 5.093 4.724 5.402-3.498 5.391-3.475 9.163-5.879-1.381-2.141-2.118-3.129-3.022-4.045-3.249-3.629-7.676-5.498-14.756-5.355l-3.688.477c-3.534.893-6.902 2.748-8.877 5.235-5.926 6.724-4.236 18.492 2.975 23.335 7.104 5.332 17.54 6.545 18.873 11.531 1.297 6.104-4.486 8.08-10.234 7.378-4.236-.881-6.592-3.034-9.139-6.949-4.688 2.713-4.688 2.713-9.508 5.485 1.143 2.499 2.344 3.63 4.26 5.795 9.068 9.198 31.76 8.746 35.83-5.176.165-.478 1.261-3.666.38-8.581zM69.462 58.943H57.753l-.048 30.272c0 6.438.333 12.34-.714 14.149-1.713 3.558-6.152 3.117-8.175 2.427-2.059-1.012-3.106-2.451-4.319-4.485-.333-.584-.583-1.036-.667-1.071l-9.52 5.83c1.583 3.249 3.915 6.069 6.902 7.901 4.462 2.678 10.459 3.499 16.731 2.059 4.082-1.189 7.604-3.652 9.448-7.401 2.666-4.915 2.094-10.864 2.07-17.444.06-10.735.001-21.468.001-32.237z"/></svg>