docusaurus-theme-openapi-docs 2.0.0-beta.2 → 2.0.0-beta.4

package/lib/theme/ApiDemoPanel/CodeTabs/_CodeTabs.scss

@@ -1,238 +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);
-  }
-}
-
-.language-powershell {
-  max-height: 500px;
-  overflow: auto;
-}
-
-.openapi-tabs__code-item--powershell {
-  color: var(--ifm-color-info);
-
-  &::after {
-    content: "";
-    width: 28px;
-    height: 28px;
-    background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/windows8/windows8-original.svg");
-    margin-block: auto;
-  }
-
-  &.active {
-    border-bottom-color: var(--ifm-color-success);
-    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;
-  }
-}

package/lib/theme/ApiDemoPanel/ContentType/index.js

@@ -1,32 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _react = _interopRequireDefault(require("react"));
-var _FormItem = _interopRequireDefault(require("@theme/ApiDemoPanel/FormItem"));
-var _FormSelect = _interopRequireDefault(require("@theme/ApiDemoPanel/FormSelect"));
-var _hooks = require("@theme/ApiItem/hooks");
-var _slice = require("./slice");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-function ContentType() {
-  const value = (0, _hooks.useTypedSelector)(state => state.contentType.value);
-  const options = (0, _hooks.useTypedSelector)(state => state.contentType.options);
-  const dispatch = (0, _hooks.useTypedDispatch)();
-  if (options.length <= 1) {
-    return null;
-  }
-  return <_FormItem.default label="Content-Type">
-      <_FormSelect.default value={value} options={options} onChange={e => dispatch((0, _slice.setContentType)(e.target.value))} />
-    </_FormItem.default>;
-}
-var _default = ContentType;
-exports.default = _default;

package/lib/theme/ApiDemoPanel/ContentType/slice.js

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.slice = exports.setContentType = exports.default = void 0;
-var _toolkit = require("@reduxjs/toolkit");
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-const initialState = {};
-const slice = (0, _toolkit.createSlice)({
-  name: "contentType",
-  initialState,
-  reducers: {
-    setContentType: (state, action) => {
-      state.value = action.payload;
-    }
-  }
-});
-exports.slice = slice;
-const {
-  setContentType
-} = slice.actions;
-exports.setContentType = setContentType;
-var _default = slice.reducer;
-exports.default = _default;

package/lib/theme/ApiDemoPanel/Curl/index.js

@@ -1,238 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.languageSet = exports.default = void 0;
-var _react = _interopRequireWildcard(require("react"));
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-var _postmanCodeGenerators = _interopRequireDefault(require("@paloaltonetworks/postman-code-generators"));
-var _buildPostmanRequest = _interopRequireDefault(require("@theme/ApiDemoPanel/buildPostmanRequest"));
-var _CodeTabs = _interopRequireDefault(require("@theme/ApiDemoPanel/CodeTabs"));
-var _hooks = require("@theme/ApiItem/hooks");
-var _CodeBlock = _interopRequireDefault(require("@theme/CodeBlock"));
-var _merge = _interopRequireDefault(require("lodash/merge"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-const languageSet = [{
-  highlight: "bash",
-  language: "curl",
-  logoClass: "bash",
-  options: {
-    longFormat: false,
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "cURL"
-}, {
-  highlight: "python",
-  language: "python",
-  logoClass: "python",
-  options: {
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "requests"
-}, {
-  highlight: "go",
-  language: "go",
-  logoClass: "go",
-  options: {
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "native"
-}, {
-  highlight: "javascript",
-  language: "nodejs",
-  logoClass: "nodejs",
-  options: {
-    ES6_enabled: true,
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "axios"
-}, {
-  highlight: "ruby",
-  language: "ruby",
-  logoClass: "ruby",
-  options: {
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "Net::HTTP"
-}, {
-  highlight: "csharp",
-  language: "csharp",
-  logoClass: "csharp",
-  options: {
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "RestSharp"
-}, {
-  highlight: "php",
-  language: "php",
-  logoClass: "php",
-  options: {
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "cURL"
-}, {
-  highlight: "java",
-  language: "java",
-  logoClass: "java",
-  options: {
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "OkHttp"
-}, {
-  highlight: "powershell",
-  language: "powershell",
-  logoClass: "powershell",
-  options: {
-    followRedirect: true,
-    trimRequestBody: true
-  },
-  variant: "RestMethod"
-}];
-exports.languageSet = languageSet;
-function CodeTab({
-  children,
-  hidden,
-  className,
-  onClick
-}) {
-  return <div role="tabpanel" className={className} {...{
-    hidden
-  }}>
-      {children}
-    </div>;
-}
-function Curl({
-  postman,
-  codeSamples
-}) {
-  var _ref, _siteConfig$themeConf;
-  // TODO: match theme for vscode.
-
-  const {
-    siteConfig
-  } = (0, _useDocusaurusContext.default)();
-  const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value);
-  const accept = (0, _hooks.useTypedSelector)(state => state.accept.value);
-  const server = (0, _hooks.useTypedSelector)(state => state.server.value);
-  const body = (0, _hooks.useTypedSelector)(state => state.body);
-  const pathParams = (0, _hooks.useTypedSelector)(state => state.params.path);
-  const queryParams = (0, _hooks.useTypedSelector)(state => state.params.query);
-  const cookieParams = (0, _hooks.useTypedSelector)(state => state.params.cookie);
-  const headerParams = (0, _hooks.useTypedSelector)(state => state.params.header);
-  const auth = (0, _hooks.useTypedSelector)(state => state.auth);
-
-  // User-defined languages array
-  // Can override languageSet, change order of langs, override options and variants
-  const langs = [...((_ref = siteConfig === null || siteConfig === void 0 ? void 0 : (_siteConfig$themeConf = siteConfig.themeConfig) === null || _siteConfig$themeConf === void 0 ? void 0 : _siteConfig$themeConf.languageTabs) !== null && _ref !== void 0 ? _ref : languageSet), ...codeSamples];
-
-  // Filter languageSet by user-defined langs
-  const filteredLanguageSet = languageSet.filter(ls => {
-    return langs.some(lang => {
-      return lang.language === ls.language;
-    });
-  });
-
-  // Merge user-defined langs into languageSet
-  const mergedLangs = (0, _merge.default)(filteredLanguageSet, langs);
-
-  // Read defaultLang from localStorage
-  const defaultLang = mergedLangs.filter(lang => lang.language === localStorage.getItem("docusaurus.tab.code-samples"));
-  const [language, setLanguage] = (0, _react.useState)(() => {
-    var _defaultLang$;
-    // Return first index if only 1 user-defined language exists
-    if (mergedLangs.length === 1) {
-      return mergedLangs[0];
-    }
-    // Fall back to language in localStorage or first user-defined language
-    return (_defaultLang$ = defaultLang[0]) !== null && _defaultLang$ !== void 0 ? _defaultLang$ : mergedLangs[0];
-  });
-  const [codeText, setCodeText] = (0, _react.useState)("");
-  (0, _react.useEffect)(() => {
-    if (language && !!language.options) {
-      const postmanRequest = (0, _buildPostmanRequest.default)(postman, {
-        queryParams,
-        pathParams,
-        cookieParams,
-        contentType,
-        accept,
-        headerParams,
-        body,
-        server,
-        auth
-      });
-      _postmanCodeGenerators.default.convert(language.language, language.variant, postmanRequest, language.options, (error, snippet) => {
-        if (error) {
-          return;
-        }
-        setCodeText(snippet);
-      });
-    } else if (language && !!language.source) {
-      setCodeText(language.source);
-    } else if (language && !language.options) {
-      const langSource = mergedLangs.filter(lang => lang.language === language.language);
-
-      // Merges user-defined language with default languageSet
-      // This allows users to define only the minimal properties necessary in languageTabs
-      // User-defined properties should override languageSet properties
-      const mergedLanguage = {
-        ...langSource[0],
-        ...language
-      };
-      const postmanRequest = (0, _buildPostmanRequest.default)(postman, {
-        queryParams,
-        pathParams,
-        cookieParams,
-        contentType,
-        accept,
-        headerParams,
-        body,
-        server,
-        auth
-      });
-      _postmanCodeGenerators.default.convert(mergedLanguage.language, mergedLanguage.variant, postmanRequest, mergedLanguage.options, (error, snippet) => {
-        if (error) {
-          return;
-        }
-        setCodeText(snippet);
-      });
-    } else {
-      setCodeText("");
-    }
-  }, [accept, body, contentType, cookieParams, headerParams, language, pathParams, postman, queryParams, server, auth, mergedLangs]);
-  if (language === undefined) {
-    return null;
-  }
-  return <>
-      <_CodeTabs.default groupId="code-samples" action={setLanguage}>
-        {mergedLangs.map(lang => {
-        return <CodeTab value={lang.language} label={""} key={lang.variant ? `${lang.language}-${lang.variant}` : lang.language} attributes={{
-          className: `openapi-tabs__code-item--${lang.logoClass}`
-        }}>
-              <_CodeBlock.default language={lang.highlight} className="openapi-demo__code-block" title={`${lang.language} / ${lang.variant}`}>
-                {codeText}
-              </_CodeBlock.default>
-            </CodeTab>;
-      })}
-      </_CodeTabs.default>
-    </>;
-}
-var _default = Curl;
-exports.default = _default;

package/lib/theme/ApiDemoPanel/Execute/index.js

@@ -1,155 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _react = _interopRequireDefault(require("react"));
-var _buildPostmanRequest = _interopRequireDefault(require("@theme/ApiDemoPanel/buildPostmanRequest"));
-var _slice = require("@theme/ApiDemoPanel/Response/slice");
-var _hooks = require("@theme/ApiItem/hooks");
-var _reactModal = _interopRequireDefault(require("react-modal"));
-var _makeRequest = _interopRequireDefault(require("./makeRequest"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-function validateRequest(params) {
-  for (let paramList of Object.values(params)) {
-    for (let param of paramList) {
-      if (param.required && !param.value) {
-        return false;
-      }
-    }
-  }
-  return true;
-}
-function Execute({
-  postman,
-  proxy
-}) {
-  const pathParams = (0, _hooks.useTypedSelector)(state => state.params.path);
-  const queryParams = (0, _hooks.useTypedSelector)(state => state.params.query);
-  const cookieParams = (0, _hooks.useTypedSelector)(state => state.params.cookie);
-  const headerParams = (0, _hooks.useTypedSelector)(state => state.params.header);
-  const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value);
-  const body = (0, _hooks.useTypedSelector)(state => state.body);
-  const accept = (0, _hooks.useTypedSelector)(state => state.accept.value);
-  const server = (0, _hooks.useTypedSelector)(state => state.server.value);
-  const params = (0, _hooks.useTypedSelector)(state => state.params);
-  const auth = (0, _hooks.useTypedSelector)(state => state.auth);
-  const isValidRequest = validateRequest(params);
-  const dispatch = (0, _hooks.useTypedDispatch)();
-  const postmanRequest = (0, _buildPostmanRequest.default)(postman, {
-    queryParams,
-    pathParams,
-    cookieParams,
-    contentType,
-    accept,
-    headerParams,
-    body,
-    server,
-    auth
-  });
-  const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
-  function openModal() {
-    setIsOpen(true);
-  }
-  function closeModal() {
-    setIsOpen(false);
-  }
-  function acceptAgreement() {
-    setIsOpen(false);
-    setAgreementAccepted(true);
-    sessionStorage.setItem("agreement-ack", "true");
-  }
-  const [modalIsOpen, setIsOpen] = _react.default.useState(false);
-  // Set the following as default value to persist to session and enable modal
-  // sessionStorage.getItem("agreement-ack") === "true"
-  const [agreementAccepted, setAgreementAccepted] = _react.default.useState(true);
-  const customStyles = {
-    overlay: {
-      backdropFilter: "blur(10px)",
-      backgroundColor: "transparent"
-    },
-    content: {
-      top: "50%",
-      left: "50%",
-      right: "auto",
-      bottom: "auto",
-      marginRight: "-50%",
-      border: "none",
-      padding: "none",
-      borderRadius: "var(--openapi-card-border-radius)",
-      background: "var(--ifm-card-background-color)",
-      transform: "translate(-50%, -50%)",
-      maxWidth: "550px"
-    }
-  };
-  if (agreementAccepted) {
-    return <button className="button button--sm button--secondary" disabled={!isValidRequest} style={!isValidRequest ? {
-      pointerEvents: "all"
-    } : {}} onClick={async () => {
-      dispatch((0, _slice.setResponse)("Fetching..."));
-      try {
-        await delay(1200);
-        const res = await (0, _makeRequest.default)(postmanRequest, proxy, body);
-        dispatch((0, _slice.setResponse)(await res.text()));
-        dispatch((0, _slice.setCode)(res.status));
-        res.headers && dispatch((0, _slice.setHeaders)(Object.fromEntries(res.headers)));
-      } catch (e) {
-        console.log(e);
-        dispatch((0, _slice.setResponse)("Connection failed"));
-        dispatch((0, _slice.clearCode)());
-        dispatch((0, _slice.clearHeaders)());
-      }
-    }}>
-        Send API Request
-      </button>;
-  } else {
-    return <_react.default.Fragment>
-        <button className="button button--sm button--secondary" onClick={openModal}>
-          Send API Request
-        </button>
-        <_reactModal.default isOpen={modalIsOpen} onRequestClose={closeModal} style={customStyles} contentLabel="Terms of Use">
-          <form>
-            <div className="card">
-              <div className="card__header">
-                <h2>Terms of Use</h2>
-                <hr></hr>
-              </div>
-              <div className="card__body">
-                <p>
-                  By accepting this agreement the end user acknowledges the
-                  risks of performing authenticated and non-authenticated API
-                  requests from the browser.
-                </p>
-                <p>
-                  The end user also accepts the responsibility of safeguarding
-                  API credentials and any potentially sensitive data returned by
-                  the API.
-                </p>
-                <br></br>
-              </div>
-              <div className="card__footer">
-                <div className="button-group button-group--block">
-                  <button className="button button--sm button--outline button--success" onClick={acceptAgreement}>
-                    AGREE
-                  </button>
-                  <button className="button button--sm button--outline button--danger" onClick={closeModal}>
-                    DISAGREE
-                  </button>
-                </div>
-              </div>
-            </div>
-          </form>
-        </_reactModal.default>
-      </_react.default.Fragment>;
-  }
-}
-var _default = Execute;
-exports.default = _default;