docusaurus-theme-openapi-docs 3.0.0-beta.3 → 3.0.0-beta.5

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

@@ -14,6 +14,7 @@ import FormSelect from "@theme/ApiExplorer/FormSelect";
 import FormTextInput from "@theme/ApiExplorer/FormTextInput";
 import LiveApp from "@theme/ApiExplorer/LiveEditor";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
+import Markdown from "@theme/Markdown";
 import SchemaTabs from "@theme/SchemaTabs";
 import TabItem from "@theme/TabItem";
 import { RequestBodyObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
@@ -303,6 +304,7 @@ function Body({
           </TabItem>
           {/* @ts-ignore */}
           <TabItem label="Example" value="example">
+            {example.summary && <Markdown children={example.summary} />}
             {exampleBody && (
               <LiveApp
                 action={dispatch}
@@ -340,7 +342,7 @@ function Body({
                 value={example.label}
                 key={example.label}
               >
-                {example.summary && <p>{example.summary}</p>}
+                {example.summary && <Markdown children={example.summary} />}
                 {example.body && (
                   <LiveApp action={dispatch} language={language}>
                     {example.body}

package/src/theme/ApiExplorer/CodeSnippets/code-snippets-types.ts

@@ -0,0 +1,55 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+// https://github.com/github-linguist/linguist/blob/master/lib/linguist/popular.yml
+export type CodeSampleLanguage =
+  | "C"
+  | "C#"
+  | "C++"
+  | "CoffeeScript"
+  | "CSS"
+  | "Dart"
+  | "DM"
+  | "Elixir"
+  | "Go"
+  | "Groovy"
+  | "HTML"
+  | "Java"
+  | "JavaScript"
+  | "Kotlin"
+  | "Objective-C"
+  | "Perl"
+  | "PHP"
+  | "PowerShell"
+  | "Python"
+  | "Ruby"
+  | "Rust"
+  | "Scala"
+  | "Shell"
+  | "Swift"
+  | "TypeScript";
+
+export interface Language {
+  highlight: string;
+  language: string;
+  codeSampleLanguage: CodeSampleLanguage;
+  logoClass: string;
+  variant: string;
+  variants: string[];
+  options?: { [key: string]: boolean };
+  sample?: string;
+  samples?: string[];
+  samplesSources?: string[];
+  samplesLabels?: string[];
+}
+
+// https://redocly.com/docs/api-reference-docs/specification-extensions/x-code-samples
+export interface CodeSample {
+  source: string;
+  lang: CodeSampleLanguage;
+  label?: string;
+}

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

@@ -16,20 +16,14 @@ import CodeTabs from "@theme/ApiExplorer/CodeTabs";
 import { useTypedSelector } from "@theme/ApiItem/hooks";
 import merge from "lodash/merge";
 
-export interface Language {
-  highlight: string;
-  language: string;
-  logoClass: string;
-  variant: string;
-  variants: string[];
-  options: { [key: string]: boolean };
-  source?: string;
-}
+import { CodeSample, Language } from "./code-snippets-types";
+import { mergeCodeSampleLanguage } from "./languages";
 
 export const languageSet: Language[] = [
   {
     highlight: "bash",
     language: "curl",
+    codeSampleLanguage: "Shell",
     logoClass: "bash",
     options: {
       longFormat: false,
@@ -42,6 +36,7 @@ export const languageSet: Language[] = [
   {
     highlight: "python",
     language: "python",
+    codeSampleLanguage: "Python",
     logoClass: "python",
     options: {
       followRedirect: true,
@@ -53,6 +48,7 @@ export const languageSet: Language[] = [
   {
     highlight: "go",
     language: "go",
+    codeSampleLanguage: "Go",
     logoClass: "go",
     options: {
       followRedirect: true,
@@ -64,6 +60,7 @@ export const languageSet: Language[] = [
   {
     highlight: "javascript",
     language: "nodejs",
+    codeSampleLanguage: "JavaScript",
     logoClass: "nodejs",
     options: {
       ES6_enabled: true,
@@ -71,11 +68,12 @@ export const languageSet: Language[] = [
       trimRequestBody: true,
     },
     variant: "axios",
-    variants: ["axios", "native", "request", "unirest"],
+    variants: ["axios", "native"],
   },
   {
     highlight: "ruby",
     language: "ruby",
+    codeSampleLanguage: "Ruby",
     logoClass: "ruby",
     options: {
       followRedirect: true,
@@ -87,6 +85,7 @@ export const languageSet: Language[] = [
   {
     highlight: "csharp",
     language: "csharp",
+    codeSampleLanguage: "C#",
     logoClass: "csharp",
     options: {
       followRedirect: true,
@@ -98,6 +97,7 @@ export const languageSet: Language[] = [
   {
     highlight: "php",
     language: "php",
+    codeSampleLanguage: "PHP",
     logoClass: "php",
     options: {
       followRedirect: true,
@@ -109,6 +109,7 @@ export const languageSet: Language[] = [
   {
     highlight: "java",
     language: "java",
+    codeSampleLanguage: "Java",
     logoClass: "java",
     options: {
       followRedirect: true,
@@ -120,6 +121,7 @@ export const languageSet: Language[] = [
   {
     highlight: "powershell",
     language: "powershell",
+    codeSampleLanguage: "PowerShell",
     logoClass: "powershell",
     options: {
       followRedirect: true,
@@ -132,10 +134,10 @@ export const languageSet: Language[] = [
 
 export interface Props {
   postman: sdk.Request;
-  codeSamples: any; // TODO: Type this...
+  codeSamples: CodeSample[];
 }
 
-function CodeTab({ children, hidden, className, onClick }: any): JSX.Element {
+function CodeTab({ children, hidden, className }: any): JSX.Element {
   return (
     <div role="tabpanel" className={className} {...{ hidden }}>
       {children}
@@ -165,7 +167,6 @@ function CodeSnippets({ postman, codeSamples }: Props) {
   const langs = [
     ...((siteConfig?.themeConfig?.languageTabs as Language[] | undefined) ??
       languageSet),
-    ...codeSamples,
   ];
 
   // Filter languageSet by user-defined langs
@@ -176,14 +177,18 @@ function CodeSnippets({ postman, codeSamples }: Props) {
   });
 
   // Merge user-defined langs into languageSet
-  const mergedLangs = merge(filteredLanguageSet, langs);
+  const mergedLangs = mergeCodeSampleLanguage(
+    merge(filteredLanguageSet, langs),
+    codeSamples
+  );
 
   // Read defaultLang from localStorage
   const defaultLang: Language[] = mergedLangs.filter(
     (lang) =>
       lang.language === localStorage.getItem("docusaurus.tab.code-samples")
   );
-  const [selectedVariant, setSelectedVariant] = useState();
+  const [selectedVariant, setSelectedVariant] = useState<string | undefined>();
+  const [selectedSample, setSelectedSample] = useState<string | undefined>();
   const [language, setLanguage] = useState(() => {
     // Return first index if only 1 user-defined language exists
     if (mergedLangs.length === 1) {
@@ -192,9 +197,23 @@ function CodeSnippets({ postman, codeSamples }: Props) {
     // Fall back to language in localStorage or first user-defined language
     return defaultLang[0] ?? mergedLangs[0];
   });
-  const [codeText, setCodeText] = useState("");
+  const [codeText, setCodeText] = useState<string>("");
+  const [codeSampleCodeText, setCodeSampleCodeText] = useState<string>("");
 
   useEffect(() => {
+    // initial active language is custom code sample
+    if (
+      language &&
+      language.sample &&
+      language.samples &&
+      language.samplesSources
+    ) {
+      const sampleIndex = language.samples.findIndex(
+        (smp) => smp === language.sample
+      );
+      setCodeSampleCodeText(language.samplesSources[sampleIndex]);
+    }
+
     if (language && !!language.options) {
       const postmanRequest = buildPostmanRequest(postman, {
         queryParams,
@@ -219,8 +238,6 @@ function CodeSnippets({ postman, codeSamples }: Props) {
           setCodeText(snippet);
         }
       );
-    } else if (language && !!language.source) {
-      setCodeText(language.source);
     } else if (language && !language.options) {
       const langSource = mergedLangs.filter(
         (lang) => lang.language === language.language
@@ -271,8 +288,8 @@ function CodeSnippets({ postman, codeSamples }: Props) {
     auth,
     mergedLangs,
   ]);
-
-  useEffect(() => {
+  // no dependencies was intentionlly set for this particular hook. it's safe as long as if conditions are set
+  useEffect(function onSelectedVariantUpdate() {
     if (selectedVariant && selectedVariant !== language.variant) {
       const postmanRequest = buildPostmanRequest(postman, {
         queryParams,
@@ -300,6 +317,22 @@ function CodeSnippets({ postman, codeSamples }: Props) {
     }
   });
 
+  // no dependencies was intentionlly set for this particular hook. it's safe as long as if conditions are set
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  useEffect(function onSelectedSampleUpdate() {
+    if (
+      language.samples &&
+      language.samplesSources &&
+      selectedSample &&
+      selectedSample !== language.sample
+    ) {
+      const sampleIndex = language.samples.findIndex(
+        (smp) => smp === selectedSample
+      );
+      setCodeSampleCodeText(language.samplesSources[sampleIndex]);
+    }
+  });
+
   if (language === undefined) {
     return null;
   }
@@ -324,6 +357,46 @@ function CodeSnippets({ postman, codeSamples }: Props) {
                 className: `openapi-tabs__code-item--${lang.logoClass}`,
               }}
             >
+              {lang.samples && (
+                <CodeTabs
+                  className="openapi-tabs__code-container-inner"
+                  action={{
+                    setLanguage: setLanguage,
+                    setSelectedSample: setSelectedSample,
+                  }}
+                  includeSample={true}
+                  currentLanguage={lang.language}
+                  defaultValue={selectedSample}
+                  lazy
+                >
+                  {lang.samples.map((sample, index) => {
+                    return (
+                      <CodeTab
+                        value={sample}
+                        label={
+                          lang.samplesLabels
+                            ? lang.samplesLabels[index]
+                            : sample
+                        }
+                        key={`${lang.language}-${lang.sample}`}
+                        attributes={{
+                          className: `openapi-tabs__code-item--sample`,
+                        }}
+                      >
+                        {/* @ts-ignore */}
+                        <ApiCodeBlock
+                          language={lang.highlight}
+                          className="openapi-explorer__code-block"
+                          showLineNumbers={true}
+                        >
+                          {codeSampleCodeText}
+                        </ApiCodeBlock>
+                      </CodeTab>
+                    );
+                  })}
+                </CodeTabs>
+              )}
+
               <CodeTabs
                 className="openapi-tabs__code-container-inner"
                 action={{
@@ -335,7 +408,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
                 defaultValue={selectedVariant}
                 lazy
               >
-                {lang.variants.map((variant) => {
+                {lang.variants.map((variant, index) => {
                   return (
                     <CodeTab
                       value={variant.toLowerCase()}

package/src/theme/ApiExplorer/CodeSnippets/languages.json

@@ -635,102 +635,6 @@
             "description": "Modifies code snippet to incorporate ES6 (EcmaScript) features"
           }
         ]
-      },
-      {
-        "key": "Request",
-        "options": [
-          {
-            "name": "Set indentation count",
-            "id": "indentCount",
-            "type": "positiveInteger",
-            "default": 2,
-            "description": "Set the number of indentation characters to add per code level"
-          },
-          {
-            "name": "Set indentation type",
-            "id": "indentType",
-            "type": "enum",
-            "availableOptions": ["Tab", "Space"],
-            "default": "Space",
-            "description": "Select the character used to indent lines of code"
-          },
-          {
-            "name": "Set request timeout",
-            "id": "requestTimeout",
-            "type": "positiveInteger",
-            "default": 0,
-            "description": "Set number of milliseconds the request should wait for a response before timing out (use 0 for infinity)"
-          },
-          {
-            "name": "Follow redirects",
-            "id": "followRedirect",
-            "type": "boolean",
-            "default": true,
-            "description": "Automatically follow HTTP redirects"
-          },
-          {
-            "name": "Trim request body fields",
-            "id": "trimRequestBody",
-            "type": "boolean",
-            "default": false,
-            "description": "Remove white space and additional lines that may affect the server's response"
-          },
-          {
-            "name": "Enable ES6 features",
-            "id": "ES6_enabled",
-            "type": "boolean",
-            "default": false,
-            "description": "Modifies code snippet to incorporate ES6 (EcmaScript) features"
-          }
-        ]
-      },
-      {
-        "key": "Unirest",
-        "options": [
-          {
-            "name": "Set indentation count",
-            "id": "indentCount",
-            "type": "positiveInteger",
-            "default": 2,
-            "description": "Set the number of indentation characters to add per code level"
-          },
-          {
-            "name": "Set indentation type",
-            "id": "indentType",
-            "type": "enum",
-            "availableOptions": ["Tab", "Space"],
-            "default": "Space",
-            "description": "Select the character used to indent lines of code"
-          },
-          {
-            "name": "Set request timeout",
-            "id": "requestTimeout",
-            "type": "positiveInteger",
-            "default": 0,
-            "description": "Set number of milliseconds the request should wait for a response before timing out (use 0 for infinity)"
-          },
-          {
-            "name": "Follow redirects",
-            "id": "followRedirect",
-            "type": "boolean",
-            "default": true,
-            "description": "Automatically follow HTTP redirects"
-          },
-          {
-            "name": "Trim request body fields",
-            "id": "trimRequestBody",
-            "type": "boolean",
-            "default": false,
-            "description": "Remove white space and additional lines that may affect the server's response"
-          },
-          {
-            "name": "Enable ES6 features",
-            "id": "ES6_enabled",
-            "type": "boolean",
-            "default": false,
-            "description": "Modifies code snippet to incorporate ES6 (EcmaScript) features"
-          }
-        ]
       }
     ]
   },

package/src/theme/ApiExplorer/CodeSnippets/languages.ts

@@ -0,0 +1,37 @@
+/* ============================================================================
+ * 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 { CodeSample, Language } from "./code-snippets-types";
+
+export function mergeCodeSampleLanguage(
+  languages: Language[],
+  codeSamples: CodeSample[]
+): Language[] {
+  return languages.map((language) => {
+    const languageCodeSamples = codeSamples.filter(
+      ({ lang }) => lang === language.codeSampleLanguage
+    );
+
+    if (languageCodeSamples.length) {
+      const samples = languageCodeSamples.map(({ lang }) => lang);
+      const samplesLabels = languageCodeSamples.map(
+        ({ label, lang }) => label || lang
+      );
+      const samplesSources = languageCodeSamples.map(({ source }) => source);
+
+      return {
+        ...language,
+        sample: samples[0],
+        samples,
+        samplesSources,
+        samplesLabels,
+      };
+    }
+
+    return language;
+  });
+}

package/src/theme/ApiExplorer/CodeTabs/_CodeTabs.scss

@@ -96,6 +96,20 @@ body[class="ReactModal__Body--open"] {
   padding-right: 0.5rem !important;
 }
 
+.openapi-tabs__code-item--sample {
+  color: var(--ifm-color-secondary);
+
+  &.active {
+    border-color: var(--ifm-toc-border-color);
+  }
+}
+
+.openapi-tabs__code-item--sample > span {
+  padding-top: unset !important;
+  padding-left: 0.5rem !important;
+  padding-right: 0.5rem !important;
+}
+
 .openapi-tabs__code-item--python {
   color: var(--ifm-color-success);
 

package/src/theme/ApiExplorer/CodeTabs/{index.js → index.tsx}

@@ -5,34 +5,55 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { cloneElement } from "react";
+import React, { cloneElement, ReactElement } from "react";
 
 import {
+  sanitizeTabsChildren,
+  type TabProps,
   useScrollPositionBlocker,
   useTabs,
 } from "@docusaurus/theme-common/internal";
+import { TabItemProps } from "@docusaurus/theme-common/lib/utils/tabsUtils";
 import useIsBrowser from "@docusaurus/useIsBrowser";
-import { languageSet } from "@theme/ApiExplorer/CodeSnippets";
+import { Language, languageSet } from "@theme/ApiExplorer/CodeSnippets";
 import clsx from "clsx";
 
+export interface Props {
+  action: {
+    [key: string]: React.Dispatch<any>;
+  };
+  currentLanguage: Language;
+  includeVariant: boolean;
+}
+
+export interface TabListProps extends Props, TabProps {
+  includeSample?: boolean;
+}
+
 function TabList({
   action,
   currentLanguage,
   includeVariant,
+  includeSample,
   className,
   block,
   selectedValue,
   selectValue,
   tabValues,
-}) {
-  const tabRefs = [];
+}: TabListProps & ReturnType<typeof useTabs>) {
+  const tabRefs: (HTMLLIElement | null)[] = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
 
-  const handleTabChange = (event) => {
+  const handleTabChange = (
+    event:
+      | React.FocusEvent<HTMLLIElement>
+      | React.MouseEvent<HTMLLIElement>
+      | React.KeyboardEvent<HTMLLIElement>
+  ) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
-    const newTabValue = tabValues[newTabIndex].value;
+    const newTabValue = tabValues[newTabIndex]!.value;
 
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
@@ -40,25 +61,30 @@ function TabList({
     }
 
     if (action) {
-      let newLanguage;
+      let newLanguage: Language;
       if (currentLanguage && includeVariant) {
         newLanguage = languageSet.filter(
-          (lang) => lang.language === currentLanguage
+          (lang: Language) => lang.language === currentLanguage
         )[0];
         newLanguage.variant = newTabValue;
         action.setSelectedVariant(newTabValue.toLowerCase());
       } else {
         newLanguage = languageSet.filter(
-          (lang) => lang.language === newTabValue
+          (lang: Language) => lang.language === newTabValue
         )[0];
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
       }
+      if (currentLanguage && includeSample) {
+        newLanguage.sample = newTabValue;
+        action.setSelectedSample(newTabValue.toLowerCase());
+      }
       action.setLanguage(newLanguage);
     }
   };
 
-  const handleKeydown = (event) => {
-    let focusElement = null;
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
     switch (event.key) {
       case "Enter": {
         handleTabChange(event);
@@ -66,17 +92,18 @@ function TabList({
       }
       case "ArrowRight": {
         const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
-        focusElement = tabRefs[nextTab] ?? tabRefs[0];
+        focusElement = tabRefs[nextTab] ?? tabRefs[0]!;
         break;
       }
       case "ArrowLeft": {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1]!;
         break;
       }
       default:
         break;
     }
+
     focusElement?.focus();
   };
 
@@ -107,7 +134,7 @@ function TabList({
           className={clsx(
             "tabs__item",
             "openapi-tabs__code-item",
-            attributes?.className,
+            attributes?.className as string,
             {
               active: selectedValue === value,
             }
@@ -120,11 +147,16 @@ function TabList({
   );
 }
 
-function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
+function TabContent({
+  lazy,
+  children,
+  selectedValue,
+}: TabProps & ReturnType<typeof useTabs>): React.JSX.Element | null {
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  ) as ReactElement<TabItemProps>[];
   if (lazy) {
-    const selectedTabItem = children.find(
+    const selectedTabItem = childTabs.find(
       (tabItem) => tabItem.props.value === selectedValue
     );
     if (!selectedTabItem) {
@@ -135,7 +167,7 @@ function TabContent({ lazy, children, selectedValue }) {
   }
   return (
     <div className="margin-top--md openapi-tabs__code-content">
-      {children.map((tabItem, i) =>
+      {childTabs.map((tabItem, i) =>
         cloneElement(tabItem, {
           key: i,
           hidden: tabItem.props.value !== selectedValue,
@@ -145,15 +177,13 @@ function TabContent({ lazy, children, selectedValue }) {
   );
 }
 
-function TabsComponent(props) {
+function TabsComponent(props: TabProps & Props): React.JSX.Element {
   const tabs = useTabs(props);
   const { className } = props;
 
   return (
     <div
-      className={clsx("tabs-container openapi-tabs__code-container", {
-        [className]: className,
-      })}
+      className={clsx("tabs-container openapi-tabs__code-container", className)}
     >
       <TabList {...props} {...tabs} />
       <TabContent {...props} {...tabs} />
@@ -161,7 +191,7 @@ function TabsComponent(props) {
   );
 }
 
-export default function CodeTabs(props) {
+export default function CodeTabs(props: TabProps & Props): React.JSX.Element {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -169,6 +199,8 @@ export default function CodeTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }