docusaurus-theme-openapi-docs 2.0.4 → 2.1.0

package/lib/markdown/utils.d.ts

@@ -1,5 +1,5 @@
-export declare type Children = string | undefined | (string | undefined)[];
-export declare type Props = Record<string, any> & {
+export type Children = string | undefined | (string | undefined)[];
+export type Props = Record<string, any> & {
     children?: Children;
 };
 export declare function create(tag: string, props: Props): string;

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/Accept/index.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function Accept(): JSX.Element | null;
+import React from "react";
+declare function Accept(): React.JSX.Element | null;
 export default Accept;

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

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function Authorization(): JSX.Element | null;
+import React from "react";
+declare function Authorization(): React.JSX.Element | null;
 export default Authorization;

package/lib/theme/ApiExplorer/Authorization/slice.d.ts

@@ -8,7 +8,7 @@ export declare function createAuth({ security, securitySchemes, options, }: {
     };
     options?: ThemeConfig["api"];
 }): AuthState;
-export declare type Scheme = {
+export type Scheme = {
     key: string;
     scopes: string[];
 } & SecuritySchemeObject;

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

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import React from "react";
 import { RequestBodyObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 export interface Props {
     jsonRequestBodyExample: string;
@@ -6,5 +6,5 @@ export interface Props {
     methods?: any;
     required?: boolean;
 }
-declare function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample, methods, required, }: Props): JSX.Element | null;
+declare function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample, methods, required, }: Props): React.JSX.Element | null;
 export default BodyWrap;

package/lib/theme/ApiExplorer/Body/slice.d.ts

@@ -10,7 +10,7 @@ export interface StringContent {
     type: "string";
     value?: string;
 }
-export declare type Content = FileContent | StringContent | undefined;
+export type Content = FileContent | StringContent | undefined;
 export interface FormBody {
     type: "form";
     content: {
@@ -24,8 +24,8 @@ export interface RawBody {
 export interface EmptyBody {
     type: "empty";
 }
-export declare type Body = EmptyBody | FormBody | RawBody;
-export declare type State = Body;
+export type Body = EmptyBody | FormBody | RawBody;
+export type State = Body;
 export declare const slice: import("@reduxjs/toolkit").Slice<EmptyBody | FormBody | RawBody, {
     clearRawBody: (_state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>) => {
         type: "empty";

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

@@ -1,4 +1,4 @@
-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 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;

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

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import React from "react";
 import sdk from "@paloaltonetworks/postman-collection";
 import { CodeSample, Language } from "./code-snippets-types";
 export declare const languageSet: Language[];
@@ -6,5 +6,5 @@ export interface Props {
     postman: sdk.Request;
     codeSamples: CodeSample[];
 }
-declare function CodeSnippets({ postman, codeSamples }: Props): JSX.Element | null;
+declare function CodeSnippets({ postman, codeSamples }: Props): React.JSX.Element | null;
 export default CodeSnippets;

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

@@ -246,19 +246,14 @@ function CodeSnippets({ postman, codeSamples }) {
     return defaultLang[0] ?? mergedLangs[0];
   });
   const [codeText, setCodeText] = (0, react_1.useState)("");
-  const [codeSampleCodeText, setCodeSampleCodeText] = (0, react_1.useState)("");
+  const [codeSampleCodeText, setCodeSampleCodeText] = (0, react_1.useState)(
+    () => (0, languages_1.getCodeSampleSourceFromLanguage)(language)
+  );
   (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
+    if (language && !!language.sample) {
+      setCodeSampleCodeText(
+        (0, languages_1.getCodeSampleSourceFromLanguage)(language)
       );
-      setCodeSampleCodeText(language.samplesSources[sampleIndex]);
     }
     if (language && !!language.options) {
       const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
@@ -388,7 +383,9 @@ function CodeSnippets({ postman, codeSamples }) {
         action: {
           setLanguage: setLanguage,
           setSelectedVariant: setSelectedVariant,
+          setSelectedSample: setSelectedSample,
         },
+        languageSet: mergedLangs,
         lazy: true,
       },
       mergedLangs.map((lang) => {
@@ -414,6 +411,7 @@ function CodeSnippets({ postman, codeSamples }) {
                 includeSample: true,
                 currentLanguage: lang.language,
                 defaultValue: selectedSample,
+                languageSet: mergedLangs,
                 lazy: true,
               },
               lang.samples.map((sample, index) => {
@@ -452,6 +450,7 @@ function CodeSnippets({ postman, codeSamples }) {
               includeVariant: true,
               currentLanguage: lang.language,
               defaultValue: selectedVariant,
+              languageSet: mergedLangs,
               lazy: true,
             },
             lang.variants.map((variant, index) => {

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

@@ -1,2 +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

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeCodeSampleLanguage = void 0;
+exports.getCodeSampleSourceFromLanguage = exports.mergeCodeSampleLanguage =
+  void 0;
 function mergeCodeSampleLanguage(languages, codeSamples) {
   return languages.map((language) => {
     const languageCodeSamples = codeSamples.filter(
@@ -30,3 +31,18 @@ function mergeCodeSampleLanguage(languages, codeSamples) {
   });
 }
 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/CodeTabs/index.js

@@ -12,12 +12,12 @@ import {
   useTabs,
 } from "@docusaurus/theme-common/internal";
 import useIsBrowser from "@docusaurus/useIsBrowser";
-import { languageSet } from "@theme/ApiExplorer/CodeSnippets";
 import clsx from "clsx";
 
 function TabList({
   action,
   currentLanguage,
+  languageSet,
   includeVariant,
   includeSample,
   className,
@@ -48,16 +48,18 @@ function TabList({
         )[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 = languageSet.filter(
           (lang) => lang.language === newTabValue
         )[0];
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
-      }
-
-      if (currentLanguage && includeSample) {
-        newLanguage.sample = newTabValue;
-        action.setSelectedSample(newTabValue.toLowerCase());
+        action.setSelectedSample(newLanguage.sample);
       }
 
       action.setLanguage(newLanguage);

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

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function ContentType(): JSX.Element | null;
+import React from "react";
+declare function ContentType(): React.JSX.Element | null;
 export default ContentType;

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

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function Export({ url, proxy }: any): JSX.Element;
+import React from "react";
+declare function Export({ url, proxy }: any): React.JSX.Element;
 export default Export;

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

@@ -4,5 +4,5 @@ export interface Props {
     onClick?: React.MouseEventHandler<HTMLButtonElement>;
     children?: React.ReactNode;
 }
-declare function FloatingButton({ label, onClick, children }: Props): JSX.Element;
+declare function FloatingButton({ label, onClick, children }: Props): React.JSX.Element;
 export default FloatingButton;

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

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 export interface Props {
     placeholder: string;
     onChange?(file?: File): any;
 }
-declare function FormFileUpload({ placeholder, onChange }: Props): JSX.Element;
+declare function FormFileUpload({ placeholder, onChange }: Props): React.JSX.Element;
 export default FormFileUpload;

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

@@ -6,5 +6,5 @@ export interface Props {
     children?: React.ReactNode;
     className?: string;
 }
-declare function FormItem({ label, type, required, children, className }: Props): JSX.Element;
+declare function FormItem({ label, type, required, children, className }: Props): React.JSX.Element;
 export default FormItem;

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

@@ -5,5 +5,5 @@ export interface Props {
     onChange?: React.ChangeEventHandler<HTMLSelectElement>;
     showErrors?: boolean;
 }
-declare function FormMultiSelect({ value, options, onChange, showErrors }: Props): JSX.Element | null;
+declare function FormMultiSelect({ value, options, onChange, showErrors }: Props): React.JSX.Element | null;
 export default FormMultiSelect;

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

@@ -4,5 +4,5 @@ export interface Props {
     options?: string[];
     onChange?: React.ChangeEventHandler<HTMLSelectElement>;
 }
-declare function FormSelect({ value, options, onChange }: Props): JSX.Element | null;
+declare function FormSelect({ value, options, onChange }: Props): React.JSX.Element | null;
 export default FormSelect;

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

@@ -5,5 +5,5 @@ export interface Props {
     password?: boolean;
     onChange?: React.ChangeEventHandler<HTMLInputElement>;
 }
-declare function FormTextInput({ isRequired, value, placeholder, password, onChange, paramName, }: Props): JSX.Element;
+declare function FormTextInput({ isRequired, value, placeholder, password, onChange, paramName, }: Props): React.JSX.Element;
 export default FormTextInput;

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

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 export interface Props {
     method: string;
     path: string;
 }
-declare function MethodEndpoint({ method, path }: Props): JSX.Element;
+declare function MethodEndpoint({ method, path }: Props): React.JSX.Element;
 export default MethodEndpoint;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamArrayFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamArrayFormItem({ param }: ParamProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamBooleanFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamBooleanFormItem({ param }: ParamProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamMultiSelectFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamMultiSelectFormItem({ param }: ParamProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamSelectFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamSelectFormItem({ param }: ParamProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamTextFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamTextFormItem({ param }: ParamProps): React.JSX.Element;

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

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "./slice";
 export interface ParamProps {
     param: Param;
 }
-declare function ParamOptions(): JSX.Element;
+declare function ParamOptions(): React.JSX.Element;
 export default ParamOptions;

package/lib/theme/ApiExplorer/ParamOptions/slice.d.ts

@@ -1,6 +1,6 @@
 import { PayloadAction } from "@reduxjs/toolkit";
 import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
-export declare type Param = ParameterObject & {
+export type Param = ParameterObject & {
     value?: string[] | string;
 };
 export interface State {

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

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 declare function Request({ item }: {
     item: NonNullable<ApiItem>;
-}): JSX.Element | null;
+}): React.JSX.Element | null;
 export default Request;

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

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 declare function Response({ item }: {
     item: NonNullable<ApiItem>;
-}): JSX.Element | null;
+}): React.JSX.Element | null;
 export default Response;

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

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function SecuritySchemes(props: any): JSX.Element | null;
+import React from "react";
+declare function SecuritySchemes(props: any): React.JSX.Element | null;
 export default SecuritySchemes;

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

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function Server(): JSX.Element | null;
+import React from "react";
+declare function Server(): React.JSX.Element | null;
 export default Server;

package/lib/theme/ApiExplorer/buildPostmanRequest.d.ts

@@ -2,7 +2,7 @@ import sdk from "@paloaltonetworks/postman-collection";
 import { AuthState } from "@theme/ApiExplorer/Authorization/slice";
 import { Body } from "@theme/ApiExplorer/Body/slice";
 import { ParameterObject, ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
-declare type Param = {
+type Param = {
     value?: string | string[];
 } & ParameterObject;
 interface Options {

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

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 declare function ApiExplorer({ item, infoPath, }: {
     item: NonNullable<ApiItem>;
     infoPath: string;
-}): JSX.Element;
+}): React.JSX.Element;
 export default ApiExplorer;

package/lib/theme/ApiExplorer/storage-utils.d.ts

@@ -1,4 +1,4 @@
 export declare function hashArray(arr: string[]): string;
-declare type Persistance = false | "localStorage" | "sessionStorage" | undefined;
+type Persistance = false | "localStorage" | "sessionStorage" | undefined;
 export declare function createStorage(persistance: Persistance): Storage;
 export {};

package/lib/theme/ApiItem/index.js

@@ -40,6 +40,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(
@@ -163,6 +164,29 @@ function ApiItem(props) {
         )
       )
     );
+  } else if (schema) {
+    return react_1.default.createElement(
+      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(

package/lib/theme/ApiItem/store.d.ts

@@ -7,8 +7,8 @@ declare const rootReducer: import("redux").Reducer<import("redux").CombinedState
     params: unknown;
     auth: unknown;
 }>, import("redux").Action<any>>;
-export declare type RootState = ReturnType<typeof rootReducer>;
-export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").CombinedState<{
+export type RootState = ReturnType<typeof rootReducer>;
+export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -16,7 +16,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
     body: unknown;
     params: unknown;
     auth: unknown;
-}>, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
+}, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -25,7 +25,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
     params: unknown;
     auth: unknown;
 }>, import("redux").AnyAction, undefined>, ...any[]]>>;
-export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").CombinedState<{
+export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -33,7 +33,7 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
     body: unknown;
     params: unknown;
     auth: unknown;
-}>, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
+}, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -42,5 +42,5 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
     params: unknown;
     auth: unknown;
 }>, import("redux").AnyAction, undefined>, ...any[]]>>;
-export declare type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
+export type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
 export {};

package/lib/theme/SchemaItem/index.js

@@ -79,14 +79,11 @@ function SchemaItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(
-    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
-    (value) => (
-      <div className="">
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
-  );
+  const renderDefaultValue = guard(defaultValue, (value) => (
+    <div className="">
+      <ReactMarkdown children={`**Default value:** \`${value}\``} />
+    </div>
+  ));
 
   const schemaContent = (
     <div>

package/lib/types.d.ts

@@ -9,8 +9,8 @@ export interface ThemeConfig {
 interface Map<T> {
     [key: string]: T;
 }
-export declare type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
-export declare type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
+export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
     type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
     allOf?: SchemaObject[];
     oneOf?: SchemaObject[];
@@ -43,14 +43,14 @@ export interface ExternalDocumentationObject {
     description?: string;
     url: string;
 }
-export declare type FileChange = {
+export type FileChange = {
     author?: string;
     /** Date can be any
      * [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
      */
     date?: Date | string;
 };
-export declare type DocFrontMatter = {
+export type DocFrontMatter = {
     /**
      * The last part of the doc ID (will be refactored in the future to be the
      * full ID instead)

package/package.json

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

package/src/markdown/utils.test.ts

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

package/src/markdown/utils.ts

@@ -24,11 +24,11 @@ export function guard<T>(
   value: T | undefined | string,
   cb: (value: T) => Children
 ): string {
-  if (!!value) {
-    const children = cb(value as T);
-    return render(children);
+  if (value === undefined || value === "") {
+    return "";
   }
-  return "";
+  const children = cb(value as T);
+  return render(children);
 }
 
 export function render(children: Children): string {

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

@@ -17,7 +17,10 @@ import { useTypedSelector } from "@theme/ApiItem/hooks";
 import merge from "lodash/merge";
 
 import { CodeSample, Language } from "./code-snippets-types";
-import { mergeCodeSampleLanguage } from "./languages";
+import {
+  getCodeSampleSourceFromLanguage,
+  mergeCodeSampleLanguage,
+} from "./languages";
 
 export const languageSet: Language[] = [
   {
@@ -198,20 +201,13 @@ function CodeSnippets({ postman, codeSamples }: Props) {
     return defaultLang[0] ?? mergedLangs[0];
   });
   const [codeText, setCodeText] = useState<string>("");
-  const [codeSampleCodeText, setCodeSampleCodeText] = useState<string>("");
+  const [codeSampleCodeText, setCodeSampleCodeText] = useState<
+    string | (() => string)
+  >(() => getCodeSampleSourceFromLanguage(language));
 
   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.sample) {
+      setCodeSampleCodeText(getCodeSampleSourceFromLanguage(language));
     }
 
     if (language && !!language.options) {
@@ -344,7 +340,9 @@ function CodeSnippets({ postman, codeSamples }: Props) {
         action={{
           setLanguage: setLanguage,
           setSelectedVariant: setSelectedVariant,
+          setSelectedSample: setSelectedSample,
         }}
+        languageSet={mergedLangs}
         lazy
       >
         {mergedLangs.map((lang) => {
@@ -367,6 +365,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
                   includeSample={true}
                   currentLanguage={lang.language}
                   defaultValue={selectedSample}
+                  languageSet={mergedLangs}
                   lazy
                 >
                   {lang.samples.map((sample, index) => {
@@ -406,6 +405,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
                 includeVariant={true}
                 currentLanguage={lang.language}
                 defaultValue={selectedVariant}
+                languageSet={mergedLangs}
                 lazy
               >
                 {lang.variants.map((variant, index) => {

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

@@ -35,3 +35,19 @@ export function mergeCodeSampleLanguage(
     return language;
   });
 }
+
+export function getCodeSampleSourceFromLanguage(language: Language) {
+  if (
+    language &&
+    language.sample &&
+    language.samples &&
+    language.samplesSources
+  ) {
+    const sampleIndex = language.samples.findIndex(
+      (smp) => smp === language.sample
+    );
+    return language.samplesSources[sampleIndex];
+  }
+
+  return "";
+}

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

@@ -12,12 +12,12 @@ import {
   useTabs,
 } from "@docusaurus/theme-common/internal";
 import useIsBrowser from "@docusaurus/useIsBrowser";
-import { languageSet } from "@theme/ApiExplorer/CodeSnippets";
 import clsx from "clsx";
 
 function TabList({
   action,
   currentLanguage,
+  languageSet,
   includeVariant,
   includeSample,
   className,
@@ -48,16 +48,18 @@ function TabList({
         )[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 = languageSet.filter(
           (lang) => lang.language === newTabValue
         )[0];
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
-      }
-
-      if (currentLanguage && includeSample) {
-        newLanguage.sample = newTabValue;
-        action.setSelectedSample(newTabValue.toLowerCase());
+        action.setSelectedSample(newLanguage.sample);
       }
 
       action.setLanguage(newLanguage);

package/src/theme/ApiItem/index.tsx

@@ -44,12 +44,17 @@ interface ApiFrontMatter extends DocFrontMatter {
   readonly api?: ApiItemType;
 }
 
+interface SchemaFrontMatter extends DocFrontMatter {
+  readonly schema?: boolean;
+}
+
 export default function ApiItem(props: Props): JSX.Element {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
   const MDXComponent = props.content;
   const { frontMatter } = MDXComponent;
   const { info_path: infoPath } = frontMatter as DocFrontMatter;
   let { api } = frontMatter as ApiFrontMatter;
+  const { schema } = frontMatter as SchemaFrontMatter;
   // decompress and parse
   if (api) {
     api = JSON.parse(
@@ -159,6 +164,21 @@ export default function ApiItem(props: Props): JSX.Element {
         </HtmlClassNameProvider>
       </DocProvider>
     );
+  } else if (schema) {
+    return (
+      <DocProvider content={props.content}>
+        <HtmlClassNameProvider className={docHtmlClassName}>
+          <DocItemMetadata />
+          <DocItemLayout>
+            <div className={clsx("row", "theme-api-markdown")}>
+              <div className="col col--12">
+                <MDXComponent />
+              </div>
+            </div>
+          </DocItemLayout>
+        </HtmlClassNameProvider>
+      </DocProvider>
+    );
   }
 
   // Non-API docs

package/src/theme/SchemaItem/index.js

@@ -79,14 +79,11 @@ function SchemaItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(
-    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
-    (value) => (
-      <div className="">
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
-  );
+  const renderDefaultValue = guard(defaultValue, (value) => (
+    <div className="">
+      <ReactMarkdown children={`**Default value:** \`${value}\``} />
+    </div>
+  ));
 
   const schemaContent = (
     <div>