docusaurus-theme-openapi-docs 0.0.0-1241 → 0.0.0-1247

package/lib/theme/ApiItem/index.js

@@ -29,6 +29,7 @@ const storage_utils_1 = require("@theme/ApiExplorer/storage-utils");
 const Layout_1 = __importDefault(require("@theme/ApiItem/Layout"));
 const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
+const SchemaExpansion_1 = require("@theme/SchemaExpansion");
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const clsx_1 = __importDefault(require("clsx"));
 const pako_1 = require("pako");
@@ -157,30 +158,34 @@ function ApiItem(props) {
             react_redux_1.Provider,
             { store: store2 },
             react_1.default.createElement(
-              "div",
-              { className: (0, clsx_1.default)("row", "theme-api-markdown") },
-              react_1.default.createElement(
-                "div",
-                { className: "col col--7 openapi-left-panel__container" },
-                react_1.default.createElement(MDXComponent, null)
-              ),
+              SchemaExpansion_1.SchemaExpansionProvider,
+              null,
               react_1.default.createElement(
                 "div",
-                { className: "col col--5 openapi-right-panel__container" },
+                { className: (0, clsx_1.default)("row", "theme-api-markdown") },
+                react_1.default.createElement(
+                  "div",
+                  { className: "col col--7 openapi-left-panel__container" },
+                  react_1.default.createElement(MDXComponent, null)
+                ),
                 react_1.default.createElement(
-                  BrowserOnly_1.default,
-                  {
-                    fallback: react_1.default.createElement(
-                      SkeletonLoader_1.default,
-                      { size: "lg" }
-                    ),
-                  },
-                  () => {
-                    return react_1.default.createElement(ApiExplorer, {
-                      item: api,
-                      infoPath: infoPath,
-                    });
-                  }
+                  "div",
+                  { className: "col col--5 openapi-right-panel__container" },
+                  react_1.default.createElement(
+                    BrowserOnly_1.default,
+                    {
+                      fallback: react_1.default.createElement(
+                        SkeletonLoader_1.default,
+                        { size: "lg" }
+                      ),
+                    },
+                    () => {
+                      return react_1.default.createElement(ApiExplorer, {
+                        item: api,
+                        infoPath: infoPath,
+                      });
+                    }
+                  )
                 )
               )
             )
@@ -200,20 +205,26 @@ function ApiItem(props) {
           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--7 openapi-left-panel__container schema" },
-              react_1.default.createElement(MDXComponent, null)
-            ),
+            SchemaExpansion_1.SchemaExpansionProvider,
+            null,
             react_1.default.createElement(
               "div",
-              { className: "col col--5 openapi-right-panel__container" },
+              { className: (0, clsx_1.default)("row", "theme-api-markdown") },
+              react_1.default.createElement(
+                "div",
+                {
+                  className: "col col--7 openapi-left-panel__container schema",
+                },
+                react_1.default.createElement(MDXComponent, null)
+              ),
               react_1.default.createElement(
-                CodeBlock_1.default,
-                { language: "json", title: `${frontMatter.title}` },
-                JSON.stringify(sample, null, 2)
+                "div",
+                { className: "col col--5 openapi-right-panel__container" },
+                react_1.default.createElement(
+                  CodeBlock_1.default,
+                  { language: "json", title: `${frontMatter.title}` },
+                  JSON.stringify(sample, null, 2)
+                )
               )
             )
           )

package/lib/theme/RequestSchema/index.js

@@ -19,6 +19,7 @@ const Markdown_1 = __importDefault(require("@theme/Markdown"));
 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 SchemaExpansion_1 = __importDefault(require("@theme/SchemaExpansion"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
@@ -71,32 +72,35 @@ const RequestSchemaComponent = ({ title, body, style }) => {
                       open: true,
                       style: style,
                       summary: react_1.default.createElement(
-                        react_1.default.Fragment,
-                        null,
+                        "summary",
+                        {
+                          className:
+                            "openapi-markdown__details-summary--with-control",
+                        },
                         react_1.default.createElement(
-                          "summary",
-                          null,
-                          react_1.default.createElement(
-                            "h3",
-                            {
-                              className:
-                                "openapi-markdown__details-summary-header-body",
-                            },
-                            (0, Translate_1.translate)({
-                              id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
-                              message: title,
-                            }),
-                            body.required === true &&
-                              react_1.default.createElement(
-                                "span",
-                                { className: "openapi-schema__required" },
-                                (0, Translate_1.translate)({
-                                  id: translationIds_1.OPENAPI_SCHEMA_ITEM
-                                    .REQUIRED,
-                                  message: "required",
-                                })
-                              )
-                          )
+                          "h3",
+                          {
+                            className:
+                              "openapi-markdown__details-summary-header-body",
+                          },
+                          (0, Translate_1.translate)({
+                            id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                            message: title,
+                          }),
+                          body.required === true &&
+                            react_1.default.createElement(
+                              "span",
+                              { className: "openapi-schema__required" },
+                              (0, Translate_1.translate)({
+                                id: translationIds_1.OPENAPI_SCHEMA_ITEM
+                                  .REQUIRED,
+                                message: "required",
+                              })
+                            )
+                        ),
+                        react_1.default.createElement(
+                          SchemaExpansion_1.default,
+                          null
                         )
                       ),
                     },
@@ -179,38 +183,36 @@ const RequestSchemaComponent = ({ title, body, style }) => {
               open: true,
               style: style,
               summary: react_1.default.createElement(
-                react_1.default.Fragment,
-                null,
+                "summary",
+                {
+                  className: "openapi-markdown__details-summary--with-control",
+                },
                 react_1.default.createElement(
-                  "summary",
-                  null,
-                  react_1.default.createElement(
-                    "h3",
-                    {
-                      className:
-                        "openapi-markdown__details-summary-header-body",
-                    },
-                    (0, Translate_1.translate)({
-                      id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
-                      message: 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" },
-                        (0, Translate_1.translate)({
-                          id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
-                          message: "required",
-                        })
-                      )
-                  )
-                )
+                  "h3",
+                  {
+                    className: "openapi-markdown__details-summary-header-body",
+                  },
+                  (0, Translate_1.translate)({
+                    id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                    message: 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" },
+                      (0, Translate_1.translate)({
+                        id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                        message: "required",
+                      })
+                    )
+                ),
+                react_1.default.createElement(SchemaExpansion_1.default, null)
               ),
             },
             react_1.default.createElement(

package/lib/theme/ResponseSchema/index.js

@@ -19,6 +19,7 @@ const Markdown_1 = __importDefault(require("@theme/Markdown"));
 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 SchemaExpansion_1 = __importDefault(require("@theme/SchemaExpansion"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
@@ -83,29 +84,31 @@ const ResponseSchemaComponent = ({ title, body, style }) => {
                     open: true,
                     style: style,
                     summary: react_1.default.createElement(
-                      react_1.default.Fragment,
-                      null,
+                      "summary",
+                      {
+                        className:
+                          "openapi-markdown__details-summary--with-control",
+                      },
                       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" },
-                              (0, Translate_1.translate)({
-                                id: translationIds_1.OPENAPI_SCHEMA_ITEM
-                                  .REQUIRED,
-                                message: "required",
-                              })
-                            )
-                        )
+                        "strong",
+                        {
+                          className:
+                            "openapi-markdown__details-summary-response",
+                        },
+                        title,
+                        body.required === true &&
+                          react_1.default.createElement(
+                            "span",
+                            { className: "openapi-schema__required" },
+                            (0, Translate_1.translate)({
+                              id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                              message: "required",
+                            })
+                          )
+                      ),
+                      react_1.default.createElement(
+                        SchemaExpansion_1.default,
+                        null
                       )
                     ),
                   },

package/lib/theme/Schema/index.js

@@ -77,6 +77,7 @@ const DiscriminatorTabs_1 = __importDefault(
   require("@theme/DiscriminatorTabs")
 );
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const SchemaExpansion_1 = require("@theme/SchemaExpansion");
 const SchemaItem_1 = __importDefault(require("@theme/SchemaItem"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
@@ -644,13 +645,18 @@ const SchemaNodeDetails = ({
   schemaType,
   schemaPath,
 }) => {
+  const depth = (0, SchemaExpansion_1.useSchemaDepth)();
+  const { level } = (0, SchemaExpansion_1.useSchemaExpansion)();
+  const defaultOpen = depth < level;
   return react_1.default.createElement(
     SchemaItem_1.default,
     { collapsible: true },
     react_1.default.createElement(
       Details_1.default,
       {
+        key: `level-${level}`,
         className: "openapi-markdown__details",
+        open: defaultOpen,
         summary: react_1.default.createElement(Summary, {
           name: name,
           schemaName: schemaName,
@@ -669,11 +675,15 @@ const SchemaNodeDetails = ({
           react_1.default.createElement(MarkdownWrapper, {
             text: (0, schema_1.getQualifierMessage)(schema),
           }),
-        react_1.default.createElement(SchemaNode, {
-          schema: schema,
-          schemaType: schemaType,
-          schemaPath: schemaPath,
-        })
+        react_1.default.createElement(
+          SchemaExpansion_1.SchemaDepthProvider,
+          { depth: depth + 1 },
+          react_1.default.createElement(SchemaNode, {
+            schema: schema,
+            schemaType: schemaType,
+            schemaPath: schemaPath,
+          })
+        )
       )
     )
   );

package/lib/theme/SchemaExpansion/_SchemaExpansion.scss

@@ -0,0 +1,113 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+.openapi-schema-expansion {
+  position: relative;
+  display: inline-flex;
+  align-items: center;
+  margin-left: auto;
+}
+
+.openapi-schema-expansion__trigger {
+  appearance: none;
+  background: transparent;
+  border: none;
+  border-radius: var(--ifm-global-radius);
+  padding: 0;
+  width: 22px;
+  height: 22px;
+  flex: 0 0 22px;
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  color: var(--ifm-color-emphasis-600);
+  line-height: 0;
+  opacity: 0.7;
+  transition:
+    opacity 0.12s ease,
+    background-color 0.12s ease,
+    color 0.12s ease;
+
+  &:hover {
+    opacity: 1;
+    background-color: var(--ifm-color-emphasis-200);
+    color: var(--ifm-color-emphasis-900);
+  }
+
+  &:focus-visible {
+    outline: 2px solid var(--ifm-color-primary);
+    outline-offset: 2px;
+    opacity: 1;
+  }
+
+  &[aria-expanded="true"] {
+    opacity: 1;
+    background-color: var(--ifm-color-emphasis-200);
+    color: var(--ifm-color-emphasis-900);
+  }
+}
+
+.openapi-schema-expansion__popover {
+  position: fixed;
+  z-index: 1000;
+  display: inline-flex;
+  align-items: center;
+  gap: 2px;
+  padding: 3px;
+  background-color: var(--ifm-background-surface-color);
+  border: 1px solid var(--ifm-color-emphasis-300);
+  border-radius: var(--ifm-global-radius);
+  box-shadow: var(--ifm-global-shadow-md);
+  white-space: nowrap;
+}
+
+.openapi-schema-expansion__option {
+  appearance: none;
+  background: transparent;
+  border: none;
+  border-radius: calc(var(--ifm-global-radius) - 2px);
+  padding: 2px 8px;
+  font-size: 0.8rem;
+  line-height: 1.4;
+  color: var(--ifm-color-emphasis-800);
+  transition:
+    background-color 0.12s ease,
+    color 0.12s ease;
+
+  &:hover {
+    background-color: var(--ifm-color-emphasis-200);
+  }
+
+  &:focus-visible {
+    outline: 2px solid var(--ifm-color-primary);
+    outline-offset: 1px;
+  }
+}
+
+.openapi-schema-expansion__option--active {
+  background-color: var(--ifm-color-primary);
+  color: var(--ifm-color-white);
+
+  &:hover {
+    background-color: var(--ifm-color-primary-dark);
+  }
+}
+
+.openapi-markdown__details-summary--with-control {
+  display: flex !important;
+  align-items: center;
+  gap: 0.5rem;
+
+  > h3,
+  > strong {
+    margin-bottom: 0;
+    display: inline-flex;
+    align-items: center;
+    flex-wrap: wrap;
+    gap: 0.4rem;
+  }
+}

package/lib/theme/SchemaExpansion/context.d.ts

@@ -0,0 +1,24 @@
+import React from "react";
+export declare const SCHEMA_EXPANSION_STORAGE_KEY = "docusaurus-openapi-schema-expansion-level";
+export interface SchemaExpansionConfig {
+    enabled: boolean;
+    defaultLevel: number;
+    max: number;
+    persist: boolean;
+}
+interface SchemaExpansionContextValue {
+    config: SchemaExpansionConfig;
+    level: number;
+    setLevel: (next: number) => void;
+}
+export declare function normalizeLevel(value: number | "all" | undefined): number;
+export declare const SchemaExpansionProvider: React.FC<{
+    children: React.ReactNode;
+}>;
+export declare const SchemaDepthProvider: React.FC<{
+    depth: number;
+    children: React.ReactNode;
+}>;
+export declare function useSchemaExpansion(): SchemaExpansionContextValue;
+export declare function useSchemaDepth(): number;
+export {};

package/lib/theme/SchemaExpansion/context.js

@@ -0,0 +1,187 @@
+"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 () {
+    var ownKeys = function (o) {
+      ownKeys =
+        Object.getOwnPropertyNames ||
+        function (o) {
+          var ar = [];
+          for (var k in o)
+            if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+          return ar;
+        };
+      return ownKeys(o);
+    };
+    return function (mod) {
+      if (mod && mod.__esModule) return mod;
+      var result = {};
+      if (mod != null)
+        for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+          if (k[i] !== "default") __createBinding(result, mod, k[i]);
+      __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 });
+exports.SchemaDepthProvider =
+  exports.SchemaExpansionProvider =
+  exports.SCHEMA_EXPANSION_STORAGE_KEY =
+    void 0;
+exports.normalizeLevel = normalizeLevel;
+exports.useSchemaExpansion = useSchemaExpansion;
+exports.useSchemaDepth = useSchemaDepth;
+const react_1 = __importStar(require("react"));
+const useDocusaurusContext_1 = __importDefault(
+  require("@docusaurus/useDocusaurusContext")
+);
+exports.SCHEMA_EXPANSION_STORAGE_KEY =
+  "docusaurus-openapi-schema-expansion-level";
+const DEFAULT_CONFIG = {
+  enabled: false,
+  defaultLevel: 0,
+  max: 4,
+  persist: true,
+};
+const SchemaExpansionContext = (0, react_1.createContext)({
+  config: DEFAULT_CONFIG,
+  level: 0,
+  setLevel: () => {},
+});
+const SchemaDepthContext = (0, react_1.createContext)(0);
+function normalizeLevel(value) {
+  if (value === "all") return Infinity;
+  if (typeof value === "number" && Number.isFinite(value) && value >= 0) {
+    return Math.floor(value);
+  }
+  return 0;
+}
+function readConfig(themeConfig) {
+  const raw = themeConfig?.api?.schemaExpansion;
+  if (!raw) return DEFAULT_CONFIG;
+  const enabled = raw.enabled ?? false;
+  return {
+    enabled,
+    defaultLevel: normalizeLevel(raw.default),
+    max: typeof raw.max === "number" && raw.max > 0 ? Math.floor(raw.max) : 4,
+    // Persistence only matters when the reader can change the level via the
+    // UI control. When the control is hidden, fall back to the configured
+    // default on every visit so it isn't shadowed by a stale localStorage
+    // value from a session where the control used to be enabled.
+    persist: enabled ? (raw.persist ?? true) : false,
+  };
+}
+function readPersistedLevel() {
+  if (typeof window === "undefined") return undefined;
+  try {
+    const stored = window.localStorage.getItem(
+      exports.SCHEMA_EXPANSION_STORAGE_KEY
+    );
+    if (stored === null) return undefined;
+    if (stored === "all") return Infinity;
+    const parsed = parseInt(stored, 10);
+    return Number.isFinite(parsed) && parsed >= 0 ? parsed : undefined;
+  } catch {
+    return undefined;
+  }
+}
+function writePersistedLevel(level) {
+  if (typeof window === "undefined") return;
+  try {
+    const value = level === Infinity ? "all" : String(level);
+    window.localStorage.setItem(exports.SCHEMA_EXPANSION_STORAGE_KEY, value);
+  } catch {
+    // ignore quota / disabled storage
+  }
+}
+const SchemaExpansionProvider = ({ children }) => {
+  const { siteConfig } = (0, useDocusaurusContext_1.default)();
+  const themeConfig = siteConfig.themeConfig;
+  const config = (0, react_1.useMemo)(
+    () => readConfig(themeConfig),
+    [themeConfig]
+  );
+  const [level, setLevelState] = (0, react_1.useState)(config.defaultLevel);
+  (0, react_1.useEffect)(() => {
+    if (!config.persist) return;
+    const persisted = readPersistedLevel();
+    if (persisted !== undefined) {
+      setLevelState(persisted);
+    }
+  }, [config.persist]);
+  const setLevel = (0, react_1.useCallback)(
+    (next) => {
+      setLevelState(next);
+      if (config.persist) {
+        writePersistedLevel(next);
+      }
+    },
+    [config.persist]
+  );
+  const value = (0, react_1.useMemo)(
+    () => ({ config, level, setLevel }),
+    [config, level, setLevel]
+  );
+  return react_1.default.createElement(
+    SchemaExpansionContext.Provider,
+    { value: value },
+    children
+  );
+};
+exports.SchemaExpansionProvider = SchemaExpansionProvider;
+const SchemaDepthProvider = ({ depth, children }) =>
+  react_1.default.createElement(
+    SchemaDepthContext.Provider,
+    { value: depth },
+    children
+  );
+exports.SchemaDepthProvider = SchemaDepthProvider;
+function useSchemaExpansion() {
+  return (0, react_1.useContext)(SchemaExpansionContext);
+}
+function useSchemaDepth() {
+  return (0, react_1.useContext)(SchemaDepthContext);
+}