docusaurus-theme-openapi-docs 2.0.3 → 2.1.0

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/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/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.3",
+  "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.3",
+    "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": "f6641c0ce01e3247a06ef8ddde7bafbe749d4ed1"
+  "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/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,17 @@ 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 {
+  getCodeSampleSourceFromLanguage,
+  mergeCodeSampleLanguage,
+} from "./languages";
 
 export const languageSet: Language[] = [
   {
     highlight: "bash",
     language: "curl",
+    codeSampleLanguage: "Shell",
     logoClass: "bash",
     options: {
       longFormat: false,
@@ -42,6 +39,7 @@ export const languageSet: Language[] = [
   {
     highlight: "python",
     language: "python",
+    codeSampleLanguage: "Python",
     logoClass: "python",
     options: {
       followRedirect: true,
@@ -53,6 +51,7 @@ export const languageSet: Language[] = [
   {
     highlight: "go",
     language: "go",
+    codeSampleLanguage: "Go",
     logoClass: "go",
     options: {
       followRedirect: true,
@@ -64,6 +63,7 @@ export const languageSet: Language[] = [
   {
     highlight: "javascript",
     language: "nodejs",
+    codeSampleLanguage: "JavaScript",
     logoClass: "nodejs",
     options: {
       ES6_enabled: true,
@@ -71,11 +71,12 @@ export const languageSet: Language[] = [
       trimRequestBody: true,
     },
     variant: "axios",
-    variants: ["axios", "native", "request", "unirest"],
+    variants: ["axios", "native"],
   },
   {
     highlight: "ruby",
     language: "ruby",
+    codeSampleLanguage: "Ruby",
     logoClass: "ruby",
     options: {
       followRedirect: true,
@@ -87,6 +88,7 @@ export const languageSet: Language[] = [
   {
     highlight: "csharp",
     language: "csharp",
+    codeSampleLanguage: "C#",
     logoClass: "csharp",
     options: {
       followRedirect: true,
@@ -98,6 +100,7 @@ export const languageSet: Language[] = [
   {
     highlight: "php",
     language: "php",
+    codeSampleLanguage: "PHP",
     logoClass: "php",
     options: {
       followRedirect: true,
@@ -109,6 +112,7 @@ export const languageSet: Language[] = [
   {
     highlight: "java",
     language: "java",
+    codeSampleLanguage: "Java",
     logoClass: "java",
     options: {
       followRedirect: true,
@@ -120,6 +124,7 @@ export const languageSet: Language[] = [
   {
     highlight: "powershell",
     language: "powershell",
+    codeSampleLanguage: "PowerShell",
     logoClass: "powershell",
     options: {
       followRedirect: true,
@@ -132,10 +137,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 +170,6 @@ function CodeSnippets({ postman, codeSamples }: Props) {
   const langs = [
     ...((siteConfig?.themeConfig?.languageTabs as Language[] | undefined) ??
       languageSet),
-    ...codeSamples,
   ];
 
   // Filter languageSet by user-defined langs
@@ -176,14 +180,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 +200,16 @@ 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 | (() => string)
+  >(() => getCodeSampleSourceFromLanguage(language));
 
   useEffect(() => {
+    if (language && !!language.sample) {
+      setCodeSampleCodeText(getCodeSampleSourceFromLanguage(language));
+    }
+
     if (language && !!language.options) {
       const postmanRequest = buildPostmanRequest(postman, {
         queryParams,
@@ -219,8 +234,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 +284,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 +313,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;
   }
@@ -311,7 +340,9 @@ function CodeSnippets({ postman, codeSamples }: Props) {
         action={{
           setLanguage: setLanguage,
           setSelectedVariant: setSelectedVariant,
+          setSelectedSample: setSelectedSample,
         }}
+        languageSet={mergedLangs}
         lazy
       >
         {mergedLangs.map((lang) => {
@@ -324,6 +355,47 @@ 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}
+                  languageSet={mergedLangs}
+                  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={{
@@ -333,9 +405,10 @@ function CodeSnippets({ postman, codeSamples }: Props) {
                 includeVariant={true}
                 currentLanguage={lang.language}
                 defaultValue={selectedVariant}
+                languageSet={mergedLangs}
                 lazy
               >
-                {lang.variants.map((variant) => {
+                {lang.variants.map((variant, index) => {
                   return (
                     <CodeTab
                       value={variant.toLowerCase()}