docusaurus-theme-openapi-docs 0.0.0-733 → 0.0.0-736

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

@@ -56,6 +56,12 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.languageSet = void 0;
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
 const react_1 = __importStar(require("react"));
 const useDocusaurusContext_1 = __importDefault(
   require("@docusaurus/useDocusaurusContext")
@@ -68,7 +74,6 @@ 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 postman_code_generators_1 = __importDefault(
   require("postman-code-generators")
 );
@@ -193,7 +198,6 @@ function CodeTab({ children, hidden, className }) {
   );
 }
 function CodeSnippets({ postman, codeSamples }) {
-  // TODO: match theme for vscode.
   const { siteConfig } = (0, useDocusaurusContext_1.default)();
   const contentType = (0, hooks_1.useTypedSelector)(
     (state) => state.contentType.value
@@ -216,20 +220,22 @@ function CodeSnippets({ postman, codeSamples }) {
   const auth = (0, hooks_1.useTypedSelector)((state) => state.auth);
   // User-defined languages array
   // Can override languageSet, change order of langs, override options and variants
-  const langs = [
-    ...(siteConfig?.themeConfig?.languageTabs ?? exports.languageSet),
-  ];
+  const userDefinedLanguageSet = siteConfig?.themeConfig?.languageTabs;
   // Filter languageSet by user-defined langs
   const filteredLanguageSet = exports.languageSet.filter((ls) => {
-    return langs.some((lang) => {
+    return userDefinedLanguageSet?.some((lang) => {
       return lang.language === ls.language;
     });
   });
   // Merge user-defined langs into languageSet
   const mergedLangs = (0, languages_1.mergeCodeSampleLanguage)(
-    (0, merge_1.default)(filteredLanguageSet, langs),
+    (0, languages_1.mergeArraysbyLanguage)(
+      userDefinedLanguageSet,
+      filteredLanguageSet
+    ),
     codeSamples
   );
+  console.log("merged", mergedLangs);
   // Read defaultLang from localStorage
   const defaultLang = mergedLangs.filter(
     (lang) =>

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

@@ -1,3 +1,4 @@
 import { CodeSample, Language } from "./code-snippets-types";
 export declare function mergeCodeSampleLanguage(languages: Language[], codeSamples: CodeSample[]): Language[];
+export declare const mergeArraysbyLanguage: (arr1: any, arr2: any) => any[];
 export declare function getCodeSampleSourceFromLanguage(language: Language): string;

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

@@ -5,9 +5,20 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCodeSampleSourceFromLanguage = exports.mergeCodeSampleLanguage =
-  void 0;
+exports.getCodeSampleSourceFromLanguage =
+  exports.mergeArraysbyLanguage =
+  exports.mergeCodeSampleLanguage =
+    void 0;
+const find_1 = __importDefault(require("lodash/find"));
+const isArray_1 = __importDefault(require("lodash/isArray"));
+const mergeWith_1 = __importDefault(require("lodash/mergeWith"));
+const unionBy_1 = __importDefault(require("lodash/unionBy"));
 function mergeCodeSampleLanguage(languages, codeSamples) {
   return languages.map((language) => {
     const languageCodeSamples = codeSamples.filter(
@@ -31,6 +42,22 @@ function mergeCodeSampleLanguage(languages, codeSamples) {
   });
 }
 exports.mergeCodeSampleLanguage = mergeCodeSampleLanguage;
+const mergeArraysbyLanguage = (arr1, arr2) => {
+  const mergedArray = (0, unionBy_1.default)(arr1, arr2, "language");
+  return mergedArray.map((item) => {
+    const matchingItems = [
+      (0, find_1.default)(arr1, ["language", item["language"]]),
+      (0, find_1.default)(arr2, ["language", item["language"]]),
+    ];
+    return (0, mergeWith_1.default)({}, ...matchingItems, (objValue) => {
+      if ((0, isArray_1.default)(objValue)) {
+        return objValue;
+      }
+      return undefined;
+    });
+  });
+};
+exports.mergeArraysbyLanguage = mergeArraysbyLanguage;
 function getCodeSampleSourceFromLanguage(language) {
   if (
     language &&

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

@@ -18,12 +18,14 @@
     background-color: var(--ifm-pre-background);
     border-radius: var(--ifm-global-radius);
     border: 1px solid var(--openapi-explorer-border-color);
-    box-shadow: 0 2px 3px hsla(222, 8%, 43%, 0.1),
+    box-shadow:
+      0 2px 3px hsla(222, 8%, 43%, 0.1),
       0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
     transition: 300ms;
 
     &:hover {
-      box-shadow: 0 0 0 2px rgba(38, 53, 61, 0.15),
+      box-shadow:
+        0 0 0 2px rgba(38, 53, 61, 0.15),
         0 2px 3px hsla(222, 8%, 43%, 0.15),
         0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
     }

package/lib/theme/ApiExplorer/FloatingButton/_FloatingButton.scss

@@ -11,7 +11,9 @@
     padding: 0.4rem 0.5rem;
     opacity: 0;
     visibility: hidden;
-    transition: opacity 0.2s ease-in-out, visibility 0.2s ease-in-out,
+    transition:
+      opacity 0.2s ease-in-out,
+      visibility 0.2s ease-in-out,
       bottom 0.2s ease-in-out;
     position: absolute;
     right: calc(var(--ifm-pre-padding) / 2);

package/lib/theme/ApiExplorer/ParamOptions/_ParamOptions.scss

@@ -107,7 +107,8 @@
   }
 
   &:active {
-    box-shadow: inset 0 0 0 1px var(--openapi-input-border),
+    box-shadow:
+      inset 0 0 0 1px var(--openapi-input-border),
       inset 0 0 0 2px var(--openapi-inverse-color);
   }
 }

package/lib/theme/ApiExplorer/Request/_Request.scss

@@ -2,7 +2,8 @@
   background-color: var(--ifm-pre-background);
   border-radius: var(--openapi-card-border-radius);
   border: 1px solid var(--openapi-explorer-border-color);
-  box-shadow: 0 2px 3px hsla(222, 8%, 43%, 0.1),
+  box-shadow:
+    0 2px 3px hsla(222, 8%, 43%, 0.1),
     0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
   color: var(--ifm-pre-color);
   line-height: var(--ifm-pre-line-height);
@@ -19,7 +20,8 @@
   }
 
   &:hover {
-    box-shadow: 0 0 0 2px rgba(38, 53, 61, 0.15),
+    box-shadow:
+      0 0 0 2px rgba(38, 53, 61, 0.15),
       0 2px 3px hsla(222, 8%, 43%, 0.15),
       0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
   }

package/lib/theme/ApiExplorer/Response/_Response.scss

@@ -2,7 +2,8 @@
   background-color: var(--ifm-pre-background);
   border-radius: var(--openapi-card-border-radius);
   border: 1px solid var(--openapi-explorer-border-color);
-  box-shadow: 0 2px 3px hsla(222, 8%, 43%, 0.1),
+  box-shadow:
+    0 2px 3px hsla(222, 8%, 43%, 0.1),
     0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
   color: var(--ifm-pre-color);
   line-height: var(--ifm-pre-line-height);
@@ -12,7 +13,8 @@
   transition: 300ms;
 
   &:hover {
-    box-shadow: 0 0 0 2px rgba(38, 53, 61, 0.15),
+    box-shadow:
+      0 0 0 2px rgba(38, 53, 61, 0.15),
       0 2px 3px hsla(222, 8%, 43%, 0.15),
       0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-733",
+  "version": "0.0.0-736",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -41,7 +41,7 @@
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "0.0.0-733",
+    "docusaurus-plugin-openapi-docs": "0.0.0-736",
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "df9ca2a519f0b1ad22acc12dfe2b085ac4797b1d"
+  "gitHead": "ac63a892a690324697897289720d42d4bd3989fa"
 }

package/src/index.ts

@@ -18,7 +18,7 @@ export default function docusaurusThemeOpenAPI(): Plugin<void> {
     getClientModules() {
       const modules = [
         require.resolve(
-          path.join(__dirname, "..", "lib", "theme", "styles.scss")
+          path.join(__dirname, "..", "lib", "theme", "styles.scss"),
         ),
       ];
       return modules;

package/src/markdown/schema.ts

@@ -45,7 +45,7 @@ function prettyName(schema: SchemaObject, circular?: boolean) {
 
 export function getSchemaName(
   schema: SchemaObject,
-  circular?: boolean
+  circular?: boolean,
 ): string {
   if (schema.items) {
     return prettyName(schema.items, circular) + "[]";
@@ -79,7 +79,7 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
   if (schema.items && schema.items.enum) {
     if (schema.items.enum) {
       qualifierGroups.push(
-        `[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`
+        `[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`,
       );
     }
   }
@@ -150,7 +150,7 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
 
   if (schema.pattern) {
     qualifierGroups.push(
-      `Value must match regular expression \`${schema.pattern}\``
+      `Value must match regular expression \`${schema.pattern}\``,
     );
   }
 

package/src/markdown/utils.ts

@@ -22,7 +22,7 @@ export function create(tag: string, props: Props): string {
 
 export function guard<T>(
   value: T | undefined | string,
-  cb: (value: T) => Children
+  cb: (value: T) => Children,
 ): string {
   if (!!value || value === 0) {
     const children = cb(value as T);

package/src/theme/ApiExplorer/ApiCodeBlock/Container/index.js

@@ -22,7 +22,7 @@ export default function CodeBlockContainer({ as: As, ...props }) {
       className={clsx(
         "openapi-explorer__code-block-container",
         props.className,
-        ThemeClassNames.common.codeBlock
+        ThemeClassNames.common.codeBlock,
       )}
     />
   );

package/src/theme/ApiExplorer/ApiCodeBlock/Content/Element.js

@@ -21,7 +21,7 @@ export default function CodeBlockJSX({ children, className }) {
       className={clsx(
         "openapi-explorer__code-block-standalone",
         "thin-scrollbar",
-        className
+        className,
       )}
     >
       <code className="openapi-explorer__code-block-lines">{children}</code>

package/src/theme/ApiExplorer/ApiCodeBlock/Content/String.js

@@ -57,7 +57,7 @@ export default function CodeBlockString({
         blockClassName,
         language &&
           !blockClassName.includes(`language-${language}`) &&
-          `language-${language}`
+          `language-${language}`,
       )}
     >
       {title && (
@@ -78,14 +78,14 @@ export default function CodeBlockString({
               className={clsx(
                 className,
                 "openapi-explorer__code-block",
-                "thin-scrollbar"
+                "thin-scrollbar",
               )}
             >
               <code
                 className={clsx(
                   "openapi-explorer__code-block-lines",
                   showLineNumbers &&
-                    "openapi-explorer__code-block-lines-numbering"
+                    "openapi-explorer__code-block-lines-numbering",
                 )}
               >
                 {tokens.map((line, i) => (
@@ -117,7 +117,7 @@ export default function CodeBlockString({
           <ExpandButton
             className={clsx(
               "openapi-explorer__code-block-code-btn",
-              "openapi-explorer__expand-btn"
+              "openapi-explorer__expand-btn",
             )}
             code={code}
             language={language}

package/src/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.js

@@ -48,7 +48,7 @@ export default function CopyButton({ code, className }) {
         "clean-btn",
         className,
         "openapi-explorer__code-block-copy-btn",
-        isCopied && "openapi-explorer__code-block-copy-btn--copied"
+        isCopied && "openapi-explorer__code-block-copy-btn--copied",
       )}
       onClick={handleCopyCode}
     >

package/src/theme/ApiExplorer/ApiCodeBlock/ExitButton/index.js

@@ -27,7 +27,7 @@ export default function ExitButton({ className, handler }) {
       className={clsx(
         "clean-btn",
         "openapi-explorer__code-block-exit-btn",
-        className
+        className,
       )}
       onClick={handler}
     >

package/src/theme/ApiExplorer/ApiCodeBlock/ExpandButton/index.js

@@ -59,7 +59,7 @@ export default function ExpandButton({
           "clean-btn",
           className,
           "openapi-explorer__code-block-expand-btn",
-          isModalOpen && "openapi-explorer__code-block-expand-btn--copied"
+          isModalOpen && "openapi-explorer__code-block-expand-btn--copied",
         )}
         onClick={() => setIsModalOpen(true)}
       >
@@ -94,7 +94,7 @@ export default function ExpandButton({
             "openapi-explorer__code-block-container",
             language &&
               !blockClassName.includes(`language-${language}`) &&
-              `language-${language}`
+              `language-${language}`,
           )}
         >
           {title && (
@@ -114,14 +114,14 @@ export default function ExpandButton({
                   className={clsx(
                     className,
                     "openapi-explorer__code-block",
-                    "thin-scrollbar"
+                    "thin-scrollbar",
                   )}
                 >
                   <code
                     className={clsx(
                       "openapi-explorer__code-block-lines",
                       showLineNumbers &&
-                        "openapi-explorer__code-block-lines-numbers"
+                        "openapi-explorer__code-block-lines-numbers",
                     )}
                   >
                     {tokens.map((line, i) => (

package/src/theme/ApiExplorer/ApiCodeBlock/Line/index.js

@@ -23,7 +23,7 @@ export default function CodeBlockLine({
     line,
     className: clsx(
       classNames,
-      showLineNumbers && "openapi-explorer__code-block-code-line"
+      showLineNumbers && "openapi-explorer__code-block-code-line",
     ),
   });
   const lineTokens = line.map((token, key) => (

package/src/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.js

@@ -24,7 +24,7 @@ export default function WordWrapButton({ className, onClick, isEnabled }) {
       className={clsx(
         "clean-btn",
         className,
-        isEnabled && "openapi-explorer__code-block-word-wrap-btn--enabled"
+        isEnabled && "openapi-explorer__code-block-word-wrap-btn--enabled",
       )}
       aria-label={title}
       title={title}

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

@@ -56,7 +56,7 @@ function Authorization() {
                       scheme: a.key,
                       key: "token",
                       value: value ? value : undefined,
-                    })
+                    }),
                   );
                 }}
               />
@@ -77,7 +77,7 @@ function Authorization() {
                       scheme: a.key,
                       key: "token",
                       value: value ? value : undefined,
-                    })
+                    }),
                   );
                 }}
               />
@@ -99,7 +99,7 @@ function Authorization() {
                         scheme: a.key,
                         key: "username",
                         value: value ? value : undefined,
-                      })
+                      }),
                     );
                   }}
                 />
@@ -116,7 +116,7 @@ function Authorization() {
                         scheme: a.key,
                         key: "password",
                         value: value ? value : undefined,
-                      })
+                      }),
                     );
                   }}
                 />
@@ -138,7 +138,7 @@ function Authorization() {
                       scheme: a.key,
                       key: "apiKey",
                       value: value ? value : undefined,
-                    })
+                    }),
                   );
                 }}
               />

package/src/theme/ApiExplorer/Authorization/slice.ts

@@ -130,7 +130,7 @@ export const slice = createSlice({
   reducers: {
     setAuthData: (
       state,
-      action: PayloadAction<{ scheme: string; key: string; value?: string }>
+      action: PayloadAction<{ scheme: string; key: string; value?: string }>,
     ) => {
       const { scheme, key, value } = action.payload;
       state.data[scheme][key] = value;

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

@@ -108,7 +108,7 @@ function Body({
               setFileRawBody({
                 src: `/path/to/${file.name}`,
                 content: file,
-              })
+              }),
             );
           }}
         />
@@ -148,7 +148,7 @@ function Body({
                             src: `/path/to/${file.name}`,
                             content: file,
                           },
-                        })
+                        }),
                       );
                     }}
                   />
@@ -177,7 +177,7 @@ function Body({
                           setStringFormBody({
                             key: key,
                             value: val,
-                          })
+                          }),
                         );
                       }
                     }}
@@ -204,7 +204,7 @@ function Body({
                   placeholder={val.description || key}
                   onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
                     dispatch(
-                      setStringFormBody({ key: key, value: e.target.value })
+                      setStringFormBody({ key: key, value: e.target.value }),
                     );
                   }}
                 />

package/src/theme/ApiExplorer/Body/slice.ts

@@ -78,7 +78,7 @@ export const slice = createSlice({
     },
     setStringFormBody: (
       state,
-      action: PayloadAction<{ key: string; value: string }>
+      action: PayloadAction<{ key: string; value: string }>,
     ) => {
       if (state?.type !== "form") {
         return {
@@ -99,7 +99,7 @@ export const slice = createSlice({
     },
     setFileFormBody: (
       state,
-      action: PayloadAction<{ key: string; value: FileContent["value"] }>
+      action: PayloadAction<{ key: string; value: FileContent["value"] }>,
     ) => {
       if (state?.type !== "form") {
         return {

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

@@ -5,6 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+/* ============================================================================
+ * 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, { useState, useEffect } from "react";
 
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
@@ -12,13 +19,13 @@ import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock";
 import buildPostmanRequest from "@theme/ApiExplorer/buildPostmanRequest";
 import CodeTabs from "@theme/ApiExplorer/CodeTabs";
 import { useTypedSelector } from "@theme/ApiItem/hooks";
-import merge from "lodash/merge";
 import codegen from "postman-code-generators";
 import sdk from "postman-collection";
 
 import { CodeSample, Language } from "./code-snippets-types";
 import {
   getCodeSampleSourceFromLanguage,
+  mergeArraysbyLanguage,
   mergeCodeSampleLanguage,
 } from "./languages";
 
@@ -149,8 +156,6 @@ function CodeTab({ children, hidden, className }: any): JSX.Element {
 }
 
 function CodeSnippets({ postman, codeSamples }: Props) {
-  // TODO: match theme for vscode.
-
   const { siteConfig } = useDocusaurusContext();
 
   const contentType = useTypedSelector((state: any) => state.contentType.value);
@@ -167,28 +172,29 @@ function CodeSnippets({ postman, codeSamples }: Props) {
 
   // User-defined languages array
   // Can override languageSet, change order of langs, override options and variants
-  const langs = [
-    ...((siteConfig?.themeConfig?.languageTabs as Language[] | undefined) ??
-      languageSet),
-  ];
+  const userDefinedLanguageSet = siteConfig?.themeConfig?.languageTabs as
+    | Language[]
+    | undefined;
 
   // Filter languageSet by user-defined langs
   const filteredLanguageSet = languageSet.filter((ls) => {
-    return langs.some((lang) => {
+    return userDefinedLanguageSet?.some((lang) => {
       return lang.language === ls.language;
     });
   });
 
   // Merge user-defined langs into languageSet
   const mergedLangs = mergeCodeSampleLanguage(
-    merge(filteredLanguageSet, langs),
-    codeSamples
+    mergeArraysbyLanguage(userDefinedLanguageSet, filteredLanguageSet),
+    codeSamples,
   );
 
+  console.log("merged", mergedLangs);
+
   // Read defaultLang from localStorage
   const defaultLang: Language[] = mergedLangs.filter(
     (lang) =>
-      lang.language === localStorage.getItem("docusaurus.tab.code-samples")
+      lang.language === localStorage.getItem("docusaurus.tab.code-samples"),
   );
   const [selectedVariant, setSelectedVariant] = useState<string | undefined>();
   const [selectedSample, setSelectedSample] = useState<string | undefined>();
@@ -232,11 +238,11 @@ function CodeSnippets({ postman, codeSamples }: Props) {
             return;
           }
           setCodeText(snippet);
-        }
+        },
       );
     } else if (language && !language.options) {
       const langSource = mergedLangs.filter(
-        (lang) => lang.language === language.language
+        (lang) => lang.language === language.language,
       );
 
       // Merges user-defined language with default languageSet
@@ -265,7 +271,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
             return;
           }
           setCodeText(snippet);
-        }
+        },
       );
     } else {
       setCodeText("");
@@ -308,7 +314,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
             return;
           }
           setCodeText(snippet);
-        }
+        },
       );
     }
   });
@@ -323,7 +329,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
       selectedSample !== language.sample
     ) {
       const sampleIndex = language.samples.findIndex(
-        (smp) => smp === selectedSample
+        (smp) => smp === selectedSample,
       );
       setCodeSampleCodeText(language.samplesSources[sampleIndex]);
     }