docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/ApiItem/Layout/index.js

@@ -0,0 +1,121 @@
+"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.default = DocItemLayout;
+const react_1 = __importDefault(require("react"));
+const client_1 = require("@docusaurus/plugin-content-docs/client");
+const theme_common_1 = require("@docusaurus/theme-common");
+const ContentVisibility_1 = __importDefault(
+  require("@theme/ContentVisibility")
+);
+const DocBreadcrumbs_1 = __importDefault(require("@theme/DocBreadcrumbs"));
+const Content_1 = __importDefault(require("@theme/DocItem/Content"));
+const Footer_1 = __importDefault(require("@theme/DocItem/Footer"));
+const Paginator_1 = __importDefault(require("@theme/DocItem/Paginator"));
+const Desktop_1 = __importDefault(require("@theme/DocItem/TOC/Desktop"));
+const Mobile_1 = __importDefault(require("@theme/DocItem/TOC/Mobile"));
+const DocVersionBadge_1 = __importDefault(require("@theme/DocVersionBadge"));
+const DocVersionBanner_1 = __importDefault(require("@theme/DocVersionBanner"));
+const clsx_1 = __importDefault(require("clsx"));
+const styles_module_css_1 = __importDefault(require("./styles.module.css"));
+/**
+ * Decide if the toc should be rendered, on mobile or desktop viewports
+ */
+function useDocTOC() {
+  const { frontMatter, toc } = (0, client_1.useDoc)();
+  const windowSize = (0, theme_common_1.useWindowSize)();
+  const hidden = frontMatter.hide_table_of_contents;
+  const canRender = !hidden && toc.length > 0;
+  const mobile = canRender
+    ? react_1.default.createElement(Mobile_1.default, null)
+    : undefined;
+  const desktop =
+    canRender && (windowSize === "desktop" || windowSize === "ssr")
+      ? react_1.default.createElement(Desktop_1.default, null)
+      : undefined;
+  return {
+    hidden,
+    mobile,
+    desktop,
+  };
+}
+function DocItemLayout({ children }) {
+  const docTOC = useDocTOC();
+  const { metadata } = (0, client_1.useDoc)();
+  const { frontMatter } = (0, client_1.useDoc)();
+  const api = frontMatter.api;
+  const schema = frontMatter.schema;
+  return react_1.default.createElement(
+    "div",
+    { className: "row" },
+    react_1.default.createElement(
+      "div",
+      {
+        className: (0, clsx_1.default)(
+          "col",
+          !docTOC.hidden && styles_module_css_1.default.docItemCol
+        ),
+      },
+      react_1.default.createElement(ContentVisibility_1.default, {
+        metadata: metadata,
+      }),
+      react_1.default.createElement(DocVersionBanner_1.default, null),
+      react_1.default.createElement(
+        "div",
+        { className: styles_module_css_1.default.docItemContainer },
+        react_1.default.createElement(
+          "article",
+          null,
+          react_1.default.createElement(DocBreadcrumbs_1.default, null),
+          react_1.default.createElement(DocVersionBadge_1.default, null),
+          docTOC.mobile,
+          react_1.default.createElement(Content_1.default, null, children),
+          react_1.default.createElement(
+            "div",
+            { className: "row" },
+            react_1.default.createElement(
+              "div",
+              {
+                className: (0, clsx_1.default)(
+                  "col",
+                  api || schema ? "col--7" : "col--12"
+                ),
+              },
+              react_1.default.createElement(Footer_1.default, null)
+            )
+          )
+        ),
+        react_1.default.createElement(
+          "div",
+          { className: "row" },
+          react_1.default.createElement(
+            "div",
+            {
+              className: (0, clsx_1.default)(
+                "col",
+                api || schema ? "col--7" : "col--12"
+              ),
+            },
+            react_1.default.createElement(Paginator_1.default, null)
+          )
+        )
+      )
+    ),
+    docTOC.desktop &&
+      react_1.default.createElement(
+        "div",
+        { className: "col col--3" },
+        docTOC.desktop
+      )
+  );
+}

package/lib/theme/ApiItem/Layout/styles.module.css

@@ -0,0 +1,17 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+.docItemContainer header + *,
+.docItemContainer article > *:first-child {
+  margin-top: 0;
+}
+
+@media (min-width: 997px) {
+  .docItemCol {
+    max-width: 75% !important;
+  }
+}

package/lib/theme/ApiItem/hooks.d.ts

@@ -0,0 +1,12 @@
+import { TypedUseSelectorHook } from "react-redux";
+import type { RootState } from "./store";
+export declare const useTypedDispatch: () => import("redux-thunk").ThunkDispatch<import("redux").CombinedState<{
+    accept: unknown;
+    contentType: unknown;
+    response: unknown;
+    server: unknown;
+    body: unknown;
+    params: unknown;
+    auth: unknown;
+}>, undefined, import("redux").AnyAction> & import("redux").Dispatch<any>;
+export declare const useTypedSelector: TypedUseSelectorHook<RootState>;

package/lib/theme/ApiItem/hooks.js

@@ -0,0 +1,13 @@
+"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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTypedSelector = exports.useTypedDispatch = void 0;
+const react_redux_1 = require("react-redux");
+const useTypedDispatch = () => (0, react_redux_1.useDispatch)();
+exports.useTypedDispatch = useTypedDispatch;
+exports.useTypedSelector = react_redux_1.useSelector;

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

@@ -0,0 +1,2 @@
+import type { Props } from "@theme/DocItem";
+export default function ApiItem(props: Props): JSX.Element;

package/lib/theme/ApiItem/index.js

@@ -0,0 +1,238 @@
+"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.default = ApiItem;
+const react_1 = __importDefault(require("react"));
+const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
+const ExecutionEnvironment_1 = __importDefault(
+  require("@docusaurus/ExecutionEnvironment")
+);
+const client_1 = require("@docusaurus/plugin-content-docs/client");
+const theme_common_1 = require("@docusaurus/theme-common");
+const useDocusaurusContext_1 = __importDefault(
+  require("@docusaurus/useDocusaurusContext")
+);
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const slice_1 = require("@theme/ApiExplorer/Authorization/slice");
+const persistanceMiddleware_1 = require("@theme/ApiExplorer/persistanceMiddleware");
+const Layout_1 = __importDefault(require("@theme/ApiItem/Layout"));
+const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
+const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
+const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
+const clsx_1 = __importDefault(require("clsx"));
+const pako_1 = require("pako");
+const react_redux_1 = require("react-redux");
+const store_1 = require("./store");
+let ApiExplorer = (_) => react_1.default.createElement("div", null);
+if (ExecutionEnvironment_1.default.canUseDOM) {
+  ApiExplorer = require("@theme/ApiExplorer").default;
+}
+function base64ToUint8Array(base64) {
+  const binary = atob(base64);
+  const len = binary.length;
+  const bytes = new Uint8Array(len);
+  for (let i = 0; i < len; i++) {
+    bytes[i] = binary.charCodeAt(i);
+  }
+  return bytes;
+}
+// @ts-ignore
+function ApiItem(props) {
+  const docHtmlClassName = `docs-doc-id-${props.content.metadata.id}`;
+  const MDXComponent = props.content;
+  const { frontMatter } = MDXComponent;
+  const { info_path: infoPath } = frontMatter;
+  let { api } = frontMatter;
+  const { schema } = frontMatter;
+  const { sample } = frontMatter;
+  // decompress and parse
+  if (api) {
+    try {
+      api = JSON.parse(
+        new TextDecoder().decode((0, pako_1.ungzip)(base64ToUint8Array(api)))
+      );
+    } catch {}
+  }
+  const { siteConfig } = (0, useDocusaurusContext_1.default)();
+  const themeConfig = siteConfig.themeConfig;
+  const options = themeConfig.api;
+  const isBrowser = (0, useIsBrowser_1.default)();
+  // Regex for 2XX status
+  const statusRegex = new RegExp("(20[0-9]|2[1-9][0-9])");
+  // Define store2
+  let store2 = {};
+  const persistanceMiddleware = (0,
+  persistanceMiddleware_1.createPersistanceMiddleware)(options);
+  // Init store for SSR
+  if (!isBrowser) {
+    store2 = (0, store_1.createStoreWithoutState)({}, [persistanceMiddleware]);
+  }
+  // Init store for CSR to hydrate components
+  if (isBrowser) {
+    // Create list of only 2XX response content types to create request samples from
+    let acceptArray = [];
+    for (const [code, content] of Object.entries(api?.responses ?? [])) {
+      if (statusRegex.test(code)) {
+        acceptArray.push(Object.keys(content.content ?? {}));
+      }
+    }
+    acceptArray = acceptArray.flat();
+    const content = api?.requestBody?.content ?? {};
+    const contentTypeArray = Object.keys(content);
+    const servers = api?.servers ?? [];
+    const params = {
+      path: [],
+      query: [],
+      header: [],
+      cookie: [],
+    };
+    api?.parameters?.forEach((param) => {
+      const paramType = param.in;
+      const paramsArray = params[paramType];
+      paramsArray.push(param);
+    });
+    const auth = (0, slice_1.createAuth)({
+      security: api?.security,
+      securitySchemes: api?.securitySchemes,
+      options,
+    });
+    // TODO: determine way to rehydrate without flashing
+    // const acceptValue = window?.sessionStorage.getItem("accept");
+    // const contentTypeValue = window?.sessionStorage.getItem("contentType");
+    const server = window?.sessionStorage.getItem("server");
+    const serverObject = JSON.parse(server) ?? {};
+    store2 = (0, store_1.createStoreWithState)(
+      {
+        accept: {
+          value: acceptArray[0],
+          options: acceptArray,
+        },
+        contentType: {
+          value: contentTypeArray[0],
+          options: contentTypeArray,
+        },
+        server: {
+          value: serverObject.url ? serverObject : undefined,
+          options: servers,
+        },
+        response: { value: undefined },
+        body: { type: "empty" },
+        params,
+        auth,
+      },
+      [persistanceMiddleware]
+    );
+  }
+  if (api) {
+    return react_1.default.createElement(
+      client_1.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(
+            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)
+              ),
+              react_1.default.createElement(
+                "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,
+                    });
+                  }
+                )
+              )
+            )
+          )
+        )
+      )
+    );
+  } else if (schema) {
+    return react_1.default.createElement(
+      client_1.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--7 openapi-left-panel__container schema" },
+              react_1.default.createElement(MDXComponent, null)
+            ),
+            react_1.default.createElement(
+              "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)
+              )
+            )
+          )
+        )
+      )
+    );
+  }
+  // Non-API docs
+  return react_1.default.createElement(
+    client_1.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: "row" },
+          react_1.default.createElement(
+            "div",
+            { className: "col col--12 markdown" },
+            react_1.default.createElement(MDXComponent, null)
+          )
+        )
+      )
+    )
+  );
+}

package/lib/theme/ApiItem/store.d.ts

@@ -0,0 +1,46 @@
+declare const rootReducer: import("redux").Reducer<import("redux").CombinedState<{
+    accept: unknown;
+    contentType: unknown;
+    response: unknown;
+    server: unknown;
+    body: unknown;
+    params: unknown;
+    auth: unknown;
+}>, any>;
+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;
+    server: unknown;
+    body: unknown;
+    params: unknown;
+    auth: unknown;
+}, any, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
+    accept: unknown;
+    contentType: unknown;
+    response: unknown;
+    server: unknown;
+    body: unknown;
+    params: unknown;
+    auth: unknown;
+}>, import("redux").AnyAction>, ...any[]]>>;
+export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
+    accept: unknown;
+    contentType: unknown;
+    response: unknown;
+    server: unknown;
+    body: unknown;
+    params: unknown;
+    auth: unknown;
+}, any, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
+    accept: unknown;
+    contentType: unknown;
+    response: unknown;
+    server: unknown;
+    body: unknown;
+    params: unknown;
+    auth: unknown;
+}>, import("redux").AnyAction>, ...any[]]>>;
+export type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
+export {};

package/lib/theme/ApiItem/store.js

@@ -0,0 +1,53 @@
+"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.createStoreWithoutState = exports.createStoreWithState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const slice_1 = __importDefault(require("@theme/ApiExplorer/Accept/slice"));
+const slice_2 = __importDefault(
+  require("@theme/ApiExplorer/Authorization/slice")
+);
+const slice_3 = __importDefault(require("@theme/ApiExplorer/Body/slice"));
+const slice_4 = __importDefault(
+  require("@theme/ApiExplorer/ContentType/slice")
+);
+const slice_5 = __importDefault(
+  require("@theme/ApiExplorer/ParamOptions/slice")
+);
+const slice_6 = __importDefault(require("@theme/ApiExplorer/Response/slice"));
+const slice_7 = __importDefault(require("@theme/ApiExplorer/Server/slice"));
+const rootReducer = (0, toolkit_1.combineReducers)({
+  accept: slice_1.default,
+  contentType: slice_4.default,
+  response: slice_6.default,
+  server: slice_7.default,
+  body: slice_3.default,
+  params: slice_5.default,
+  auth: slice_2.default,
+});
+const createStoreWithState = (preloadedState, middlewares) =>
+  (0, toolkit_1.configureStore)({
+    reducer: rootReducer,
+    preloadedState,
+    middleware: (getDefaultMiddleware) =>
+      getDefaultMiddleware().concat(...middlewares),
+  });
+exports.createStoreWithState = createStoreWithState;
+const createStoreWithoutState = (preloadedState, middlewares) =>
+  (0, toolkit_1.configureStore)({
+    reducer: rootReducer,
+    preloadedState,
+    middleware: (getDefaultMiddleware) =>
+      getDefaultMiddleware().concat(...middlewares),
+  });
+exports.createStoreWithoutState = createStoreWithoutState;

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

@@ -0,0 +1,2 @@
+import React from "react";
+export default function ApiLogo(props: any): React.JSX.Element | undefined;

package/lib/theme/ApiLogo/index.js

@@ -0,0 +1,51 @@
+"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.default = ApiLogo;
+const react_1 = __importDefault(require("react"));
+const theme_common_1 = require("@docusaurus/theme-common");
+const useBaseUrl_1 = __importDefault(require("@docusaurus/useBaseUrl"));
+const ThemedImage_1 = __importDefault(require("@theme/ThemedImage"));
+function ApiLogo(props) {
+  const { colorMode } = (0, theme_common_1.useColorMode)();
+  const { logo, darkLogo } = props;
+  const altText = () => {
+    if (colorMode === "dark") {
+      return darkLogo?.altText ?? logo?.altText;
+    }
+    return logo?.altText;
+  };
+  const lightLogoUrl = (0, useBaseUrl_1.default)(logo?.url);
+  const darkLogoUrl = (0, useBaseUrl_1.default)(darkLogo?.url);
+  if (logo && darkLogo) {
+    return react_1.default.createElement(ThemedImage_1.default, {
+      alt: altText(),
+      sources: {
+        light: lightLogoUrl,
+        dark: darkLogoUrl,
+      },
+      className: "openapi__logo",
+    });
+  }
+  if (logo || darkLogo) {
+    return react_1.default.createElement(ThemedImage_1.default, {
+      alt: altText(),
+      sources: {
+        light: lightLogoUrl ?? darkLogoUrl,
+        dark: lightLogoUrl ?? darkLogoUrl,
+      },
+      className: "openapi__logo",
+    });
+  }
+  return undefined;
+}