docusaurus-theme-openapi-docs 4.1.0 → 4.3.0

package/lib/theme/ParamsItem/index.js

@@ -12,15 +12,11 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
-const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
 /* eslint-disable import/no-extraneous-dependencies*/
 const clsx_1 = __importDefault(require("clsx"));
-const react_markdown_1 = __importDefault(require("react-markdown"));
-const rehype_raw_1 = __importDefault(require("rehype-raw"));
-const remark_gfm_1 = __importDefault(require("remark-gfm"));
-const createDescription_1 = require("../../markdown/createDescription");
 const schema_1 = require("../../markdown/schema");
 const utils_1 = require("../../markdown/utils");
 const getEnumDescriptionMarkdown = (enumDescriptions) => {
@@ -80,55 +76,22 @@ function ParamsItem({ param, ...rest }) {
       "deprecated"
     )
   );
-  const renderSchema = (0, utils_1.guard)(
+  const renderQualifier = (0, utils_1.guard)(
     (0, schema_1.getQualifierMessage)(schema),
-    (message) =>
-      react_1.default.createElement(
-        "div",
-        null,
-        react_1.default.createElement(react_markdown_1.default, {
-          children: (0, createDescription_1.createDescription)(message),
-          rehypePlugins: [rehype_raw_1.default],
-        })
-      )
+    (qualifier) =>
+      react_1.default.createElement(Markdown_1.default, null, qualifier)
   );
   const renderDescription = (0, utils_1.guard)(description, (description) =>
-    react_1.default.createElement(
-      "div",
-      null,
-      react_1.default.createElement(react_markdown_1.default, {
-        children: (0, createDescription_1.createDescription)(description),
-        components: {
-          pre: "div",
-          code({ node, inline, className, children, ...props }) {
-            const match = /language-(\w+)/.exec(className || "");
-            if (inline)
-              return react_1.default.createElement("code", null, children);
-            return !inline && match
-              ? react_1.default.createElement(
-                  CodeBlock_1.default,
-                  { className: className },
-                  children
-                )
-              : react_1.default.createElement(
-                  CodeBlock_1.default,
-                  null,
-                  children
-                );
-          },
-        },
-        rehypePlugins: [rehype_raw_1.default],
-      })
-    )
+    react_1.default.createElement(Markdown_1.default, null, description)
   );
   const renderEnumDescriptions = (0, utils_1.guard)(
     getEnumDescriptionMarkdown(enumDescriptions),
     (value) => {
-      return react_1.default.createElement(react_markdown_1.default, {
-        rehypePlugins: [rehype_raw_1.default],
-        remarkPlugins: [remark_gfm_1.default],
-        children: value,
-      });
+      return react_1.default.createElement(
+        "div",
+        { style: { marginTop: ".5rem" } },
+        react_1.default.createElement(Markdown_1.default, null, value)
+      );
     }
   );
   function renderDefaultValue() {
@@ -241,7 +204,7 @@ function ParamsItem({ param, ...rest }) {
       renderSchemaRequired,
       renderDeprecated
     ),
-    renderSchema,
+    renderQualifier,
     renderDescription,
     renderEnumDescriptions,
     renderDefaultValue(),

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

@@ -0,0 +1,15 @@
+import React from "react";
+import { MediaTypeObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
+interface Props {
+    style?: React.CSSProperties;
+    title: string;
+    body: {
+        content?: {
+            [key: string]: MediaTypeObject;
+        };
+        description?: string;
+        required?: string[] | boolean;
+    };
+}
+declare const RequestSchema: React.FC<Props>;
+export default RequestSchema;

package/lib/theme/RequestSchema/index.js

@@ -0,0 +1,243 @@
+"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.
+ * ========================================================================== */
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importStar(require("react"));
+const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
+const Details_1 = __importDefault(require("@theme/Details"));
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const MimeTabs_1 = __importDefault(require("@theme/MimeTabs")); // Assume these components exist
+const Schema_1 = __importDefault(require("@theme/Schema"));
+const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const RequestSchemaComponent = ({ title, body, style }) => {
+  if (
+    body === undefined ||
+    body.content === undefined ||
+    Object.keys(body).length === 0 ||
+    Object.keys(body.content).length === 0
+  ) {
+    return null;
+  }
+  const mimeTypes = Object.keys(body.content);
+  if (mimeTypes.length > 1) {
+    return react_1.default.createElement(
+      MimeTabs_1.default,
+      { className: "openapi-tabs__mime", schemaType: "request" },
+      mimeTypes.map((mimeType) => {
+        const firstBody = body.content[mimeType].schema;
+        if (
+          firstBody === undefined ||
+          (firstBody.properties &&
+            Object.keys(firstBody.properties).length === 0)
+        ) {
+          return null;
+        }
+        return (
+          // @ts-ignore
+          react_1.default.createElement(
+            TabItem_1.default,
+            { key: mimeType, label: mimeType, value: mimeType },
+            react_1.default.createElement(
+              Details_1.default,
+              {
+                className: "openapi-markdown__details mime",
+                "data-collapsed": false,
+                open: true,
+                style: style,
+                summary: react_1.default.createElement(
+                  react_1.default.Fragment,
+                  null,
+                  react_1.default.createElement(
+                    "summary",
+                    null,
+                    react_1.default.createElement(
+                      "h3",
+                      {
+                        className:
+                          "openapi-markdown__details-summary-header-body",
+                      },
+                      title,
+                      body.required === true &&
+                        react_1.default.createElement(
+                          "span",
+                          { className: "openapi-schema__required" },
+                          "required"
+                        )
+                    )
+                  )
+                ),
+              },
+              react_1.default.createElement(
+                "div",
+                { style: { textAlign: "left", marginLeft: "1rem" } },
+                body.description &&
+                  react_1.default.createElement(
+                    "div",
+                    { style: { marginTop: "1rem", marginBottom: "1rem" } },
+                    react_1.default.createElement(
+                      Markdown_1.default,
+                      null,
+                      body.description
+                    )
+                  )
+              ),
+              react_1.default.createElement(
+                "ul",
+                { style: { marginLeft: "1rem" } },
+                react_1.default.createElement(Schema_1.default, {
+                  schema: firstBody,
+                  schemaType: "request",
+                })
+              )
+            )
+          )
+        );
+      })
+    );
+  }
+  const randomFirstKey = mimeTypes[0];
+  const firstBody =
+    body.content[randomFirstKey].schema ?? body.content[randomFirstKey];
+  if (firstBody === undefined) {
+    return null;
+  }
+  return react_1.default.createElement(
+    MimeTabs_1.default,
+    { className: "openapi-tabs__mime", schemaType: "request" },
+    react_1.default.createElement(
+      TabItem_1.default,
+      { label: randomFirstKey, value: `${randomFirstKey}-schema` },
+      react_1.default.createElement(
+        Details_1.default,
+        {
+          className: "openapi-markdown__details mime",
+          "data-collapsed": false,
+          open: true,
+          style: style,
+          summary: react_1.default.createElement(
+            react_1.default.Fragment,
+            null,
+            react_1.default.createElement(
+              "summary",
+              null,
+              react_1.default.createElement(
+                "h3",
+                { className: "openapi-markdown__details-summary-header-body" },
+                title,
+                firstBody.type === "array" &&
+                  react_1.default.createElement(
+                    "span",
+                    { style: { opacity: "0.6" } },
+                    " array"
+                  ),
+                body.required &&
+                  react_1.default.createElement(
+                    "strong",
+                    { className: "openapi-schema__required" },
+                    "required"
+                  )
+              )
+            )
+          ),
+        },
+        react_1.default.createElement(
+          "div",
+          { style: { textAlign: "left", marginLeft: "1rem" } },
+          body.description &&
+            react_1.default.createElement(
+              "div",
+              { style: { marginTop: "1rem", marginBottom: "1rem" } },
+              react_1.default.createElement(
+                Markdown_1.default,
+                null,
+                body.description
+              )
+            )
+        ),
+        react_1.default.createElement(
+          "ul",
+          { style: { marginLeft: "1rem" } },
+          react_1.default.createElement(Schema_1.default, {
+            schema: firstBody,
+            schemaType: "request",
+          })
+        )
+      )
+    )
+  );
+};
+const RequestSchema = (props) => {
+  return react_1.default.createElement(
+    BrowserOnly_1.default,
+    {
+      fallback: react_1.default.createElement(SkeletonLoader_1.default, {
+        size: "sm",
+      }),
+    },
+    () => {
+      const LazyComponent = react_1.default.lazy(() =>
+        Promise.resolve({ default: RequestSchemaComponent })
+      );
+      return react_1.default.createElement(
+        react_1.Suspense,
+        { fallback: null },
+        react_1.default.createElement(LazyComponent, { ...props })
+      );
+    }
+  );
+};
+exports.default = RequestSchema;

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

@@ -0,0 +1,18 @@
+import React from "react";
+export declare function json2xml(o: Record<string, any>, tab: string): string;
+interface ResponseExamplesProps {
+    responseExamples: any;
+    mimeType: string;
+}
+export declare const ResponseExamples: React.FC<ResponseExamplesProps>;
+interface ResponseExampleProps {
+    responseExample: any;
+    mimeType: string;
+}
+export declare const ResponseExample: React.FC<ResponseExampleProps>;
+interface ExampleFromSchemaProps {
+    schema: any;
+    mimeType: string;
+}
+export declare const ExampleFromSchema: React.FC<ExampleFromSchemaProps>;
+export {};

package/lib/theme/ResponseExamples/index.js

@@ -0,0 +1,194 @@
+"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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExampleFromSchema =
+  exports.ResponseExample =
+  exports.ResponseExamples =
+  exports.json2xml =
+    void 0;
+const react_1 = __importDefault(require("react"));
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const ResponseSamples_1 = __importDefault(require("@theme/ResponseSamples"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const createResponseExample_1 = require("docusaurus-plugin-openapi-docs/lib/openapi/createResponseExample");
+const xml_formatter_1 = __importDefault(require("xml-formatter"));
+function json2xml(o, tab) {
+  const toXml = (v, name, ind) => {
+    let xml = "";
+    if (v instanceof Array) {
+      for (let i = 0, n = v.length; i < n; i++) {
+        xml += ind + toXml(v[i], name, ind + "\t") + "\n";
+      }
+    } else if (typeof v === "object") {
+      let hasChild = false;
+      xml += ind + "<" + name;
+      for (const m in v) {
+        if (m.charAt(0) === "@") {
+          xml += " " + m.substr(1) + '="' + v[m].toString() + '"';
+        } else {
+          hasChild = true;
+        }
+      }
+      xml += hasChild ? ">" : "/>";
+      if (hasChild) {
+        for (const m2 in v) {
+          if (m2 === "#text") xml += v[m2];
+          else if (m2 === "#cdata") xml += "<![CDATA[" + v[m2] + "]]>";
+          else if (m2.charAt(0) !== "@") xml += toXml(v[m2], m2, ind + "\t");
+        }
+        xml +=
+          (xml.charAt(xml.length - 1) === "\n" ? ind : "") + "</" + name + ">";
+      }
+    } else {
+      xml += ind + "<" + name + ">" + v.toString() + "</" + name + ">";
+    }
+    return xml;
+  };
+  let xml = "";
+  for (const m3 in o) xml += toXml(o[m3], m3, "");
+  return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
+}
+exports.json2xml = json2xml;
+const ResponseExamples = ({ responseExamples, mimeType }) => {
+  let language = "shell";
+  if (mimeType.endsWith("json")) language = "json";
+  if (mimeType.endsWith("xml")) language = "xml";
+  // Map response examples to an array of TabItem elements
+  const examplesArray = Object.entries(responseExamples).map(
+    ([exampleName, exampleValue]) => {
+      const isObject = typeof exampleValue.value === "object";
+      const responseExample = isObject
+        ? JSON.stringify(exampleValue.value, null, 2)
+        : exampleValue.value;
+      return (
+        // @ts-ignore
+        react_1.default.createElement(
+          TabItem_1.default,
+          { label: exampleName, value: exampleName, key: exampleName },
+          exampleValue.summary &&
+            react_1.default.createElement(
+              Markdown_1.default,
+              { className: "openapi-example__summary" },
+              exampleValue.summary
+            ),
+          react_1.default.createElement(ResponseSamples_1.default, {
+            responseExample: responseExample,
+            language: language,
+          })
+        )
+      );
+    }
+  );
+  return examplesArray;
+};
+exports.ResponseExamples = ResponseExamples;
+const ResponseExample = ({ responseExample, mimeType }) => {
+  let language = "shell";
+  if (mimeType.endsWith("json")) {
+    language = "json";
+  }
+  if (mimeType.endsWith("xml")) {
+    language = "xml";
+  }
+  const isObject = typeof responseExample === "object";
+  const exampleContent = isObject
+    ? JSON.stringify(responseExample, null, 2)
+    : responseExample;
+  return (
+    // @ts-ignore
+    react_1.default.createElement(
+      TabItem_1.default,
+      { label: "Example", value: "Example" },
+      responseExample.summary &&
+        react_1.default.createElement(
+          Markdown_1.default,
+          { className: "openapi-example__summary" },
+          responseExample.summary
+        ),
+      react_1.default.createElement(ResponseSamples_1.default, {
+        responseExample: exampleContent,
+        language: language,
+      })
+    )
+  );
+};
+exports.ResponseExample = ResponseExample;
+const ExampleFromSchema = ({ schema, mimeType }) => {
+  const responseExample = (0, createResponseExample_1.sampleResponseFromSchema)(
+    schema
+  );
+  if (mimeType.endsWith("xml")) {
+    let responseExampleObject;
+    try {
+      responseExampleObject = JSON.parse(JSON.stringify(responseExample));
+    } catch {
+      return null;
+    }
+    if (typeof responseExampleObject === "object") {
+      let xmlExample;
+      try {
+        xmlExample = (0, xml_formatter_1.default)(
+          json2xml(responseExampleObject, ""),
+          {
+            indentation: "  ",
+            lineSeparator: "\n",
+            collapseContent: true,
+          }
+        );
+      } catch {
+        const xmlExampleWithRoot = { root: responseExampleObject };
+        try {
+          xmlExample = (0, xml_formatter_1.default)(
+            json2xml(xmlExampleWithRoot, ""),
+            {
+              indentation: "  ",
+              lineSeparator: "\n",
+              collapseContent: true,
+            }
+          );
+        } catch {
+          xmlExample = json2xml(responseExampleObject, "");
+        }
+      }
+      return (
+        // @ts-ignore
+        react_1.default.createElement(
+          TabItem_1.default,
+          { label: "Example (auto)", value: "Example (auto)" },
+          react_1.default.createElement(ResponseSamples_1.default, {
+            responseExample: xmlExample,
+            language: "xml",
+          })
+        )
+      );
+    }
+  }
+  if (
+    typeof responseExample === "object" ||
+    typeof responseExample === "string"
+  ) {
+    return (
+      // @ts-ignore
+      react_1.default.createElement(
+        TabItem_1.default,
+        { label: "Example (auto)", value: "Example (auto)" },
+        react_1.default.createElement(ResponseSamples_1.default, {
+          responseExample: JSON.stringify(responseExample, null, 2),
+          language: "json",
+        })
+      )
+    );
+  }
+  return null;
+};
+exports.ExampleFromSchema = ExampleFromSchema;

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

@@ -0,0 +1,13 @@
+import React from "react";
+interface ResponseHeadersProps {
+    description?: string;
+    example?: string;
+    schema?: {
+        type?: string;
+        format?: string;
+    };
+}
+export declare const ResponseHeaders: React.FC<{
+    responseHeaders?: Record<string, ResponseHeadersProps>;
+}>;
+export default ResponseHeaders;

package/lib/theme/ResponseHeaders/index.js

@@ -0,0 +1,39 @@
+"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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseHeaders = void 0;
+const react_1 = __importDefault(require("react"));
+const SchemaItem_1 = __importDefault(require("@theme/SchemaItem"));
+const schema_1 = require("../../markdown/schema");
+const ResponseHeaders = ({ responseHeaders }) => {
+  if (!responseHeaders) {
+    return null;
+  }
+  return react_1.default.createElement(
+    "ul",
+    { style: { marginLeft: "1rem" } },
+    Object.entries(responseHeaders).map(([name, schema]) => {
+      return react_1.default.createElement(SchemaItem_1.default, {
+        name: name,
+        collapsible: false,
+        schemaName: (0, schema_1.getSchemaName)(schema),
+        qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
+        schema: schema,
+        discriminator: false,
+        children: null,
+      });
+    })
+  );
+};
+exports.ResponseHeaders = ResponseHeaders;
+exports.default = exports.ResponseHeaders;

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

@@ -0,0 +1,15 @@
+import React from "react";
+import { MediaTypeObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
+interface Props {
+    style?: React.CSSProperties;
+    title: string;
+    body: {
+        content?: {
+            [key: string]: MediaTypeObject;
+        };
+        description?: string;
+        required?: string[] | boolean;
+    };
+}
+declare const ResponseSchema: React.FC<Props>;
+export default ResponseSchema;