docusaurus-theme-openapi-docs 3.0.0-beta.4 → 3.0.0-beta.6

package/lib/markdown/utils.js

@@ -17,11 +17,11 @@ function create(tag, props) {
 }
 exports.create = create;
 function guard(value, cb) {
-    if (!!value) {
-        const children = cb(value);
-        return render(children);
+    if (value === undefined || value === "") {
+        return "";
     }
-    return "";
+    const children = cb(value);
+    return render(children);
 }
 exports.guard = guard;
 function render(children) {

package/lib/markdown/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/markdown/utils.test.js

@@ -0,0 +1,43 @@
+"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 });
+const utils_1 = require("./utils");
+describe("guard", () => {
+    it("should guard empty strings", () => {
+        const actual = (0, utils_1.guard)("", (_) => {
+            throw new Error("Should not be called");
+        });
+        expect(actual).toBe("");
+    });
+    it("should guard undefined", () => {
+        const actual = (0, utils_1.guard)(undefined, (value) => {
+            throw new Error("Should not be called");
+        });
+        expect(actual).toBe("");
+    });
+    it("should not guard strings", () => {
+        const actual = (0, utils_1.guard)("hello", (value) => value);
+        expect(actual).toBe("hello");
+    });
+    it("should not guard numbers", () => {
+        const actual = (0, utils_1.guard)(1, (value) => `${value}`);
+        expect(actual).toBe("1");
+    });
+    it("should not guard numbers equals to 0", () => {
+        const actual = (0, utils_1.guard)(0, (value) => `${value}`);
+        expect(actual).toBe("0");
+    });
+    it("should not guard false booleans", () => {
+        const actual = (0, utils_1.guard)(false, (value) => `${value}`);
+        expect(actual).toBe("false");
+    });
+    it("should not guard true booleans", () => {
+        const actual = (0, utils_1.guard)(true, (value) => `${value}`);
+        expect(actual).toBe("true");
+    });
+});

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

@@ -23,6 +23,7 @@ const FormTextInput_1 = __importDefault(
 );
 const LiveEditor_1 = __importDefault(require("@theme/ApiExplorer/LiveEditor"));
 const hooks_1 = require("@theme/ApiItem/hooks");
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
@@ -296,6 +297,10 @@ function Body({
         react_1.default.createElement(
           TabItem_1.default,
           { label: "Example", value: "example" },
+          example.summary &&
+            react_1.default.createElement(Markdown_1.default, {
+              children: example.summary,
+            }),
           exampleBody &&
             react_1.default.createElement(
               LiveEditor_1.default,
@@ -337,7 +342,9 @@ function Body({
                 key: example.label,
               },
               example.summary &&
-                react_1.default.createElement("p", null, example.summary),
+                react_1.default.createElement(Markdown_1.default, {
+                  children: example.summary,
+                }),
               example.body &&
                 react_1.default.createElement(
                   LiveEditor_1.default,

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

@@ -0,0 +1,21 @@
+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[];
+}
+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 @@
 import React from "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): React.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,
@@ -117,11 +122,12 @@ exports.languageSet = [
       trimRequestBody: true,
     },
     variant: "axios",
-    variants: ["axios", "native", "request", "unirest"],
+    variants: ["axios", "native"],
   },
   {
     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,15 @@ function CodeSnippets({ postman, codeSamples }) {
     return defaultLang[0] ?? mergedLangs[0];
   });
   const [codeText, setCodeText] = (0, react_1.useState)("");
+  const [codeSampleCodeText, setCodeSampleCodeText] = (0, react_1.useState)(
+    () => (0, languages_1.getCodeSampleSourceFromLanguage)(language)
+  );
   (0, react_1.useEffect)(() => {
+    if (language && !!language.sample) {
+      setCodeSampleCodeText(
+        (0, languages_1.getCodeSampleSourceFromLanguage)(language)
+      );
+    }
     if (language && !!language.options) {
       const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
         queryParams,
@@ -258,8 +279,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 +327,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 +355,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;
   }
@@ -348,7 +383,9 @@ function CodeSnippets({ postman, codeSamples }) {
         action: {
           setLanguage: setLanguage,
           setSelectedVariant: setSelectedVariant,
+          setSelectedSample: setSelectedSample,
         },
+        languageSet: mergedLangs,
         lazy: true,
       },
       mergedLangs.map((lang) => {
@@ -362,6 +399,46 @@ 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,
+                languageSet: mergedLangs,
+                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,
             {
@@ -373,9 +450,10 @@ function CodeSnippets({ postman, codeSamples }) {
               includeVariant: true,
               currentLanguage: lang.language,
               defaultValue: selectedVariant,
+              languageSet: mergedLangs,
               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,3 @@
+import { CodeSample, Language } from "./code-snippets-types";
+export declare function mergeCodeSampleLanguage(languages: Language[], codeSamples: CodeSample[]): Language[];
+export declare function getCodeSampleSourceFromLanguage(language: Language): string;

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

@@ -0,0 +1,48 @@
+"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.getCodeSampleSourceFromLanguage = 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;
+function getCodeSampleSourceFromLanguage(language) {
+  if (
+    language &&
+    language.sample &&
+    language.samples &&
+    language.samplesSources
+  ) {
+    const sampleIndex = language.samples.findIndex(
+      (smp) => smp === language.sample
+    );
+    return language.samplesSources[sampleIndex];
+  }
+  return "";
+}
+exports.getCodeSampleSourceFromLanguage = getCodeSampleSourceFromLanguage;

package/lib/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/lib/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/lib/theme/ApiExplorer/CodeTabs/index.d.ts

@@ -6,6 +6,10 @@ export interface Props {
         [key: string]: React.Dispatch<any>;
     };
     currentLanguage: Language;
+    languageSet: Language[];
     includeVariant: boolean;
 }
-export default function CodeTabs(props: TabProps & Props): React.JSX.Element;
+export interface CodeTabsProps extends Props, TabProps {
+    includeSample?: boolean;
+}
+export default function CodeTabs(props: CodeTabsProps & Props): React.JSX.Element;

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

@@ -58,12 +58,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importStar(require("react"));
 const internal_1 = require("@docusaurus/theme-common/internal");
 const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
-const CodeSnippets_1 = require("@theme/ApiExplorer/CodeSnippets");
 const clsx_1 = __importDefault(require("clsx"));
 function TabList({
   action,
   currentLanguage,
+  languageSet,
   includeVariant,
+  includeSample,
   className,
   block,
   selectedValue,
@@ -84,16 +85,23 @@ function TabList({
     if (action) {
       let newLanguage;
       if (currentLanguage && includeVariant) {
-        newLanguage = CodeSnippets_1.languageSet.filter(
+        newLanguage = languageSet.filter(
           (lang) => lang.language === currentLanguage
         )[0];
         newLanguage.variant = newTabValue;
         action.setSelectedVariant(newTabValue.toLowerCase());
+      } else if (currentLanguage && includeSample) {
+        newLanguage = languageSet.filter(
+          (lang) => lang.language === currentLanguage
+        )[0];
+        newLanguage.sample = newTabValue;
+        action.setSelectedSample(newTabValue);
       } else {
-        newLanguage = CodeSnippets_1.languageSet.filter(
+        newLanguage = languageSet.filter(
           (lang) => lang.language === newTabValue
         )[0];
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
+        action.setSelectedSample(newLanguage.sample);
       }
       action.setLanguage(newLanguage);
     }

package/lib/theme/ApiExplorer/index.js

@@ -28,7 +28,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/lib/theme/ApiItem/index.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="@docusaurus/plugin-content-docs" />
-import React from "react";
+/// <reference types="react" />
 import type { Props } from "@theme/DocItem";
-export default function ApiItem(props: Props): React.JSX.Element;
+export default function ApiItem(props: Props): JSX.Element;

package/lib/theme/ApiItem/index.js

@@ -41,6 +41,7 @@ function ApiItem(props) {
   const { frontMatter } = MDXComponent;
   const { info_path: infoPath } = frontMatter;
   let { api } = frontMatter;
+  const { schema } = frontMatter;
   // decompress and parse
   if (api) {
     api = JSON.parse(
@@ -164,6 +165,29 @@ function ApiItem(props) {
         )
       )
     );
+  } else if (schema) {
+    return react_1.default.createElement(
+      internal_1.DocProvider,
+      { content: props.content },
+      react_1.default.createElement(
+        theme_common_1.HtmlClassNameProvider,
+        { className: docHtmlClassName },
+        react_1.default.createElement(Metadata_1.default, null),
+        react_1.default.createElement(
+          Layout_1.default,
+          null,
+          react_1.default.createElement(
+            "div",
+            { className: (0, clsx_1.default)("row", "theme-api-markdown") },
+            react_1.default.createElement(
+              "div",
+              { className: "col col--12" },
+              react_1.default.createElement(MDXComponent, null)
+            )
+          )
+        )
+      )
+    );
   }
   // Non-API docs
   return react_1.default.createElement(