npm - docusaurus-theme-openapi-docs - Versions diffs - 2.0.0-beta.1 → 2.0.0-beta.3 - Mend

docusaurus-theme-openapi-docs 2.0.0-beta.1 → 2.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (288) hide show

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

@@ -1,328 +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 className="openapi-tabs__schema" lazy>
-          {/* @ts-ignore */}
-          <TabItem label="Default" value="default" default>
-            <LiveApp action={dispatch} language={language}>
-              {defaultBody}
-            </LiveApp>
-          </TabItem>
-          {/* @ts-ignore */}
-          <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 className="openapi-tabs__schema" lazy>
-          {/* @ts-ignore */}
-          <TabItem label="Default" value="default" default>
-            <LiveApp action={dispatch} language={language}>
-              {defaultBody}
-            </LiveApp>
-          </TabItem>
-          {examplesBodies.map((example) => {
-            return (
-              // @ts-ignore
-              <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/Body/json2xml.js DELETED Viewed

@@ -1,43 +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.
- * ========================================================================== */
-export default function json2xml(o, tab) {
-  var toXml = function (v, name, ind) {
-      var xml = "";
-      if (v instanceof Array) {
-        for (var i = 0, n = v.length; i < n; i++)
-          xml += ind + toXml(v[i], name, ind + "\t") + "\n";
-      } else if (typeof v == "object") {
-        var hasChild = false;
-        xml += ind + "<" + name;
-        for (var m in v) {
-          if (m.charAt(0) === "@")
-            xml += " " + m.substr(1) + '="' + v[m].toString() + '"';
-          else hasChild = true;
-        }
-        xml += hasChild ? ">" : "/>";
-        if (hasChild) {
-          for (var m2 in v) {
-            if (m2 === "#text") xml += v[m2];
-            else if (m2 === "#cdata") xml += "<![CDATA[" + v[m2] + "]]>";
-            else if (m2.charAt(0) !== "@") xml += toXml(v[m2], m2, ind + "\t");
-          }
-          xml +=
-            (xml.charAt(xml.length - 1) === "\n" ? ind : "") +
-            "</" +
-            name +
-            ">";
-        }
-      } else {
-        xml += ind + "<" + name + ">" + v.toString() + "</" + name + ">";
-      }
-      return xml;
-    },
-    xml = "";
-  for (var m3 in o) xml += toXml(o[m3], m3, "");
-  return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
-}

package/lib-next/theme/ApiDemoPanel/Body/slice.js DELETED Viewed

@@ -1,88 +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 { createSlice } from "@reduxjs/toolkit";
-const initialState = {};
-export const slice = createSlice({
-  name: "body",
-  initialState,
-  reducers: {
-    clearRawBody: (_state) => {
-      return {
-        type: "empty",
-      };
-    },
-    setStringRawBody: (_state, action) => {
-      return {
-        type: "raw",
-        content: {
-          type: "string",
-          value: action.payload,
-        },
-      };
-    },
-    setFileRawBody: (_state, action) => {
-      return {
-        type: "raw",
-        content: {
-          type: "file",
-          value: action.payload,
-        },
-      };
-    },
-    clearFormBodyKey: (state, action) => {
-      if (state?.type === "form") {
-        delete state.content[action.payload];
-      }
-    },
-    setStringFormBody: (state, action) => {
-      if (state?.type !== "form") {
-        return {
-          type: "form",
-          content: {
-            [action.payload.key]: {
-              type: "string",
-              value: action.payload.value,
-            },
-          },
-        };
-      }
-      state.content[action.payload.key] = {
-        type: "string",
-        value: action.payload.value,
-      };
-      return state;
-    },
-    setFileFormBody: (state, action) => {
-      if (state?.type !== "form") {
-        return {
-          type: "form",
-          content: {
-            [action.payload.key]: {
-              type: "file",
-              value: action.payload.value,
-            },
-          },
-        };
-      }
-      state.content[action.payload.key] = {
-        type: "file",
-        value: action.payload.value,
-      };
-      return state;
-    },
-  },
-});
-export const {
-  clearRawBody,
-  setStringRawBody,
-  setFileRawBody,
-  clearFormBodyKey,
-  setStringFormBody,
-  setFileFormBody,
-} = slice.actions;
-export default slice.reducer;

package/lib-next/theme/ApiDemoPanel/CodeTabs/_CodeTabs.scss DELETED Viewed

@@ -1,216 +0,0 @@
-.openapi-tabs__code-list-container {
-  display: table-row-group;
-}
-.openapi-tabs__code-item {
-  margin-top: 0 !important;
-  margin-right: 0.5rem;
-  padding-left: 1.5rem;
-  padding-right: 1.5rem;
-  padding-top: 1rem !important;
-  padding-bottom: 1rem !important;
-  &.active {
-    border-bottom-left-radius: 0;
-    border-bottom-right-radius: 0;
-  }
-}
-.openapi-tabs__code-item--python {
-  color: var(--ifm-color-success);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-success);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-python {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--go {
-  color: var(--ifm-color-info);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/go/go-original-wordmark.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-info);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-go {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--javascript {
-  color: var(--ifm-color-warning);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-warning);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-javascript {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--bash {
-  color: var(--ifm-color-danger);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/linux/linux-original.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-danger);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-bash {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--ruby {
-  color: var(--ifm-color-danger);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/ruby/ruby-plain.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-danger);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-ruby {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--csharp {
-  color: var(--ifm-color-gray-500);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/csharp/csharp-original.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-gray-500);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-csharp {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--nodejs {
-  color: var(--ifm-color-success);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-success);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-nodejs {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--php {
-  color: var(--ifm-color-gray-500);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/php/php-original.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-gray-500);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-.language-php {
-  max-height: 500px;
-  overflow: auto;
-}
-.openapi-tabs__code-item--java {
-  color: var(--ifm-color-warning);
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/java/java-original.svg");
-    margin-block: auto;
-  }
-  &.active {
-    border-bottom-color: var(--ifm-color-warning);
-    background-color: var(--ifm-color-emphasis-100);
-  }
-}
-@media only screen and (min-width: 768px) and (max-width: 996px) {
-  .openapi-tabs__code-list {
-    justify-content: space-around;
-  }
-}