docusaurus-theme-openapi-docs 4.1.0 → 4.2.0

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

@@ -0,0 +1,48 @@
+import React from "react";
+export declare function json2xml(o: Record<string, any>, tab: string): string;
+interface ParameterProps {
+    in: string;
+    name: string;
+    schema?: {
+        type?: string;
+        items?: Record<string, any>;
+    };
+    enumDescriptions?: [string, string][];
+}
+interface ResponseHeaderProps {
+    description?: string;
+    example?: string;
+    schema?: {
+        type?: string;
+    };
+}
+interface ResponseExampleProps {
+    value: any;
+    summary?: string;
+}
+interface Props {
+    parameters?: ParameterProps[];
+    type: string;
+    responseHeaders?: Record<string, ResponseHeaderProps>;
+    responseExamples?: Record<string, ResponseExampleProps>;
+    responseExample?: any;
+    schema?: any;
+    mimeType: string;
+}
+export declare const ParamsDetails: React.FC<Props>;
+export declare const ResponseHeaders: React.FC<{
+    responseHeaders?: Record<string, ResponseHeaderProps>;
+}>;
+export declare const ResponseExamples: React.FC<{
+    responseExamples: any;
+    mimeType: string;
+}>;
+export declare const ResponseExample: React.FC<{
+    responseExample: any;
+    mimeType: string;
+}>;
+export declare const ExampleFromSchema: React.FC<{
+    schema: any;
+    mimeType: string;
+}>;
+export {};

package/lib/theme/ResponseExamples/index.js

@@ -0,0 +1,290 @@
+"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.ResponseHeaders =
+  exports.ParamsDetails =
+  exports.json2xml =
+    void 0;
+const react_1 = __importDefault(require("react"));
+const ParamsItem_1 = __importDefault(require("@theme/ParamsItem"));
+const ResponseSamples_1 = __importDefault(require("@theme/ResponseSamples"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const createDescription_1 = require("docusaurus-plugin-openapi-docs/lib/markdown/createDescription");
+const createResponseExample_1 = require("docusaurus-plugin-openapi-docs/lib/openapi/createResponseExample");
+const xml_formatter_1 = __importDefault(require("xml-formatter"));
+// Utility function
+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;
+// React components
+const ParamsDetails = ({ parameters, type }) => {
+  const params = parameters?.filter((param) => param?.in === type);
+  if (!params || params.length === 0) {
+    return null;
+  }
+  return react_1.default.createElement(
+    "details",
+    {
+      className: "openapi-markdown__details",
+      "data-collapsed": false,
+      open: true,
+      style: { marginBottom: "1rem" },
+    },
+    react_1.default.createElement(
+      "summary",
+      null,
+      react_1.default.createElement(
+        "h3",
+        { className: "openapi-markdown__details-summary-header-params" },
+        `${type.charAt(0).toUpperCase() + type.slice(1)} Parameters`
+      )
+    ),
+    react_1.default.createElement(
+      "div",
+      null,
+      react_1.default.createElement(
+        "ul",
+        null,
+        params.map((param, index) =>
+          react_1.default.createElement(ParamsItem_1.default, {
+            key: index,
+            className: "paramsItem",
+            // @ts-ignore
+            param: {
+              ...param,
+              enumDescriptions: Object.entries(
+                param?.schema?.items?.["x-enumDescriptions"] ?? {}
+              ),
+            },
+          })
+        )
+      )
+    )
+  );
+};
+exports.ParamsDetails = ParamsDetails;
+const ResponseHeaders = ({ responseHeaders }) => {
+  if (!responseHeaders) {
+    return null;
+  }
+  return react_1.default.createElement(
+    "ul",
+    { style: { marginLeft: "1rem" } },
+    Object.entries(responseHeaders).map(([headerName, headerObj]) => {
+      const { description, example, schema } = headerObj;
+      const type = schema?.type ?? "any";
+      return react_1.default.createElement(
+        "li",
+        { className: "schemaItem", key: headerName },
+        react_1.default.createElement(
+          "details",
+          null,
+          react_1.default.createElement(
+            "summary",
+            null,
+            react_1.default.createElement("strong", null, headerName),
+            type &&
+              react_1.default.createElement(
+                "span",
+                { style: { opacity: "0.6" } },
+                " ",
+                type
+              )
+          ),
+          react_1.default.createElement(
+            "div",
+            null,
+            description &&
+              react_1.default.createElement(
+                "div",
+                { style: { marginTop: ".5rem", marginBottom: ".5rem" } },
+                example && `Example: ${example}`,
+                (0, createDescription_1.createDescription)(description)
+              )
+          )
+        )
+      );
+    })
+  );
+};
+exports.ResponseHeaders = ResponseHeaders;
+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(
+              "div",
+              { 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(
+          "div",
+          { 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/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;

package/lib/theme/ResponseSchema/index.js

@@ -0,0 +1,206 @@
+"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 MimeTabs_1 = __importDefault(require("@theme/MimeTabs")); // Assume these components exist
+const ResponseExamples_1 = require("@theme/ResponseExamples");
+const Schema_1 = __importDefault(require("@theme/Schema"));
+const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
+const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const createDescription_1 = require("docusaurus-plugin-openapi-docs/lib/markdown/createDescription");
+const ResponseSchemaComponent = ({ title, body, style }) => {
+  if (
+    body === undefined ||
+    body.content === undefined ||
+    Object.keys(body).length === 0 ||
+    Object.keys(body.content).length === 0
+  ) {
+    return null;
+  }
+  // Get all MIME types, including vendor-specific
+  const mimeTypes = Object.keys(body.content);
+  if (mimeTypes && mimeTypes.length) {
+    return react_1.default.createElement(
+      MimeTabs_1.default,
+      { className: "openapi-tabs__mime", schemaType: "response" },
+      mimeTypes.map((mimeType) => {
+        const responseExamples = body.content[mimeType].examples;
+        const responseExample = body.content[mimeType].example;
+        const firstBody =
+          body.content[mimeType].schema ?? body.content[mimeType];
+        if (
+          firstBody === undefined &&
+          responseExample === undefined &&
+          responseExamples === undefined
+        ) {
+          return undefined;
+        }
+        if (firstBody) {
+          return (
+            // @ts-ignore
+            react_1.default.createElement(
+              TabItem_1.default,
+              { key: mimeType, label: mimeType, value: mimeType },
+              react_1.default.createElement(
+                SchemaTabs_1.default,
+                { className: "openapi-tabs__schema" },
+                react_1.default.createElement(
+                  TabItem_1.default,
+                  { key: title, label: title, value: title },
+                  react_1.default.createElement(
+                    Details_1.default,
+                    {
+                      className: "openapi-markdown__details response",
+                      "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(
+                            "strong",
+                            {
+                              className:
+                                "openapi-markdown__details-summary-response",
+                            },
+                            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" },
+                          },
+                          (0, createDescription_1.createDescription)(
+                            body.description
+                          )
+                        )
+                    ),
+                    react_1.default.createElement(
+                      "ul",
+                      { style: { marginLeft: "1rem" } },
+                      react_1.default.createElement(Schema_1.default, {
+                        schema: firstBody,
+                        schemaType: "response",
+                      })
+                    )
+                  )
+                ),
+                firstBody &&
+                  (0, ResponseExamples_1.ExampleFromSchema)({
+                    schema: firstBody,
+                    mimeType: mimeType,
+                  }),
+                responseExamples &&
+                  (0, ResponseExamples_1.ResponseExamples)({
+                    responseExamples,
+                    mimeType,
+                  }),
+                responseExample &&
+                  (0, ResponseExamples_1.ResponseExample)({
+                    responseExample,
+                    mimeType,
+                  })
+              )
+            )
+          );
+        }
+        return undefined;
+      })
+    );
+  }
+  return undefined;
+};
+const ResponseSchema = (props) => {
+  return react_1.default.createElement(
+    BrowserOnly_1.default,
+    {
+      fallback: react_1.default.createElement(SkeletonLoader_1.default, {
+        size: "md",
+      }),
+    },
+    () => {
+      const LazyComponent = react_1.default.lazy(() =>
+        Promise.resolve({ default: ResponseSchemaComponent })
+      );
+      return react_1.default.createElement(
+        react_1.Suspense,
+        { fallback: null },
+        react_1.default.createElement(LazyComponent, { ...props })
+      );
+    }
+  );
+};
+exports.default = ResponseSchema;

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

@@ -0,0 +1,8 @@
+import React from "react";
+import { SchemaObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
+interface SchemaProps {
+    schema: SchemaObject;
+    schemaType: "request" | "response";
+}
+declare const SchemaNode: React.FC<SchemaProps>;
+export default SchemaNode;