docusaurus-theme-openapi-docs 0.0.0-693 → 0.0.0-694

package/lib/theme/ApiExplorer/CodeSnippets/code-snippets-types.d.ts

@@ -0,0 +1,21 @@
+export declare 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[];
+}
+export interface CodeSample {
+    source: string;
+    lang: CodeSampleLanguage;
+    label?: string;
+}

package/lib/theme/ApiExplorer/CodeSnippets/code-snippets-types.js

@@ -0,0 +1,8 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/theme/ApiExplorer/CodeSnippets/index.d.ts

@@ -1,20 +1,10 @@
 /// <reference types="react" />
 import sdk from "@paloaltonetworks/postman-collection";
-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";
 export declare const languageSet: Language[];
 export interface Props {
     postman: sdk.Request;
-    codeSamples: any;
+    codeSamples: CodeSample[];
 }
 declare function CodeSnippets({ postman, codeSamples }: Props): JSX.Element | null;
 export default CodeSnippets;

package/lib/theme/ApiExplorer/CodeSnippets/index.js

@@ -72,10 +72,12 @@ const buildPostmanRequest_1 = __importDefault(
 const CodeTabs_1 = __importDefault(require("@theme/ApiExplorer/CodeTabs"));
 const hooks_1 = require("@theme/ApiItem/hooks");
 const merge_1 = __importDefault(require("lodash/merge"));
+const languages_1 = require("./languages");
 exports.languageSet = [
   {
     highlight: "bash",
     language: "curl",
+    codeSampleLanguage: "Shell",
     logoClass: "bash",
     options: {
       longFormat: false,
@@ -88,6 +90,7 @@ exports.languageSet = [
   {
     highlight: "python",
     language: "python",
+    codeSampleLanguage: "Python",
     logoClass: "python",
     options: {
       followRedirect: true,
@@ -99,6 +102,7 @@ exports.languageSet = [
   {
     highlight: "go",
     language: "go",
+    codeSampleLanguage: "Go",
     logoClass: "go",
     options: {
       followRedirect: true,
@@ -110,6 +114,7 @@ exports.languageSet = [
   {
     highlight: "javascript",
     language: "nodejs",
+    codeSampleLanguage: "JavaScript",
     logoClass: "nodejs",
     options: {
       ES6_enabled: true,
@@ -122,6 +127,7 @@ exports.languageSet = [
   {
     highlight: "ruby",
     language: "ruby",
+    codeSampleLanguage: "Ruby",
     logoClass: "ruby",
     options: {
       followRedirect: true,
@@ -133,6 +139,7 @@ exports.languageSet = [
   {
     highlight: "csharp",
     language: "csharp",
+    codeSampleLanguage: "C#",
     logoClass: "csharp",
     options: {
       followRedirect: true,
@@ -144,6 +151,7 @@ exports.languageSet = [
   {
     highlight: "php",
     language: "php",
+    codeSampleLanguage: "PHP",
     logoClass: "php",
     options: {
       followRedirect: true,
@@ -155,6 +163,7 @@ exports.languageSet = [
   {
     highlight: "java",
     language: "java",
+    codeSampleLanguage: "Java",
     logoClass: "java",
     options: {
       followRedirect: true,
@@ -166,6 +175,7 @@ exports.languageSet = [
   {
     highlight: "powershell",
     language: "powershell",
+    codeSampleLanguage: "PowerShell",
     logoClass: "powershell",
     options: {
       followRedirect: true,
@@ -175,7 +185,7 @@ exports.languageSet = [
     variants: ["restmethod"],
   },
 ];
-function CodeTab({ children, hidden, className, onClick }) {
+function CodeTab({ children, hidden, className }) {
   return react_1.default.createElement(
     "div",
     { role: "tabpanel", className: className, ...{ hidden } },
@@ -208,7 +218,6 @@ function CodeSnippets({ postman, codeSamples }) {
   // Can override languageSet, change order of langs, override options and variants
   const langs = [
     ...(siteConfig?.themeConfig?.languageTabs ?? exports.languageSet),
-    ...codeSamples,
   ];
   // Filter languageSet by user-defined langs
   const filteredLanguageSet = exports.languageSet.filter((ls) => {
@@ -217,13 +226,17 @@ function CodeSnippets({ postman, codeSamples }) {
     });
   });
   // Merge user-defined langs into languageSet
-  const mergedLangs = (0, merge_1.default)(filteredLanguageSet, langs);
+  const mergedLangs = (0, languages_1.mergeCodeSampleLanguage)(
+    (0, merge_1.default)(filteredLanguageSet, langs),
+    codeSamples
+  );
   // Read defaultLang from localStorage
   const defaultLang = mergedLangs.filter(
     (lang) =>
       lang.language === localStorage.getItem("docusaurus.tab.code-samples")
   );
   const [selectedVariant, setSelectedVariant] = (0, react_1.useState)();
+  const [selectedSample, setSelectedSample] = (0, react_1.useState)();
   const [language, setLanguage] = (0, react_1.useState)(() => {
     // Return first index if only 1 user-defined language exists
     if (mergedLangs.length === 1) {
@@ -233,7 +246,20 @@ function CodeSnippets({ postman, codeSamples }) {
     return defaultLang[0] ?? mergedLangs[0];
   });
   const [codeText, setCodeText] = (0, react_1.useState)("");
+  const [codeSampleCodeText, setCodeSampleCodeText] = (0, react_1.useState)("");
   (0, react_1.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 = (0, buildPostmanRequest_1.default)(postman, {
         queryParams,
@@ -258,8 +284,6 @@ function CodeSnippets({ postman, codeSamples }) {
           setCodeText(snippet);
         }
       );
-    } else if (language && !!language.source) {
-      setCodeText(language.source);
     } else if (language && !language.options) {
       const langSource = mergedLangs.filter(
         (lang) => lang.language === language.language
@@ -308,7 +332,8 @@ function CodeSnippets({ postman, codeSamples }) {
     auth,
     mergedLangs,
   ]);
-  (0, react_1.useEffect)(() => {
+  // no dependencies was intentionlly set for this particular hook. it's safe as long as if conditions are set
+  (0, react_1.useEffect)(function onSelectedVariantUpdate() {
     if (selectedVariant && selectedVariant !== language.variant) {
       const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
         queryParams,
@@ -335,6 +360,21 @@ function CodeSnippets({ postman, codeSamples }) {
       );
     }
   });
+  // 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
+  (0, react_1.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;
   }
@@ -362,6 +402,45 @@ function CodeSnippets({ postman, codeSamples }) {
               className: `openapi-tabs__code-item--${lang.logoClass}`,
             },
           },
+          lang.samples &&
+            react_1.default.createElement(
+              CodeTabs_1.default,
+              {
+                className: "openapi-tabs__code-container-inner",
+                action: {
+                  setLanguage: setLanguage,
+                  setSelectedSample: setSelectedSample,
+                },
+                includeSample: true,
+                currentLanguage: lang.language,
+                defaultValue: selectedSample,
+                lazy: true,
+              },
+              lang.samples.map((sample, index) => {
+                return react_1.default.createElement(
+                  CodeTab,
+                  {
+                    value: sample,
+                    label: lang.samplesLabels
+                      ? lang.samplesLabels[index]
+                      : sample,
+                    key: `${lang.language}-${lang.sample}`,
+                    attributes: {
+                      className: `openapi-tabs__code-item--sample`,
+                    },
+                  },
+                  react_1.default.createElement(
+                    ApiCodeBlock_1.default,
+                    {
+                      language: lang.highlight,
+                      className: "openapi-explorer__code-block",
+                      showLineNumbers: true,
+                    },
+                    codeSampleCodeText
+                  )
+                );
+              })
+            ),
           react_1.default.createElement(
             CodeTabs_1.default,
             {
@@ -375,7 +454,7 @@ function CodeSnippets({ postman, codeSamples }) {
               defaultValue: selectedVariant,
               lazy: true,
             },
-            lang.variants.map((variant) => {
+            lang.variants.map((variant, index) => {
               return react_1.default.createElement(
                 CodeTab,
                 {

package/lib/theme/ApiExplorer/CodeSnippets/languages.d.ts

@@ -0,0 +1,2 @@
+import { CodeSample, Language } from "./code-snippets-types";
+export declare function mergeCodeSampleLanguage(languages: Language[], codeSamples: CodeSample[]): Language[];

package/lib/theme/ApiExplorer/CodeSnippets/languages.js

@@ -0,0 +1,32 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeCodeSampleLanguage = void 0;
+function mergeCodeSampleLanguage(languages, codeSamples) {
+  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;
+  });
+}
+exports.mergeCodeSampleLanguage = mergeCodeSampleLanguage;

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

@@ -94,6 +94,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/lib/theme/ApiExplorer/CodeTabs/index.js

@@ -19,6 +19,7 @@ function TabList({
   action,
   currentLanguage,
   includeVariant,
+  includeSample,
   className,
   block,
   selectedValue,
@@ -53,6 +54,12 @@ function TabList({
         )[0];
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
       }
+
+      if (currentLanguage && includeSample) {
+        newLanguage.sample = newTabValue;
+        action.setSelectedSample(newTabValue.toLowerCase());
+      }
+
       action.setLanguage(newLanguage);
     }
   };

package/lib/theme/ApiExplorer/index.js

@@ -32,7 +32,7 @@ function ApiExplorer({ item, infoPath }) {
     item.method !== "event" &&
       react_1.default.createElement(CodeSnippets_1.default, {
         postman: postman,
-        codeSamples: item["x-code-samples"] ?? [],
+        codeSamples: item["x-codeSamples"] ?? [],
       }),
     react_1.default.createElement(Request_1.default, { item: item }),
     react_1.default.createElement(Response_1.default, { item: item })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-693",
+  "version": "0.0.0-694",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "739ca429c036571e7b0da13aa157a248a68bfe31"
+  "gitHead": "61930826cef71dd862939dd7cd1d4846d5d798bb"
 }

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,
@@ -76,6 +73,7 @@ export const languageSet: Language[] = [
   {
     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()}