docusaurus-theme-openapi-docs 0.0.0-618 → 0.0.0-684

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

@@ -1,142 +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 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 { setAuthData, setSelectedAuth } from "./slice";
-function Authorization() {
-  const data = useTypedSelector((state) => state.auth.data);
-  const options = useTypedSelector((state) => state.auth.options);
-  const selected = useTypedSelector((state) => state.auth.selected);
-  const dispatch = useTypedDispatch();
-  if (selected === undefined) {
-    return null;
-  }
-  const selectedAuth = options[selected];
-  const optionKeys = Object.keys(options);
-  return (
-    <div>
-      {optionKeys.length > 1 && (
-        <FormItem label="Security Scheme">
-          <FormSelect
-            options={optionKeys}
-            value={selected}
-            onChange={(e) => {
-              dispatch(setSelectedAuth(e.target.value));
-            }}
-          />
-        </FormItem>
-      )}
-      {selectedAuth.map((a) => {
-        if (a.type === "http" && a.scheme === "bearer") {
-          return (
-            <FormItem label="Bearer Token" key={a.key + "-bearer"}>
-              <FormTextInput
-                placeholder="Bearer Token"
-                value={data[a.key].token ?? ""}
-                onChange={(e) => {
-                  const value = e.target.value;
-                  dispatch(
-                    setAuthData({
-                      scheme: a.key,
-                      key: "token",
-                      value: value ? value : undefined,
-                    })
-                  );
-                }}
-              />
-            </FormItem>
-          );
-        }
-        if (a.type === "oauth2") {
-          return (
-            <FormItem label="Bearer Token" key={a.key + "-oauth2"}>
-              <FormTextInput
-                placeholder="Bearer Token"
-                value={data[a.key].token ?? ""}
-                onChange={(e) => {
-                  const value = e.target.value;
-                  dispatch(
-                    setAuthData({
-                      scheme: a.key,
-                      key: "token",
-                      value: value ? value : undefined,
-                    })
-                  );
-                }}
-              />
-            </FormItem>
-          );
-        }
-        if (a.type === "http" && a.scheme === "basic") {
-          return (
-            <React.Fragment key={a.key + "-basic"}>
-              <FormItem label="Username">
-                <FormTextInput
-                  placeholder="Username"
-                  value={data[a.key].username ?? ""}
-                  onChange={(e) => {
-                    const value = e.target.value;
-                    dispatch(
-                      setAuthData({
-                        scheme: a.key,
-                        key: "username",
-                        value: value ? value : undefined,
-                      })
-                    );
-                  }}
-                />
-              </FormItem>
-              <FormItem label="Password">
-                <FormTextInput
-                  placeholder="Password"
-                  password
-                  value={data[a.key].password ?? ""}
-                  onChange={(e) => {
-                    const value = e.target.value;
-                    dispatch(
-                      setAuthData({
-                        scheme: a.key,
-                        key: "password",
-                        value: value ? value : undefined,
-                      })
-                    );
-                  }}
-                />
-              </FormItem>
-            </React.Fragment>
-          );
-        }
-        if (a.type === "apiKey") {
-          return (
-            <FormItem label={`${a.key}`} key={a.key + "-apikey"}>
-              <FormTextInput
-                placeholder={`${a.key}`}
-                value={data[a.key].apiKey ?? ""}
-                onChange={(e) => {
-                  const value = e.target.value;
-                  dispatch(
-                    setAuthData({
-                      scheme: a.key,
-                      key: "apiKey",
-                      value: value ? value : undefined,
-                    })
-                  );
-                }}
-              />
-            </FormItem>
-          );
-        }
-        return null;
-      })}
-    </div>
-  );
-}
-export default Authorization;

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

@@ -1,324 +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 json2xml from "@theme/ApiDemoPanel/Body/json2xml";
-import ContentType from "@theme/ApiDemoPanel/ContentType";
-import FormFileUpload from "@theme/ApiDemoPanel/FormFileUpload";
-import FormItem from "@theme/ApiDemoPanel/FormItem";
-import FormSelect from "@theme/ApiDemoPanel/FormSelect";
-import FormTextInput from "@theme/ApiDemoPanel/FormTextInput";
-import LiveApp from "@theme/ApiDemoPanel/LiveEditor";
-import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
-import SchemaTabs from "@theme/SchemaTabs";
-import TabItem from "@theme/TabItem";
-import format from "xml-formatter";
-import {
-  clearFormBodyKey,
-  clearRawBody,
-  setFileFormBody,
-  setFileRawBody,
-  setStringFormBody,
-} from "./slice";
-function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample }) {
-  const contentType = useTypedSelector((state) => state.contentType.value);
-
-  // NOTE: We used to check if body was required, but opted to always show the request body
-  // to reduce confusion, see: https://github.com/cloud-annotations/docusaurus-openapi/issues/145
-
-  // No body
-  if (contentType === undefined) {
-    return null;
-  }
-  return (
-    <>
-      <ContentType />
-      <Body
-        requestBodyMetadata={requestBodyMetadata}
-        jsonRequestBodyExample={jsonRequestBodyExample}
-      />
-    </>
-  );
-}
-function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
-  const contentType = useTypedSelector((state) => state.contentType.value);
-  const required = requestBodyMetadata?.required;
-  const dispatch = useTypedDispatch();
-
-  // Lot's of possible content-types:
-  // - application/json
-  // - application/xml
-  // - text/plain
-  // - text/css
-  // - text/html
-  // - text/javascript
-  // - application/javascript
-  // - multipart/form-data
-  // - application/x-www-form-urlencoded
-  // - image/svg+xml;charset=US-ASCII
-
-  // Show editor:
-  // - application/json
-  // - application/xml
-  // - */*
-
-  // Show form:
-  // - multipart/form-data
-  // - application/x-www-form-urlencoded
-
-  const schema = requestBodyMetadata?.content?.[contentType]?.schema;
-  const example = requestBodyMetadata?.content?.[contentType]?.example;
-  const examples = requestBodyMetadata?.content?.[contentType]?.examples;
-  if (schema?.format === "binary") {
-    return (
-      <FormItem label="Body" required={required}>
-        <FormFileUpload
-          placeholder={schema.description || "Body"}
-          onChange={(file) => {
-            if (file === undefined) {
-              dispatch(clearRawBody());
-              return;
-            }
-            dispatch(
-              setFileRawBody({
-                src: `/path/to/${file.name}`,
-                content: file,
-              })
-            );
-          }}
-        />
-      </FormItem>
-    );
-  }
-  if (
-    (contentType === "multipart/form-data" ||
-      contentType === "application/x-www-form-urlencoded") &&
-    schema?.type === "object"
-  ) {
-    return (
-      <FormItem label="Body" required={required}>
-        <div
-          style={{
-            marginTop: "calc(var(--ifm-pre-padding) / 2)",
-            borderRadius: "4px",
-            padding: "var(--ifm-pre-padding)",
-            border: "1px solid var(--openapi-monaco-border-color)",
-          }}
-        >
-          {Object.entries(schema.properties ?? {}).map(([key, val]) => {
-            if (val.format === "binary") {
-              return (
-                <FormItem
-                  key={key}
-                  label={key}
-                  required={
-                    Array.isArray(schema.required) &&
-                    schema.required.includes(key)
-                  }
-                >
-                  <FormFileUpload
-                    placeholder={val.description || key}
-                    onChange={(file) => {
-                      if (file === undefined) {
-                        dispatch(clearFormBodyKey(key));
-                        return;
-                      }
-                      dispatch(
-                        setFileFormBody({
-                          key: key,
-                          value: {
-                            src: `/path/to/${file.name}`,
-                            content: file,
-                          },
-                        })
-                      );
-                    }}
-                  />
-                </FormItem>
-              );
-            }
-            if (val.enum) {
-              return (
-                <FormItem
-                  key={key}
-                  label={key}
-                  required={
-                    Array.isArray(schema.required) &&
-                    schema.required.includes(key)
-                  }
-                >
-                  <FormSelect
-                    options={["---", ...val.enum]}
-                    onChange={(e) => {
-                      const val = e.target.value;
-                      if (val === "---") {
-                        dispatch(clearFormBodyKey(key));
-                      } else {
-                        dispatch(
-                          setStringFormBody({
-                            key: key,
-                            value: val,
-                          })
-                        );
-                      }
-                    }}
-                  />
-                </FormItem>
-              );
-            }
-            // TODO: support all the other types.
-            return (
-              <FormItem
-                key={key}
-                label={key}
-                required={
-                  Array.isArray(schema.required) &&
-                  schema.required.includes(key)
-                }
-              >
-                <FormTextInput
-                  placeholder={val.description || key}
-                  onChange={(e) => {
-                    dispatch(
-                      setStringFormBody({
-                        key: key,
-                        value: e.target.value,
-                      })
-                    );
-                  }}
-                />
-              </FormItem>
-            );
-          })}
-        </div>
-      </FormItem>
-    );
-  }
-  let language = "plaintext";
-  let defaultBody = ""; //"body content";
-  let exampleBody;
-  let examplesBodies = [];
-  if (contentType === "application/json" || contentType.endsWith("+json")) {
-    if (jsonRequestBodyExample) {
-      defaultBody = JSON.stringify(jsonRequestBodyExample, null, 2);
-    }
-    if (example) {
-      exampleBody = JSON.stringify(example, null, 2);
-    }
-    if (examples) {
-      for (const [key, example] of Object.entries(examples)) {
-        examplesBodies.push({
-          label: key,
-          body: JSON.stringify(example.value, null, 2),
-          summary: example.summary,
-        });
-      }
-    }
-    language = "json";
-  }
-  if (contentType === "application/xml" || contentType.endsWith("+xml")) {
-    if (jsonRequestBodyExample) {
-      try {
-        defaultBody = format(json2xml(jsonRequestBodyExample, ""), {
-          indentation: "  ",
-          lineSeparator: "\n",
-          collapseContent: true,
-        });
-      } catch {
-        defaultBody = json2xml(jsonRequestBodyExample);
-      }
-    }
-    if (example) {
-      try {
-        exampleBody = format(json2xml(example, ""), {
-          indentation: "  ",
-          lineSeparator: "\n",
-          collapseContent: true,
-        });
-      } catch {
-        exampleBody = json2xml(example);
-      }
-    }
-    if (examples) {
-      for (const [key, example] of Object.entries(examples)) {
-        let formattedXmlBody;
-        try {
-          formattedXmlBody = format(example.value, {
-            indentation: "  ",
-            lineSeparator: "\n",
-            collapseContent: true,
-          });
-        } catch {
-          formattedXmlBody = example.value;
-        }
-        examplesBodies.push({
-          label: key,
-          body: formattedXmlBody,
-          summary: example.summary,
-        });
-      }
-    }
-    language = "xml";
-  }
-  if (exampleBody) {
-    return (
-      <FormItem label="Body" required={required}>
-        <SchemaTabs lazy>
-          <TabItem label="Default" value="default" default>
-            <LiveApp action={dispatch} language={language}>
-              {defaultBody}
-            </LiveApp>
-          </TabItem>
-          <TabItem label="Example" value="example">
-            {exampleBody && (
-              <LiveApp action={dispatch} language={language}>
-                {exampleBody}
-              </LiveApp>
-            )}
-          </TabItem>
-        </SchemaTabs>
-      </FormItem>
-    );
-  }
-  if (examplesBodies && examplesBodies.length > 0) {
-    return (
-      <FormItem label="Body" required={required}>
-        <SchemaTabs lazy>
-          <TabItem label="Default" value="default" default>
-            <LiveApp action={dispatch} language={language}>
-              {defaultBody}
-            </LiveApp>
-          </TabItem>
-          {examplesBodies.map((example) => {
-            return (
-              <TabItem
-                label={example.label}
-                value={example.label}
-                key={example.label}
-              >
-                {example.summary && <p>{example.summary}</p>}
-                {example.body && (
-                  <LiveApp action={dispatch} language={language}>
-                    {example.body}
-                  </LiveApp>
-                )}
-              </TabItem>
-            );
-          })}
-        </SchemaTabs>
-      </FormItem>
-    );
-  }
-  return (
-    <FormItem label="Body" required={required}>
-      <LiveApp action={dispatch} language={language}>
-        {defaultBody}
-      </LiveApp>
-    </FormItem>
-  );
-}
-export default BodyWrap;

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

@@ -1,201 +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, cloneElement, isValidElement } from "react";
-import { duplicates } from "@docusaurus/theme-common";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import { languageSet } from "@theme/ApiDemoPanel/Curl";
-import clsx from "clsx";
-import styles from "./styles.module.css";
-const {
-  useScrollPositionBlocker,
-  useTabGroupChoice,
-} = require("@docusaurus/theme-common/internal");
-
-// A very rough duck type, but good enough to guard against mistakes while
-// allowing customization
-function isTabItem(comp) {
-  return "value" in comp.props;
-}
-function TabsComponent(props) {
-  const {
-    lazy,
-    block,
-    defaultValue: defaultValueProp,
-    values: valuesProp,
-    groupId,
-    className,
-    action,
-  } = props;
-  const children = React.Children.map(props.children, (child) => {
-    if (isValidElement(child) && isTabItem(child)) {
-      return child;
-    }
-    // child.type.name will give non-sensical values in prod because of
-    // minification, but we assume it won't throw in prod.
-    throw new Error(
-      `Docusaurus error: Bad <Tabs> child <${
-        // @ts-expect-error: guarding against unexpected cases
-        typeof child.type === "string" ? child.type : child.type.name
-      }>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`
-    );
-  });
-  const values =
-    valuesProp ??
-    // Only pick keys that we recognize. MDX would inject some keys by default
-    children.map(({ props: { value, label, attributes } }) => ({
-      value,
-      label,
-      attributes,
-    }));
-  const dup = duplicates(values, (a, b) => a.value === b.value);
-  if (dup.length > 0) {
-    throw new Error(
-      `Docusaurus error: Duplicate values "${dup
-        .map((a) => a.value)
-        .join(", ")}" found in <Tabs>. Every value needs to be unique.`
-    );
-  }
-  // When defaultValueProp is null, don't show a default tab
-  const defaultValue =
-    defaultValueProp === null
-      ? defaultValueProp
-      : defaultValueProp ??
-        children.find((child) => child.props.default)?.props.value ??
-        children[0].props.value;
-  if (defaultValue !== null && !values.some((a) => a.value === defaultValue)) {
-    throw new Error(
-      `Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values
-        .map((a) => a.value)
-        .join(
-          ", "
-        )}. If you intend to show no default tab, use defaultValue={null} instead.`
-    );
-  }
-  const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoice();
-  const [selectedValue, setSelectedValue] = useState(defaultValue);
-  const tabRefs = [];
-  const { blockElementScrollPositionUntilNextRender } =
-    useScrollPositionBlocker();
-  if (groupId != null) {
-    const relevantTabGroupChoice = tabGroupChoices[groupId];
-    if (
-      relevantTabGroupChoice != null &&
-      relevantTabGroupChoice !== selectedValue &&
-      values.some((value) => value.value === relevantTabGroupChoice)
-    ) {
-      setSelectedValue(relevantTabGroupChoice);
-    }
-  }
-  const handleTabChange = (event) => {
-    const newTab = event.currentTarget;
-    const newTabIndex = tabRefs.indexOf(newTab);
-    const newTabValue = values[newTabIndex].value;
-    if (newTabValue !== selectedValue) {
-      blockElementScrollPositionUntilNextRender(newTab);
-      setSelectedValue(newTabValue);
-      if (action) {
-        const newLanguage = languageSet.filter(
-          (lang) => lang.language === newTabValue
-        );
-        action(newLanguage[0]);
-      }
-      if (groupId != null) {
-        setTabGroupChoices(groupId, String(newTabValue));
-      }
-    }
-  };
-  const handleKeydown = (event) => {
-    let focusElement = null;
-    switch (event.key) {
-      case "ArrowRight": {
-        const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
-        focusElement = tabRefs[nextTab] ?? tabRefs[0];
-        break;
-      }
-      case "ArrowLeft": {
-        const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
-        break;
-      }
-      default:
-        break;
-    }
-    focusElement?.focus();
-  };
-  return (
-    <div className={clsx("tabs-container", styles.tabList)}>
-      <ul
-        role="tablist"
-        aria-orientation="horizontal"
-        className={clsx(
-          "tabs",
-          {
-            "tabs--block": block,
-          },
-          styles.code__tabs,
-          className
-        )}
-      >
-        {values.map(({ value, label, attributes }) => (
-          <li
-            role="tab"
-            tabIndex={selectedValue === value ? 0 : -1}
-            aria-selected={selectedValue === value}
-            key={value}
-            ref={(tabControl) => tabRefs.push(tabControl)}
-            onKeyDown={handleKeydown}
-            onFocus={handleTabChange}
-            onClick={handleTabChange}
-            {...attributes}
-            className={clsx(
-              "tabs__item",
-              styles.tabItem,
-              attributes?.className,
-              {
-                "tabs__item--active": selectedValue === value,
-              }
-            )}
-          >
-            {label ?? value}
-          </li>
-        ))}
-      </ul>
-
-      {lazy ? (
-        cloneElement(
-          children.filter(
-            (tabItem) => tabItem.props.value === selectedValue
-          )[0],
-          {
-            className: "margin-top--md",
-          }
-        )
-      ) : (
-        <div className="margin-top--md">
-          {children.map((tabItem, i) =>
-            cloneElement(tabItem, {
-              key: i,
-              hidden: tabItem.props.value !== selectedValue,
-            })
-          )}
-        </div>
-      )}
-    </div>
-  );
-}
-export default function CodeTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <TabsComponent
-      // Remount tabs after hydration
-      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
-      key={String(isBrowser)}
-      {...props}
-    />
-  );
-}

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

@@ -1,17 +0,0 @@
-.tabList {
-  margin-bottom: var(--ifm-leading);
-}
-
-.tabItem {
-  margin-top: 0 !important;
-}
-
-.code__tabs {
-  display: table-row-group;
-}
-
-@media only screen and (min-width: 768px) and (max-width: 996px) {
-  .code__tabs {
-    justify-content: space-around;
-  }
-}