docusaurus-theme-openapi-docs 3.0.0-beta.1 → 3.0.0-beta.10

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

@@ -0,0 +1,23 @@
+import React from "react";
+interface Map<T> {
+    [key: string]: T;
+}
+export interface ExampleObject {
+    summary?: string;
+    description?: string;
+    value?: any;
+    externalValue?: string;
+}
+export interface Props {
+    param: {
+        description: string;
+        example: any;
+        examples: Map<ExampleObject>;
+        name: string;
+        required: boolean;
+        deprecated: boolean;
+        schema: any;
+    };
+}
+declare function ParamsItem({ param: { description, example, examples, name, required, schema, deprecated }, }: Props): React.JSX.Element;
+export default ParamsItem;

package/lib/theme/ParamsItem/index.js

@@ -1,136 +1,195 @@
+"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.
  * ========================================================================== */
-
-import React from "react";
-
-import CodeBlock from "@theme/CodeBlock";
-import SchemaTabs from "@theme/SchemaTabs";
-import TabItem from "@theme/TabItem";
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
+const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
 /* eslint-disable import/no-extraneous-dependencies*/
-import { createDescription } from "docusaurus-theme-openapi-docs/lib/markdown/createDescription";
-/* eslint-disable import/no-extraneous-dependencies*/
-import {
-  getQualifierMessage,
-  getSchemaName,
-} from "docusaurus-theme-openapi-docs/lib/markdown/schema";
-/* eslint-disable import/no-extraneous-dependencies*/
-import {
-  guard,
-  toString,
-} from "docusaurus-theme-openapi-docs/lib/markdown/utils";
-import ReactMarkdown from "react-markdown";
-import rehypeRaw from "rehype-raw";
-
+const clsx_1 = __importDefault(require("clsx"));
+const react_markdown_1 = __importDefault(require("react-markdown"));
+const rehype_raw_1 = __importDefault(require("rehype-raw"));
+const createDescription_1 = require("../../markdown/createDescription");
+const schema_1 = require("../../markdown/schema");
+const utils_1 = require("../../markdown/utils");
 function ParamsItem({
-  param: { description, example, examples, name, required, schema },
+  param: { description, example, examples, name, required, schema, deprecated },
 }) {
   if (!schema || !schema?.type) {
     schema = { type: "any" };
   }
-
-  const renderSchemaName = guard(schema, (schema) => (
-    <span className="openapi-schema__type"> {getSchemaName(schema)}</span>
-  ));
-
-  const renderSchemaRequired = guard(required, () => (
-    <span className="openapi-schema__required">required</span>
-  ));
-
-  const renderSchema = guard(getQualifierMessage(schema), (message) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(message)}
-        rehypePlugins={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderDescription = guard(description, (description) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(description)}
-        components={{
+  const renderSchemaName = (0, utils_1.guard)(schema, (schema) =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__type" },
+      " ",
+      (0, schema_1.getSchemaName)(schema)
+    )
+  );
+  const renderSchemaRequired = (0, utils_1.guard)(required, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__required" },
+      "required"
+    )
+  );
+  const renderDeprecated = (0, utils_1.guard)(deprecated, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__deprecated" },
+      "deprecated"
+    )
+  );
+  const renderSchema = (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],
+        })
+      )
+  );
+  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 <code>{children}</code>;
-            return !inline && match ? (
-              <CodeBlock className={className}>{children}</CodeBlock>
-            ) : (
-              <CodeBlock>{children}</CodeBlock>
-            );
+            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={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderDefaultValue = guard(
+        },
+        rehypePlugins: [rehype_raw_1.default],
+      })
+    )
+  );
+  const renderDefaultValue = (0, utils_1.guard)(
     schema && schema.items
       ? schema.items.default
       : schema
-      ? schema.default
-      : undefined,
-    (value) => (
-      <div>
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
+        ? schema.default
+        : undefined,
+    (value) =>
+      react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement(react_markdown_1.default, {
+          children: `**Default value:** \`${value}\``,
+        })
+      )
+  );
+  const renderExample = (0, utils_1.guard)(
+    (0, utils_1.toString)(example),
+    (example) =>
+      react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement("strong", null, "Example: "),
+        example
+      )
   );
-
-  const renderExample = guard(toString(example), (example) => (
-    <div>
-      <strong>Example: </strong>
-      {example}
-    </div>
-  ));
-
-  const renderExamples = guard(examples, (examples) => {
+  const renderExamples = (0, utils_1.guard)(examples, (examples) => {
     const exampleEntries = Object.entries(examples);
-    return (
-      <>
-        <strong>Examples:</strong>
-        <SchemaTabs>
-          {exampleEntries.map(([exampleName, exampleProperties]) => (
-            <TabItem value={exampleName} label={exampleName}>
-              {exampleProperties.summary && <p>{exampleProperties.summary}</p>}
-              {exampleProperties.description && (
-                <p>
-                  <strong>Description: </strong>
-                  <span>{exampleProperties.description}</span>
-                </p>
-              )}
-              <p>
-                <strong>Example: </strong>
-                <code>{exampleProperties.value}</code>
-              </p>
-            </TabItem>
-          ))}
-        </SchemaTabs>
-      </>
+    return react_1.default.createElement(
+      react_1.default.Fragment,
+      null,
+      react_1.default.createElement("strong", null, "Examples:"),
+      react_1.default.createElement(
+        SchemaTabs_1.default,
+        null,
+        exampleEntries.map(([exampleName, exampleProperties]) =>
+          // @ts-ignore
+          react_1.default.createElement(
+            TabItem_1.default,
+            { value: exampleName, label: exampleName },
+            exampleProperties.summary &&
+              react_1.default.createElement(
+                "p",
+                null,
+                exampleProperties.summary
+              ),
+            exampleProperties.description &&
+              react_1.default.createElement(
+                "p",
+                null,
+                react_1.default.createElement("strong", null, "Description: "),
+                react_1.default.createElement(
+                  "span",
+                  null,
+                  exampleProperties.description
+                )
+              ),
+            react_1.default.createElement(
+              "p",
+              null,
+              react_1.default.createElement("strong", null, "Example: "),
+              react_1.default.createElement(
+                "code",
+                null,
+                exampleProperties.value
+              )
+            )
+          )
+        )
+      )
     );
   });
-
-  return (
-    <div className="openapi-params__list-item">
-      <span className="openapi-schema__container">
-        <strong className="openapi-schema__property">{name}</strong>
-        {renderSchemaName}
-        {required && <span className="openapi-schema__divider"></span>}
-        {renderSchemaRequired}
-      </span>
-      {renderSchema}
-      {renderDefaultValue}
-      {renderDescription}
-      {renderExample}
-      {renderExamples}
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-params__list-item" },
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__container" },
+      react_1.default.createElement(
+        "strong",
+        {
+          className: (0, clsx_1.default)("openapi-schema__property", {
+            "openapi-schema__strikethrough": deprecated,
+          }),
+        },
+        name
+      ),
+      renderSchemaName,
+      (required || deprecated) &&
+        react_1.default.createElement("span", {
+          className: "openapi-schema__divider",
+        }),
+      renderSchemaRequired,
+      renderDeprecated
+    ),
+    renderSchema,
+    renderDefaultValue,
+    renderDescription,
+    renderExample,
+    renderExamples
   );
 }
-
-export default ParamsItem;
+exports.default = ParamsItem;

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

@@ -0,0 +1,8 @@
+import React from "react";
+import { Language } from "prism-react-renderer";
+export interface Props {
+    readonly responseExample: string;
+    readonly language: Language;
+}
+declare function ResponseSamples({ responseExample, language, }: Props): React.JSX.Element;
+export default ResponseSamples;

package/lib/theme/ResponseSamples/index.js

@@ -1,22 +1,27 @@
+"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.
  * ========================================================================== */
-
-import React from "react";
-
-import CodeBlock from "@theme/CodeBlock";
-
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 function ResponseSamples({ responseExample, language }) {
-  return (
-    <div className="openapi-code__response-samples-container">
-      <CodeBlock language={language ? language : "json"}>
-        {responseExample}
-      </CodeBlock>
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-code__response-samples-container" },
+    react_1.default.createElement(
+      CodeBlock_1.default,
+      { language: language ? language : "json" },
+      responseExample
+    )
   );
 }
-
-export default ResponseSamples;
+exports.default = ResponseSamples;

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

@@ -0,0 +1,12 @@
+import React, { ReactNode } from "react";
+export interface Props {
+    children: ReactNode;
+    collapsible: boolean;
+    name: string;
+    qualifierMessage: string | undefined;
+    required: boolean;
+    schemaName: string;
+    schema: any;
+    discriminator: boolean;
+}
+export default function SchemaItem({ children: collapsibleSchemaContent, collapsible, name, qualifierMessage, required, schemaName, schema, }: Props): React.JSX.Element;

package/lib/theme/SchemaItem/index.js

@@ -1,21 +1,23 @@
+"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.
  * ========================================================================== */
-
-import React from "react";
-
-import CodeBlock from "@theme/CodeBlock";
-/* eslint-disable import/no-extraneous-dependencies*/
-import clsx from "clsx";
-import { createDescription } from "docusaurus-theme-openapi-docs/lib/markdown/createDescription";
-/* eslint-disable import/no-extraneous-dependencies*/
-import { guard } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
-import ReactMarkdown from "react-markdown";
-import rehypeRaw from "rehype-raw";
-
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
+const clsx_1 = __importDefault(require("clsx"));
+const react_markdown_1 = __importDefault(require("react-markdown"));
+const rehype_raw_1 = __importDefault(require("rehype-raw"));
+const createDescription_1 = require("../../markdown/createDescription");
+const utils_1 = require("../../markdown/utils");
 function SchemaItem({
   children: collapsibleSchemaContent,
   collapsible,
@@ -35,89 +37,119 @@ function SchemaItem({
     defaultValue = schema.default;
     nullable = schema.nullable;
   }
-
-  const renderRequired = guard(
+  const renderRequired = (0, utils_1.guard)(
     Array.isArray(required) ? required.includes(name) : required,
-    () => <span className="openapi-schema__required">required</span>
+    () =>
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-schema__required" },
+        "required"
+      )
   );
-
-  const renderDeprecated = guard(deprecated, () => (
-    <span className="openapi-schema__deprecated">deprecated</span>
-  ));
-
-  const renderNullable = guard(nullable, () => (
-    <span className="openapi-schema__nullable">nullable</span>
-  ));
-
-  const renderSchemaDescription = guard(schemaDescription, (description) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(description)}
-        components={{
-          pre: "div",
-          code({ node, inline, className, children, ...props }) {
-            const match = /language-(\w+)/.exec(className || "");
-            if (inline) return <code>{children}</code>;
-            return !inline && match ? (
-              <CodeBlock className={className}>{children}</CodeBlock>
-            ) : (
-              <CodeBlock>{children}</CodeBlock>
-            );
+  const renderDeprecated = (0, utils_1.guard)(deprecated, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__deprecated" },
+      "deprecated"
+    )
+  );
+  const renderNullable = (0, utils_1.guard)(nullable, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__nullable" },
+      "nullable"
+    )
+  );
+  const renderSchemaDescription = (0, utils_1.guard)(
+    schemaDescription,
+    (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={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderQualifierMessage = guard(qualifierMessage, (message) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(message)}
-        rehypePlugins={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderDefaultValue = guard(
-    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
-    (value) => (
-      <div className="">
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
+          rehypePlugins: [rehype_raw_1.default],
+        })
+      )
+  );
+  const renderQualifierMessage = (0, utils_1.guard)(
+    qualifierMessage,
+    (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],
+        })
+      )
+  );
+  const renderDefaultValue = (0, utils_1.guard)(defaultValue, (value) =>
+    react_1.default.createElement(
+      "div",
+      { className: "" },
+      react_1.default.createElement(react_markdown_1.default, {
+        children: `**Default value:** \`${value}\``,
+      })
     )
   );
-
-  const schemaContent = (
-    <div>
-      <span className="openapi-schema__container">
-        <strong
-          className={clsx("openapi-schema__property", {
+  const schemaContent = react_1.default.createElement(
+    "div",
+    null,
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__container" },
+      react_1.default.createElement(
+        "strong",
+        {
+          className: (0, clsx_1.default)("openapi-schema__property", {
             "openapi-schema__strikethrough": deprecated,
-          })}
-        >
-          {name}
-        </strong>
-        <span className="openapi-schema__name"> {schemaName}</span>
-        {(nullable || required || deprecated) && (
-          <span className="openapi-schema__divider"></span>
-        )}
-        {renderNullable}
-        {!deprecated && renderRequired}
-        {renderDeprecated}
-      </span>
-      {renderQualifierMessage}
-      {renderDefaultValue}
-      {renderSchemaDescription}
-      {collapsibleSchemaContent ?? collapsibleSchemaContent}
-    </div>
+          }),
+        },
+        name
+      ),
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-schema__name" },
+        " ",
+        schemaName
+      ),
+      (nullable || required || deprecated) &&
+        react_1.default.createElement("span", {
+          className: "openapi-schema__divider",
+        }),
+      renderNullable,
+      renderRequired,
+      renderDeprecated
+    ),
+    renderQualifierMessage,
+    renderDefaultValue,
+    renderSchemaDescription,
+    collapsibleSchemaContent ?? collapsibleSchemaContent
   );
-
-  return (
-    <div className="openapi-schema__list-item">
-      {collapsible ? collapsibleSchemaContent : schemaContent}
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-schema__list-item" },
+    collapsible ? collapsibleSchemaContent : schemaContent
   );
 }
-
-export default SchemaItem;
+exports.default = SchemaItem;

package/lib/theme/SchemaTabs/_SchemaTabs.scss

@@ -5,10 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-.openapi-tabs__schema-container {
-  margin-top: 1rem;
-}
-
 .openapi-tabs__schema-item {
   display: flex;
   align-items: center;

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

@@ -0,0 +1,3 @@
+import React from "react";
+import { TabProps } from "@docusaurus/theme-common/internal";
+export default function SchemaTabs(props: TabProps): React.JSX.Element;