docusaurus-theme-openapi-docs 0.0.0-348 → 0.0.0-351

package/lib/theme/ApiDemoPanel/index.js

@@ -0,0 +1,132 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
+
+var _postmanCollection = _interopRequireDefault(require("@paloaltonetworks/postman-collection"));
+
+var _reactRedux = require("react-redux");
+
+var _Accept = _interopRequireDefault(require("./Accept"));
+
+var _slice = require("./Authorization/slice");
+
+var _Body = _interopRequireDefault(require("./Body"));
+
+var _Curl = _interopRequireDefault(require("./Curl"));
+
+var _MethodEndpoint = _interopRequireDefault(require("./MethodEndpoint"));
+
+var _ParamOptions = _interopRequireDefault(require("./ParamOptions"));
+
+var _persistanceMiddleware = require("./persistanceMiddleware");
+
+var _Response = _interopRequireDefault(require("./Response"));
+
+var _SecuritySchemes = _interopRequireDefault(require("./SecuritySchemes"));
+
+var _Server = _interopRequireDefault(require("./Server"));
+
+var _store = require("./store");
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
+
+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 ApiDemoPanel({
+  item
+}) {
+  var _item$responses, _item$requestBody$con, _item$requestBody, _item$servers, _item$parameters, _xCodeSamples;
+
+  const {
+    siteConfig
+  } = (0, _useDocusaurusContext.default)();
+  const themeConfig = siteConfig.themeConfig;
+  const options = themeConfig.api;
+  const postman = new _postmanCollection.default.Request(item.postman);
+  const acceptArray = Array.from(new Set(Object.values((_item$responses = item.responses) !== null && _item$responses !== void 0 ? _item$responses : {}).map(response => {
+    var _response$content;
+
+    return Object.keys((_response$content = response.content) !== null && _response$content !== void 0 ? _response$content : {});
+  }).flat()));
+  const content = (_item$requestBody$con = (_item$requestBody = item.requestBody) === null || _item$requestBody === void 0 ? void 0 : _item$requestBody.content) !== null && _item$requestBody$con !== void 0 ? _item$requestBody$con : {};
+  const contentTypeArray = Object.keys(content);
+  const servers = (_item$servers = item.servers) !== null && _item$servers !== void 0 ? _item$servers : [];
+  const params = {
+    path: [],
+    query: [],
+    header: [],
+    cookie: []
+  };
+  (_item$parameters = item.parameters) === null || _item$parameters === void 0 ? void 0 : _item$parameters.forEach(param => {
+    const paramType = param.in;
+    const paramsArray = params[paramType];
+    paramsArray.push(param);
+  });
+  const auth = (0, _slice.createAuth)({
+    security: item.security,
+    securitySchemes: item.securitySchemes,
+    options
+  });
+  const persistanceMiddleware = (0, _persistanceMiddleware.createPersistanceMiddleware)(options);
+  const store2 = (0, _store.createStoreWithState)({
+    accept: {
+      value: acceptArray[0],
+      options: acceptArray
+    },
+    contentType: {
+      value: contentTypeArray[0],
+      options: contentTypeArray
+    },
+    server: {
+      value: servers[0],
+      options: servers
+    },
+    response: {
+      value: undefined
+    },
+    body: {
+      type: "empty"
+    },
+    params,
+    auth
+  }, [persistanceMiddleware]);
+  const {
+    path,
+    method
+  } = item;
+  return <_reactRedux.Provider store={store2}>
+      <div className={_stylesModule.default.apiDemoPanelContainer}>
+        <_MethodEndpoint.default method={method} path={path} />
+
+        <_SecuritySchemes.default />
+
+        <div className={_stylesModule.default.optionsPanel}>
+          <_ParamOptions.default />
+          <_Body.default jsonRequestBodyExample={item.jsonRequestBodyExample} requestBodyMetadata={item.requestBody} />
+          <_Accept.default />
+        </div>
+
+        <_Server.default />
+
+        <_Curl.default postman={postman} codeSamples={(_xCodeSamples = item["x-code-samples"]) !== null && _xCodeSamples !== void 0 ? _xCodeSamples : []} />
+
+        <_Response.default />
+      </div>
+    </_reactRedux.Provider>;
+}
+
+var _default = ApiDemoPanel;
+exports.default = _default;

package/lib/theme/ApiDemoPanel/persistanceMiddleware.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createPersistanceMiddleware = createPersistanceMiddleware;
+
+var _slice = require("./Authorization/slice");
+
+var _storageUtils = require("./storage-utils");
+
+/* ============================================================================
+ * 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 createPersistanceMiddleware(options) {
+  const persistanceMiddleware = storeAPI => next => action => {
+    const result = next(action);
+    const state = storeAPI.getState();
+    const storage = (0, _storageUtils.createStorage)(options === null || options === void 0 ? void 0 : options.authPersistance);
+
+    if (action.type === _slice.setAuthData.type) {
+      for (const [key, value] of Object.entries(state.auth.data)) {
+        if (Object.values(value).filter(Boolean).length > 0) {
+          storage.setItem(key, JSON.stringify(value));
+        } else {
+          storage.removeItem(key);
+        }
+      }
+    }
+
+    if (action.type === _slice.setSelectedAuth.type) {
+      if (state.auth.selected) {
+        storage.setItem((0, _storageUtils.hashArray)(Object.keys(state.auth.options)), state.auth.selected);
+      }
+    }
+
+    return result;
+  };
+
+  return persistanceMiddleware;
+}

package/lib/theme/ApiDemoPanel/postman-collection.d.ts

@@ -0,0 +1,10 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+declare module "@paloaltonetworks/postman-collection" {
+  export = Request.sdk;
+}

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

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createStorage = createStorage;
+exports.hashArray = hashArray;
+
+var _cryptoJs = _interopRequireDefault(require("crypto-js"));
+
+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 hashArray(arr) {
+  function hash(message) {
+    return _cryptoJs.default.SHA1(message).toString();
+  }
+
+  const hashed = arr.map(item => hash(item));
+  hashed.sort();
+  const res = hashed.join();
+  return hash(res);
+}
+
+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/theme/ApiDemoPanel/store.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createStoreWithState = void 0;
+
+var _toolkit = require("@reduxjs/toolkit");
+
+var _slice = _interopRequireDefault(require("./Accept/slice"));
+
+var _slice2 = _interopRequireDefault(require("./Authorization/slice"));
+
+var _slice3 = _interopRequireDefault(require("./Body/slice"));
+
+var _slice4 = _interopRequireDefault(require("./ContentType/slice"));
+
+var _slice5 = _interopRequireDefault(require("./ParamOptions/slice"));
+
+var _slice6 = _interopRequireDefault(require("./Response/slice"));
+
+var _slice7 = _interopRequireDefault(require("./Server/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.
+ * ========================================================================== */
+const rootReducer = (0, _toolkit.combineReducers)({
+  accept: _slice.default,
+  contentType: _slice4.default,
+  response: _slice6.default,
+  server: _slice7.default,
+  body: _slice3.default,
+  params: _slice5.default,
+  auth: _slice2.default
+});
+
+const createStoreWithState = (preloadedState, middlewares) => (0, _toolkit.configureStore)({
+  reducer: rootReducer,
+  preloadedState,
+  middleware: getDefaultMiddleware => getDefaultMiddleware().concat(...middlewares)
+});
+
+exports.createStoreWithState = createStoreWithState;

package/lib/theme/ApiDemoPanel/styles.module.css

@@ -0,0 +1,44 @@
+:root {
+  /* VS Dark mode */
+  --openapi-monaco-background-color-dark: var(--ifm-color-gray-900);
+  --openapi-code-bright-dark: var(--ifm-color-secondary-lighter);
+  --openapi-code-dim-dark: var(--ifm-color-secondary-dark);
+  --openapi-code-blue-dark: var(--ifm-color-primary);
+  --openapi-code-green-dark: var(--ifm-color-success);
+  --openapi-code-select-dark: var(--ifm-color-secondary-lightest);
+
+  /* VS Light mode */
+  --openapi-monaco-background-color-light: var(--ifm-color-gray-100);
+  --openapi-code-bright-light: var(--ifm-color-black);
+  --openapi-code-dim-light: var(--ifm-color-black);
+  --openapi-code-blue-light: var(--ifm-color-primary);
+  --openapi-code-green-light: var(--ifm-color-success);
+  --openapi-code-select-light: var(--ifm-color-secondary-light);
+
+  --openapi-card-background-color: var(--ifm-color-gray-100);
+  --openapi-card-border-radius: var(--ifm-pre-border-radius);
+  --openapi-monaco-border-color: var(--openapi-card-background-color);
+  --openapi-input-border: var(--ifm-color-primary);
+}
+
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+}
+
+.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;
+  padding: var(--ifm-pre-padding);
+
+  /* hack for view calculation when monaco is hidden */
+  position: relative;
+}

package/lib/theme/ApiItem/index.js

@@ -0,0 +1,160 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = DocItem;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _ExecutionEnvironment = _interopRequireDefault(require("@docusaurus/ExecutionEnvironment"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _DocBreadcrumbs = _interopRequireDefault(require("@theme/DocBreadcrumbs"));
+
+var _DocItemFooter = _interopRequireDefault(require("@theme/DocItemFooter"));
+
+var _DocPaginator = _interopRequireDefault(require("@theme/DocPaginator"));
+
+var _DocVersionBadge = _interopRequireDefault(require("@theme/DocVersionBadge"));
+
+var _DocVersionBanner = _interopRequireDefault(require("@theme/DocVersionBanner"));
+
+var _Heading = _interopRequireDefault(require("@theme/Heading"));
+
+var _MDXContent = _interopRequireDefault(require("@theme/MDXContent"));
+
+var _TOC = _interopRequireDefault(require("@theme/TOC"));
+
+var _TOCCollapsible = _interopRequireDefault(require("@theme/TOCCollapsible"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
+
+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.
+ * ========================================================================== */
+let ApiDemoPanel = _ => <div style={{
+  marginTop: "3.5em"
+}} />;
+
+if (_ExecutionEnvironment.default.canUseDOM) {
+  ApiDemoPanel = require("@theme/ApiDemoPanel").default;
+}
+
+function DocItemMetadata(props) {
+  var _assets$image;
+
+  const {
+    content: DocContent
+  } = props;
+  const {
+    metadata,
+    frontMatter,
+    assets
+  } = DocContent;
+  const {
+    keywords
+  } = frontMatter;
+  const {
+    description,
+    title
+  } = metadata;
+  const image = (_assets$image = assets.image) !== null && _assets$image !== void 0 ? _assets$image : frontMatter.image;
+  return <_themeCommon.PageMetadata {...{
+    title,
+    description,
+    keywords,
+    image
+  }} />;
+}
+
+function DocItemContent(props) {
+  const {
+    content: DocContent
+  } = props;
+  const {
+    metadata,
+    frontMatter
+  } = DocContent;
+  const {
+    hide_title: hideTitle,
+    hide_table_of_contents: hideTableOfContents,
+    toc_min_heading_level: tocMinHeadingLevel,
+    toc_max_heading_level: tocMaxHeadingLevel
+  } = frontMatter;
+  const {
+    title
+  } = metadata;
+  const {
+    api
+  } = frontMatter; // We only add a title if:
+  // - user doesn't ask to hide it with front matter
+  // - the markdown content does not already contain a top-level h1 heading
+
+  const shouldAddTitle = !hideTitle && typeof DocContent.contentTitle === "undefined";
+  const windowSize = (0, _themeCommon.useWindowSize)();
+  const canRenderTOC = !hideTableOfContents && DocContent.toc && DocContent.toc.length > 0;
+  const renderTocDesktop = canRenderTOC && (windowSize === "desktop" || windowSize === "ssr");
+  return <div className="row">
+      <div className={(0, _clsx.default)("col", !hideTableOfContents && _stylesModule.default.docItemCol)}>
+        <_DocVersionBanner.default />
+        <div className={_stylesModule.default.docItemContainer}>
+          <article>
+            <_DocBreadcrumbs.default />
+            <_DocVersionBadge.default />
+
+            {canRenderTOC && <_TOCCollapsible.default toc={DocContent.toc} minHeadingLevel={tocMinHeadingLevel} maxHeadingLevel={tocMaxHeadingLevel} className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docTocMobile, _stylesModule.default.tocMobile)} />}
+
+            <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docMarkdown, "theme-api-markdown", "markdown")}>
+              {
+              /*
+               Title can be declared inside md content or declared through
+               front matter and added manually. To make both cases consistent,
+               the added title is added under the same div.markdown block
+               See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
+               */
+            }
+              {shouldAddTitle && <header>
+                  <_Heading.default as="h1">{title}</_Heading.default>
+                </header>}
+              <_MDXContent.default>
+                <div className="row">
+                  <div className={(0, _clsx.default)("col", api ? "col--7" : "col--12")}>
+                    <DocContent />
+                  </div>
+                  {api && <div className="col col--5">
+                      <ApiDemoPanel item={api} />
+                    </div>}
+                </div>
+              </_MDXContent.default>
+            </div>
+            <div className={(0, _clsx.default)("col", api ? "col--7" : !canRenderTOC ? "col--9" : "col--12")}>
+              <_DocItemFooter.default {...props} />
+            </div>
+          </article>
+          <div className={(0, _clsx.default)("col", api ? "col--7" : !canRenderTOC ? "col--9" : "col--12")}>
+            <_DocPaginator.default previous={metadata.previous} next={metadata.next} />
+          </div>
+        </div>
+      </div>
+      {renderTocDesktop && <div className="col col--3">
+          <_TOC.default toc={DocContent.toc} minHeadingLevel={tocMinHeadingLevel} maxHeadingLevel={tocMaxHeadingLevel} className={_themeCommon.ThemeClassNames.docs.docTocDesktop} />
+        </div>}
+    </div>;
+}
+
+function DocItem(props) {
+  const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
+  return <_themeCommon.HtmlClassNameProvider className={docHtmlClassName}>
+      <DocItemMetadata {...props} />
+      <DocItemContent {...props} />
+    </_themeCommon.HtmlClassNameProvider>;
+}

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

@@ -0,0 +1,113 @@
+:root {
+  --openapi-required: var(--ifm-color-danger);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
+}
+
+.apiItemContainer article > *:first-child,
+.apiItemContainer header + * {
+  margin-top: 0;
+}
+
+/* default markdown margins look really silly in a table */
+:global(.theme-api-markdown table *:last-child) {
+  margin-bottom: 0;
+}
+
+:global(.theme-api-markdown details) {
+  margin: unset;
+  max-width: 600px;
+  background-color: transparent;
+  color: var(--ifm-font-color-base);
+  padding: unset;
+  border: unset !important;
+  box-shadow: unset !important;
+  --docusaurus-details-decoration-color: var(--ifm-font-color-base);
+}
+
+:global(.theme-api-markdown details > div > div) {
+  padding-top: unset !important;
+  border-top: unset !important;
+}
+
+:global(.theme-api-markdown code) {
+  max-width: 600px;
+}
+
+@media (min-width: 997px) {
+  .docItemCol {
+    max-width: 75% !important;
+  }
+
+  /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+  .tocMobile {
+    display: none;
+  }
+}
+
+:global(.theme-api-markdown details li) {
+  list-style: none;
+  padding-bottom: 5px;
+  padding-top: 5px;
+}
+
+:global(.theme-api-markdown details li:last-child) {
+  border-left: none;
+}
+
+:global(.theme-api-markdown details p) {
+  margin-bottom: 0;
+}
+
+:global(.theme-api-markdown li::before) {
+  position: absolute;
+  top: 10px;
+  left: 0;
+  width: 0.7rem; /* width of horizontal line */
+  height: 0.5rem; /* vertical position of line */
+  vertical-align: top;
+  border-bottom: thin solid var(--ifm-color-gray-500);
+  content: "";
+  display: inline-block;
+}
+
+:global(.theme-api-markdown details ul) {
+  padding-left: 0;
+  /* font-family: "Fira Mono", monospace; */
+  font-size: 14px;
+}
+
+:global(.theme-api-markdown h2) {
+  font-size: 2rem;
+}
+
+:global(.schemaItem) {
+  list-style: none;
+  position: relative;
+  margin: 0 !important;
+  padding: 5px 0 5px 1rem;
+  border-left: thin solid var(--ifm-color-gray-500) !important;
+}
+
+:global(.schemaItem:hover) {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+:global(.schemaItem:focus) {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+:global(.paramsItem:hover) {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+:global(.paramsItem:focus) {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+:global(.theme-api-markdown div[class^="collapsibleContent"]) {
+  margin-top: 0 !important;
+  padding-left: 2px;
+}