docusaurus-theme-openapi-docs 0.0.0-619 → 0.0.0-685

package/lib-next/theme/ApiDemoPanel/SecuritySchemes/index.js

@@ -1,274 +0,0 @@
-/* ============================================================================
- * 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 Link from "@docusaurus/Link";
-import { useTypedSelector } from "@theme/ApiItem/hooks";
-function SecuritySchemes(props) {
-  const options = useTypedSelector((state) => state.auth.options);
-  const selected = useTypedSelector((state) => state.auth.selected);
-  const infoAuthPath = `/${props.infoPath}#authentication`;
-  if (selected === undefined) return null;
-  if (options[selected]?.[0]?.type === undefined) {
-    return null;
-  }
-  const selectedAuth = options[selected];
-  return (
-    <details className={`details__demo-panel`} open={false}>
-      <summary className={`details__request-summary`}>
-        <h4>Authorization</h4>
-      </summary>
-      {selectedAuth.map((auth) => {
-        const isHttp = auth.type === "http";
-        const isApiKey = auth.type === "apiKey";
-        const isOauth2 = auth.type === "oauth2";
-        const isOpenId = auth.type === "openIdConnect";
-        if (isHttp) {
-          if (auth.scheme === "bearer") {
-            const { name, key, type, scopes, ...rest } = auth;
-            return (
-              <React.Fragment key={auth.key}>
-                <pre
-                  style={{
-                    display: "flex",
-                    flexDirection: "column",
-                    background: "var(--openapi-card-background-color)",
-                  }}
-                >
-                  <span>
-                    <strong>name:</strong>{" "}
-                    <Link to={infoAuthPath}>{name ?? key}</Link>
-                  </span>
-                  <span>
-                    <strong>type: </strong>
-                    {type}
-                  </span>
-                  {scopes && scopes.length > 0 && (
-                    <span>
-                      <strong>scopes: </strong>
-                      <code>
-                        {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                      </code>
-                    </span>
-                  )}
-                  {Object.keys(rest).map((k, i) => {
-                    return (
-                      <span key={k}>
-                        <strong>{k}: </strong>
-                        {typeof rest[k] === "object"
-                          ? JSON.stringify(rest[k], null, 2)
-                          : String(rest[k])}
-                      </span>
-                    );
-                  })}
-                </pre>
-              </React.Fragment>
-            );
-          }
-          if (auth.scheme === "basic") {
-            const { name, key, type, scopes, ...rest } = auth;
-            return (
-              <React.Fragment key={auth.key}>
-                <pre
-                  style={{
-                    display: "flex",
-                    flexDirection: "column",
-                    background: "var(--openapi-card-background-color)",
-                  }}
-                >
-                  <span>
-                    <strong>name:</strong>{" "}
-                    <Link to={infoAuthPath}>{name ?? key}</Link>
-                  </span>
-                  <span>
-                    <strong>type: </strong>
-                    {type}
-                  </span>
-                  {scopes && scopes.length > 0 && (
-                    <span>
-                      <strong>scopes: </strong>
-                      <code>
-                        {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                      </code>
-                    </span>
-                  )}
-                  {Object.keys(rest).map((k, i) => {
-                    return (
-                      <span key={k}>
-                        <strong>{k}: </strong>
-                        {typeof rest[k] === "object"
-                          ? JSON.stringify(rest[k], null, 2)
-                          : String(rest[k])}
-                      </span>
-                    );
-                  })}
-                </pre>
-              </React.Fragment>
-            );
-          }
-          return (
-            <React.Fragment key={auth.key}>
-              <pre
-                style={{
-                  display: "flex",
-                  flexDirection: "column",
-                  background: "var(--openapi-card-background-color)",
-                }}
-              >
-                <span>
-                  <strong>name:</strong>{" "}
-                  <Link to={infoAuthPath}>{auth.name ?? auth.key}</Link>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {auth.type}
-                </span>
-                <span>
-                  <strong>in: </strong>
-                  {auth.in}
-                </span>
-              </pre>
-            </React.Fragment>
-          );
-        }
-        if (isApiKey) {
-          const { name, key, type, scopes, ...rest } = auth;
-          return (
-            <React.Fragment key={auth.key}>
-              <pre
-                style={{
-                  display: "flex",
-                  flexDirection: "column",
-                  background: "var(--openapi-card-background-color)",
-                }}
-              >
-                <span>
-                  <strong>name:</strong>{" "}
-                  <Link to={infoAuthPath}>{name ?? key}</Link>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {type}
-                </span>
-                {scopes && scopes.length > 0 && (
-                  <span>
-                    <strong>scopes: </strong>
-                    <code>
-                      {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                    </code>
-                  </span>
-                )}
-                {Object.keys(rest).map((k, i) => {
-                  return (
-                    <span key={k}>
-                      <strong>{k}: </strong>
-                      {typeof rest[k] === "object"
-                        ? JSON.stringify(rest[k], null, 2)
-                        : String(rest[k])}
-                    </span>
-                  );
-                })}
-              </pre>
-            </React.Fragment>
-          );
-        }
-        if (isOauth2) {
-          const { name, key, type, scopes, flows, ...rest } = auth;
-          return (
-            <React.Fragment key={selected}>
-              <pre
-                style={{
-                  display: "flex",
-                  flexDirection: "column",
-                  background: "var(--openapi-card-background-color)",
-                }}
-              >
-                <span>
-                  <strong>name:</strong>{" "}
-                  <Link to={infoAuthPath}>{name ?? key}</Link>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {type}
-                </span>
-                {scopes && scopes.length > 0 && (
-                  <span>
-                    <strong>scopes: </strong>
-                    <code>
-                      {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                    </code>
-                  </span>
-                )}
-                {Object.keys(rest).map((k, i) => {
-                  return (
-                    <span key={k}>
-                      <strong>{k}: </strong>
-                      {typeof rest[k] === "object"
-                        ? JSON.stringify(rest[k], null, 2)
-                        : String(rest[k])}
-                    </span>
-                  );
-                })}
-                {flows && (
-                  <span>
-                    <code>
-                      <strong>flows: </strong>
-                      {JSON.stringify(flows, null, 2)}
-                    </code>
-                  </span>
-                )}
-              </pre>
-            </React.Fragment>
-          );
-        }
-        if (isOpenId) {
-          const { name, key, scopes, type, ...rest } = auth;
-          return (
-            <React.Fragment key={auth.key}>
-              <pre
-                style={{
-                  display: "flex",
-                  flexDirection: "column",
-                  background: "var(--openapi-card-background-color)",
-                }}
-              >
-                <span>
-                  <strong>name:</strong>{" "}
-                  <Link to={infoAuthPath}>{name ?? key}</Link>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {type}
-                </span>
-                {scopes && scopes.length > 0 && (
-                  <span>
-                    <strong>scopes: </strong>
-                    <code>
-                      {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                    </code>
-                  </span>
-                )}
-                {Object.keys(rest).map((k, i) => {
-                  return (
-                    <span key={k}>
-                      <strong>{k}: </strong>
-                      {typeof rest[k] === "object"
-                        ? JSON.stringify(rest[k], null, 2)
-                        : String(rest[k])}
-                    </span>
-                  );
-                })}
-              </pre>
-            </React.Fragment>
-          );
-        }
-        return undefined;
-      })}
-    </details>
-  );
-}
-export default SecuritySchemes;

package/lib-next/theme/ApiDemoPanel/Server/index.js

@@ -1,132 +0,0 @@
-/* ============================================================================
- * 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, { useState } from "react";
-import FloatingButton from "@theme/ApiDemoPanel/FloatingButton";
-import FormItem from "@theme/ApiDemoPanel/FormItem";
-import FormSelect from "@theme/ApiDemoPanel/FormSelect";
-import FormTextInput from "@theme/ApiDemoPanel/FormTextInput";
-import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
-import { setServer, setServerVariable } from "./slice";
-import styles from "./styles.module.css";
-function Server() {
-  const [isEditing, setIsEditing] = useState(false);
-  const value = useTypedSelector((state) => state.server.value);
-  const options = useTypedSelector((state) => state.server.options);
-  const dispatch = useTypedDispatch();
-  if (options.length <= 0) {
-    return null;
-  }
-  if (options.length < 1 && value?.variables === undefined) {
-    return null;
-  }
-  if (!value) {
-    const defaultOption = options[0];
-    dispatch(setServer(JSON.stringify(defaultOption)));
-  }
-
-  // Default to first option when existing server state is mismatched
-  if (value) {
-    const urlExists = options.find((s) => s.url === value.url);
-    if (!urlExists) {
-      const defaultOption = options[0];
-      dispatch(setServer(JSON.stringify(defaultOption)));
-    }
-  }
-  if (!isEditing) {
-    let url = "";
-    if (value) {
-      url = value.url.replace(/\/$/, "");
-      if (value.variables) {
-        Object.keys(value.variables).forEach((variable) => {
-          url = url.replace(
-            `{${variable}}`,
-            value.variables?.[variable].default ?? ""
-          );
-        });
-      }
-    }
-    return (
-      <FloatingButton onClick={() => setIsEditing(true)} label="Edit">
-        <FormItem label="Base URL">
-          <pre
-            style={{
-              background: "var(--openapi-card-background-color)",
-              paddingLeft: "0px",
-            }}
-          >
-            <code title={url}>{url}</code>
-          </pre>
-        </FormItem>
-      </FloatingButton>
-    );
-  }
-  return (
-    <div className={styles.optionsPanel}>
-      <FloatingButton onClick={() => setIsEditing(false)} label="Hide">
-        <FormItem label="Base URL">
-          <FormSelect
-            options={options.map((s) => s.url)}
-            onChange={(e) => {
-              dispatch(
-                setServer(
-                  JSON.stringify(
-                    options.filter((s) => s.url === e.target.value)[0]
-                  )
-                )
-              );
-            }}
-            value={value?.url}
-          />
-          <small>{value?.description}</small>
-        </FormItem>
-        {value?.variables &&
-          Object.keys(value.variables).map((key) => {
-            if (value.variables?.[key].enum !== undefined) {
-              return (
-                <FormItem label={key}>
-                  <FormSelect
-                    options={value.variables[key].enum}
-                    onChange={(e) => {
-                      dispatch(
-                        setServerVariable(
-                          JSON.stringify({
-                            key,
-                            value: e.target.value,
-                          })
-                        )
-                      );
-                    }}
-                    value={value?.variables[key].default}
-                  />
-                </FormItem>
-              );
-            }
-            return (
-              <FormItem label={key}>
-                <FormTextInput
-                  placeholder={value.variables?.[key].default}
-                  onChange={(e) => {
-                    dispatch(
-                      setServerVariable(
-                        JSON.stringify({
-                          key,
-                          value: e.target.value,
-                        })
-                      )
-                    );
-                  }}
-                  value={value?.variables?.[key].default}
-                />
-              </FormItem>
-            );
-          })}
-      </FloatingButton>
-    </div>
-  );
-}
-export default Server;

package/lib-next/theme/ApiDemoPanel/Server/styles.module.css

@@ -1,56 +0,0 @@
-.showMoreButton {
-  -webkit-appearance: none;
-  -moz-appearance: none;
-  appearance: none;
-
-  cursor: pointer;
-  font-size: var(--ifm-code-font-size);
-  /* font-weight: var(--ifm-button-font-weight); */
-  /* line-height: 1.5; */
-
-  padding: 0;
-
-  user-select: none;
-  white-space: nowrap;
-
-  border: 0px solid transparent;
-
-  display: block;
-  /* width: 100%; */
-
-  background-color: transparent;
-
-  color: var(--ifm-color-primary);
-  cursor: pointer;
-  margin-top: var(--ifm-pre-padding);
-  margin-bottom: 0;
-  text-align: left;
-  display: block;
-}
-
-.showMoreButton:hover {
-  /* text-decoration: underline; */
-  /* background-color: red; */
-  color: var(--ifm-color-primary-hover);
-}
-
-.showMoreButton:first-child {
-  margin-top: 0;
-}
-
-.optionsPanel:empty {
-  display: none;
-}
-
-.optionsPanel {
-  background: var(--openapi-card-background-color);
-  border-radius: var(--openapi-card-border-radius);
-  color: var(--ifm-pre-color);
-  line-height: var(--ifm-pre-line-height);
-  margin-bottom: var(--ifm-spacing-vertical);
-  margin-top: 0;
-  overflow: auto;
-
-  /* hack for view calculation when monaco is hidden */
-  position: relative;
-}

package/lib-next/theme/ApiDemoPanel/index.js

@@ -1,28 +0,0 @@
-/* ============================================================================
- * 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 sdk from "@paloaltonetworks/postman-collection";
-import Curl from "@theme/ApiDemoPanel/Curl";
-import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint";
-import Request from "@theme/ApiDemoPanel/Request";
-import Response from "@theme/ApiDemoPanel/Response";
-import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes";
-function ApiDemoPanel({ item, infoPath }) {
-  const postman = new sdk.Request(item.postman);
-  const { path, method } = item;
-  return (
-    <div>
-      <MethodEndpoint method={method} path={path} />
-      <SecuritySchemes infoPath={infoPath} />
-      <Request item={item} />
-      <Response />
-      <Curl postman={postman} codeSamples={item["x-code-samples"] ?? []} />
-    </div>
-  );
-}
-export default ApiDemoPanel;

package/lib-next/theme/ApiDemoPanel/storage-utils.js

@@ -1,33 +0,0 @@
-/* ============================================================================
- * 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 crypto from "crypto-js";
-export function hashArray(arr) {
-  function hash(message) {
-    return crypto.SHA1(message).toString();
-  }
-  const hashed = arr.map((item) => hash(item));
-  hashed.sort();
-  const res = hashed.join();
-  return hash(res);
-}
-export function createStorage(persistance) {
-  if (persistance === false) {
-    return {
-      getItem: () => null,
-      setItem: () => {},
-      clear: () => {},
-      key: () => null,
-      removeItem: () => {},
-      length: 0,
-    };
-  }
-  if (persistance === "sessionStorage") {
-    return sessionStorage;
-  }
-  return localStorage;
-}

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

@@ -1,68 +0,0 @@
-/* ============================================================================
- * 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 { useWindowSize } from "@docusaurus/theme-common";
-import { useDoc } from "@docusaurus/theme-common/internal";
-import DocBreadcrumbs from "@theme/DocBreadcrumbs";
-import DocItemContent from "@theme/DocItem/Content";
-import DocItemFooter from "@theme/DocItem/Footer";
-import DocItemPaginator from "@theme/DocItem/Paginator";
-import DocItemTOCDesktop from "@theme/DocItem/TOC/Desktop";
-import DocItemTOCMobile from "@theme/DocItem/TOC/Mobile";
-import DocVersionBadge from "@theme/DocVersionBadge";
-import DocVersionBanner from "@theme/DocVersionBanner";
-import clsx from "clsx";
-import styles from "./styles.module.css";
-
-/**
- * Decide if the toc should be rendered, on mobile or desktop viewports
- */
-function useDocTOC() {
-  const { frontMatter, toc } = useDoc();
-  const windowSize = useWindowSize();
-  const hidden = frontMatter.hide_table_of_contents;
-  const canRender = !hidden && toc.length > 0;
-  const mobile = canRender ? <DocItemTOCMobile /> : undefined;
-  const desktop =
-    canRender && (windowSize === "desktop" || windowSize === "ssr") ? (
-      <DocItemTOCDesktop />
-    ) : undefined;
-  return {
-    hidden,
-    mobile,
-    desktop,
-  };
-}
-export default function DocItemLayout({ children }) {
-  const docTOC = useDocTOC();
-  const {
-    frontMatter: { api },
-  } = useDoc();
-  return (
-    <div className="row">
-      <div className={clsx("col", !docTOC.hidden && styles.docItemCol)}>
-        <DocVersionBanner />
-        <div className={styles.docItemContainer}>
-          <article>
-            <DocBreadcrumbs />
-            <DocVersionBadge />
-            {docTOC.mobile}
-            <DocItemContent>{children}</DocItemContent>
-            <div className={clsx("col", api ? "col--7" : "col--12")}>
-              <DocItemFooter />
-            </div>
-          </article>
-          <div className={clsx("col", api ? "col--7" : "col--12")}>
-            <DocItemPaginator />
-          </div>
-        </div>
-      </div>
-      {docTOC.desktop && <div className="col col--3">{docTOC.desktop}</div>}
-    </div>
-  );
-}

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

@@ -1,17 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * 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-next/theme/ApiItem/hooks.js

@@ -1,10 +0,0 @@
-/* ============================================================================
- * 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 { useDispatch, useSelector } from "react-redux";
-export const useTypedDispatch = () => useDispatch();
-export const useTypedSelector = useSelector;