@upendra19/swagger-ui-custom 1.0.0

package/src/core/plugins/oas31/fn.js

@@ -0,0 +1,124 @@
+/**
+ * @prettier
+ */
+import React from "react"
+
+export const isOAS31 = (jsSpec) => {
+  const oasVersion = jsSpec.get("openapi")
+
+  return (
+    typeof oasVersion === "string" && /^3\.1\.(?:[1-9]\d*|0)$/.test(oasVersion)
+  )
+}
+
+/**
+ * Creates selector that returns value of the passed
+ * selector when spec is OpenAPI 3.1.0., null otherwise.
+ *
+ * @param selector
+ * @returns {function(*, ...[*]): function(*): (*|null)}
+ */
+export const createOnlyOAS31Selector =
+  (selector) =>
+  (state, ...args) =>
+  (system) => {
+    if (system.getSystem().specSelectors.isOAS31()) {
+      const selectedValue = selector(state, ...args)
+      return typeof selectedValue === "function"
+        ? selectedValue(system)
+        : selectedValue
+    } else {
+      return null
+    }
+  }
+
+/**
+ * Creates selector wrapper that returns value of the passed
+ * selector when spec is OpenAPI 3.1.0., calls original selector otherwise.
+ *
+ *
+ * @param selector
+ * @returns {function(*, *): function(*, ...[*]): (*)}
+ */
+export const createOnlyOAS31SelectorWrapper =
+  (selector) =>
+  (oriSelector, system) =>
+  (state, ...args) => {
+    if (system.getSystem().specSelectors.isOAS31()) {
+      const selectedValue = selector(state, ...args)
+      return typeof selectedValue === "function"
+        ? selectedValue(oriSelector, system)
+        : selectedValue
+    } else {
+      return oriSelector(...args)
+    }
+  }
+
+/**
+ * Creates selector that provides system as the
+ * second argument. This allows to create memoized
+ * composed selectors from different plugins.
+ *
+ * @param selector
+ * @returns {function(*, ...[*]): function(*): *}
+ */
+export const createSystemSelector =
+  (selector) =>
+  (state, ...args) =>
+  (system) => {
+    const selectedValue = selector(state, system, ...args)
+    return typeof selectedValue === "function"
+      ? selectedValue(system)
+      : selectedValue
+  }
+
+/* eslint-disable  react/jsx-filename-extension */
+/**
+ * Creates component wrapper that only wraps the component
+ * when spec is OpenAPI 3.1.0. Otherwise, returns original
+ * component with passed props.
+ *
+ * @param Component
+ * @returns {function(*, *): function(*): *}
+ */
+export const createOnlyOAS31ComponentWrapper =
+  (Component) => (Original, system) => (props) => {
+    if (system.specSelectors.isOAS31()) {
+      return (
+        <Component
+          {...props}
+          originalComponent={Original}
+          getSystem={system.getSystem}
+        />
+      )
+    }
+
+    return <Original {...props} />
+  }
+/* eslint-enable  react/jsx-filename-extension */
+
+/**
+ * Runs the fn replacement implementation when spec is OpenAPI 3.1.
+ * Runs the fn original implementation otherwise.
+ *
+ * @param fn
+ * @param system
+ * @returns {{[p: string]: function(...[*]): *}}
+ */
+export const wrapOAS31Fn = (fn, system) => {
+  const { fn: systemFn, specSelectors } = system
+
+  return Object.fromEntries(
+    Object.entries(fn).map(([name, newImpl]) => {
+      const oriImpl = systemFn[name]
+      const impl = (...args) =>
+        specSelectors.isOAS31()
+          ? newImpl(...args)
+          : typeof oriImpl === "function"
+            ? oriImpl(...args)
+            : undefined
+
+      return [name, impl]
+    })
+  )
+}

package/src/core/plugins/oas31/index.js

@@ -0,0 +1,166 @@
+/**
+ * @prettier
+ */
+import Webhooks from "./components/webhooks"
+import License from "./components/license"
+import Contact from "./components/contact"
+import Info from "./components/info"
+import JsonSchemaDialect from "./components/json-schema-dialect"
+import VersionPragmaFilter from "./components/version-pragma-filter"
+import Model from "./components/model/model"
+import Models from "./components/models/models"
+import MutualTLSAuth from "./components/auth/mutual-tls-auth"
+import Auths from "./components/auth/auths"
+import LicenseWrapper from "./wrap-components/license"
+import ContactWrapper from "./wrap-components/contact"
+import InfoWrapper from "./wrap-components/info"
+import ModelWrapper from "./wrap-components/model"
+import ModelsWrapper from "./wrap-components/models"
+import VersionPragmaFilterWrapper from "./wrap-components/version-pragma-filter"
+import AuthItemWrapper from "./wrap-components/auth/auth-item"
+import AuthsWrapper from "./wrap-components/auths"
+import {
+  isOAS31 as isOAS31Fn,
+  createOnlyOAS31Selector as createOnlyOAS31SelectorFn,
+  createSystemSelector as createSystemSelectorFn,
+} from "./fn"
+import {
+  license as selectLicense,
+  contact as selectContact,
+  webhooks as selectWebhooks,
+  selectLicenseNameField,
+  selectLicenseUrlField,
+  selectLicenseIdentifierField,
+  selectContactNameField,
+  selectContactEmailField,
+  selectContactUrlField,
+  selectContactUrl,
+  isOAS31 as selectIsOAS31,
+  selectLicenseUrl,
+  selectInfoTitleField,
+  selectInfoSummaryField,
+  selectInfoDescriptionField,
+  selectInfoTermsOfServiceField,
+  selectInfoTermsOfServiceUrl,
+  selectExternalDocsDescriptionField,
+  selectExternalDocsUrlField,
+  selectExternalDocsUrl,
+  selectWebhooksOperations,
+  selectJsonSchemaDialectField,
+  selectJsonSchemaDialectDefault,
+  selectSchemas,
+} from "./spec-extensions/selectors"
+import {
+  isOAS3 as isOAS3SelectorWrapper,
+  selectLicenseUrl as selectLicenseUrlWrapper,
+} from "./spec-extensions/wrap-selectors"
+import { definitionsToAuthorize as definitionsToAuthorizeWrapper } from "./auth-extensions/wrap-selectors"
+import { selectLicenseUrl as selectOAS31LicenseUrl } from "./selectors"
+import JSONSchema202012KeywordExample from "./json-schema-2020-12-extensions/components/keywords/Example"
+import JSONSchema202012KeywordXml from "./json-schema-2020-12-extensions/components/keywords/Xml"
+import JSONSchema202012KeywordDiscriminator from "./json-schema-2020-12-extensions/components/keywords/Discriminator/Discriminator"
+import OpenAPIExtensions from "./json-schema-2020-12-extensions/components/keywords/OpenAPIExtensions"
+import JSONSchema202012KeywordExternalDocs from "./json-schema-2020-12-extensions/components/keywords/ExternalDocs"
+import JSONSchema202012KeywordDescriptionWrapper from "./json-schema-2020-12-extensions/wrap-components/keywords/Description"
+import JSONSchema202012KeywordExamplesWrapper from "./json-schema-2020-12-extensions/wrap-components/keywords/Examples"
+import JSONSchema202012KeywordPropertiesWrapper from "./json-schema-2020-12-extensions/wrap-components/keywords/Properties"
+import afterLoad from "./after-load"
+
+const OAS31Plugin = ({ fn }) => {
+  const createSystemSelector = fn.createSystemSelector || createSystemSelectorFn
+  const createOnlyOAS31Selector = fn.createOnlyOAS31Selector || createOnlyOAS31SelectorFn // prettier-ignore
+
+  return {
+    afterLoad,
+    fn: {
+      isOAS31: isOAS31Fn,
+      createSystemSelector: createSystemSelectorFn,
+      createOnlyOAS31Selector: createOnlyOAS31SelectorFn,
+    },
+    components: {
+      Webhooks,
+      JsonSchemaDialect,
+      MutualTLSAuth,
+      OAS31Info: Info,
+      OAS31License: License,
+      OAS31Contact: Contact,
+      OAS31VersionPragmaFilter: VersionPragmaFilter,
+      OAS31Model: Model,
+      OAS31Models: Models,
+      OAS31Auths: Auths,
+      JSONSchema202012KeywordExample,
+      JSONSchema202012KeywordXml,
+      JSONSchema202012KeywordDiscriminator,
+      JSONSchema202012KeywordExternalDocs,
+      OpenAPI31Extensions: OpenAPIExtensions,
+    },
+    wrapComponents: {
+      InfoContainer: InfoWrapper,
+      License: LicenseWrapper,
+      Contact: ContactWrapper,
+      VersionPragmaFilter: VersionPragmaFilterWrapper,
+      Model: ModelWrapper,
+      Models: ModelsWrapper,
+      AuthItem: AuthItemWrapper,
+      auths: AuthsWrapper,
+      JSONSchema202012KeywordDescription:
+        JSONSchema202012KeywordDescriptionWrapper,
+      JSONSchema202012KeywordExamples: JSONSchema202012KeywordExamplesWrapper,
+      JSONSchema202012KeywordProperties:
+        JSONSchema202012KeywordPropertiesWrapper,
+    },
+    statePlugins: {
+      auth: {
+        wrapSelectors: {
+          definitionsToAuthorize: definitionsToAuthorizeWrapper,
+        },
+      },
+      spec: {
+        selectors: {
+          isOAS31: createSystemSelector(selectIsOAS31),
+
+          license: selectLicense,
+          selectLicenseNameField,
+          selectLicenseUrlField,
+          selectLicenseIdentifierField: createOnlyOAS31Selector(selectLicenseIdentifierField), // prettier-ignore
+          selectLicenseUrl: createSystemSelector(selectLicenseUrl),
+
+          contact: selectContact,
+          selectContactNameField,
+          selectContactEmailField,
+          selectContactUrlField,
+          selectContactUrl: createSystemSelector(selectContactUrl),
+
+          selectInfoTitleField,
+          selectInfoSummaryField: createOnlyOAS31Selector(selectInfoSummaryField), // prettier-ignore
+          selectInfoDescriptionField,
+          selectInfoTermsOfServiceField,
+          selectInfoTermsOfServiceUrl: createSystemSelector(selectInfoTermsOfServiceUrl), // prettier-ignore
+
+          selectExternalDocsDescriptionField,
+          selectExternalDocsUrlField,
+          selectExternalDocsUrl: createSystemSelector(selectExternalDocsUrl),
+
+          webhooks: createOnlyOAS31Selector(selectWebhooks),
+          selectWebhooksOperations: createOnlyOAS31Selector(createSystemSelector(selectWebhooksOperations)), // prettier-ignore
+
+          selectJsonSchemaDialectField,
+          selectJsonSchemaDialectDefault,
+
+          selectSchemas: createSystemSelector(selectSchemas),
+        },
+        wrapSelectors: {
+          isOAS3: isOAS3SelectorWrapper,
+          selectLicenseUrl: selectLicenseUrlWrapper,
+        },
+      },
+      oas31: {
+        selectors: {
+          selectLicenseUrl: createOnlyOAS31Selector(createSystemSelector(selectOAS31LicenseUrl)), // prettier-ignore
+        },
+      },
+    },
+  }
+}
+
+export default OAS31Plugin

package/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Description.jsx

@@ -0,0 +1,27 @@
+/**
+ * @prettier
+ */
+import React from "react"
+import PropTypes from "prop-types"
+
+const Description = ({ schema, getSystem }) => {
+  if (!schema?.description) return null
+
+  const { getComponent } = getSystem()
+  const MarkDown = getComponent("Markdown")
+
+  return (
+    <div className="json-schema-2020-12-keyword json-schema-2020-12-keyword--description">
+      <div className="json-schema-2020-12-core-keyword__value json-schema-2020-12-core-keyword__value--secondary">
+        <MarkDown source={schema.description} />
+      </div>
+    </div>
+  )
+}
+
+Description.propTypes = {
+  schema: PropTypes.oneOfType([PropTypes.object, PropTypes.bool]).isRequired,
+  getSystem: PropTypes.func.isRequired,
+}
+
+export default Description

package/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Discriminator/Discriminator.jsx

@@ -0,0 +1,118 @@
+/**
+ * @prettier
+ */
+import React, { useCallback } from "react"
+import PropTypes from "prop-types"
+import classNames from "classnames"
+
+import DiscriminatorMapping from "./DiscriminatorMapping"
+import { getExtensions } from "../../../../../../utils"
+
+const Discriminator = ({ schema, getSystem }) => {
+  const discriminator = schema?.discriminator || {}
+  const { fn, getComponent, getConfigs } = getSystem()
+  const { showExtensions } = getConfigs()
+  const { useComponent, useIsExpanded, usePath, useLevel } = fn.jsonSchema202012
+  const pathToken = "discriminator"
+  const { path } = usePath(pathToken)
+  const { isExpanded, setExpanded, setCollapsed } = useIsExpanded(pathToken)
+  const [level, nextLevel] = useLevel()
+  const extensions = showExtensions ? getExtensions(discriminator) : []
+  const isExpandable = !!(discriminator.mapping || extensions.length > 0)
+  const Accordion = useComponent("Accordion")
+  const ExpandDeepButton = useComponent("ExpandDeepButton")
+  const OpenAPI31Extensions = getComponent("OpenAPI31Extensions")
+  const JSONSchemaPathContext = getComponent("JSONSchema202012PathContext")()
+  const JSONSchemaLevelContext = getComponent("JSONSchema202012LevelContext")()
+
+  /**
+   * Event handlers.
+   */
+  const handleExpansion = useCallback(() => {
+    if (isExpanded) {
+      setCollapsed()
+    } else {
+      setExpanded()
+    }
+  }, [isExpanded, setExpanded, setCollapsed])
+  const handleExpansionDeep = useCallback(
+    (e, expandedDeepNew) => {
+      if (expandedDeepNew) {
+        setExpanded({ deep: true })
+      } else {
+        setCollapsed({ deep: true })
+      }
+    },
+    [setExpanded, setCollapsed]
+  )
+
+  /**
+   * Rendering.
+   */
+  if (Object.keys(discriminator).length === 0) {
+    return null
+  }
+
+  return (
+    <JSONSchemaPathContext.Provider value={path}>
+      <JSONSchemaLevelContext.Provider value={nextLevel}>
+        <div
+          className="json-schema-2020-12-keyword json-schema-2020-12-keyword--discriminator"
+          data-json-schema-level={level}
+        >
+          {isExpandable ? (
+            <>
+              <Accordion expanded={isExpanded} onChange={handleExpansion}>
+                <span className="json-schema-2020-12-keyword__name json-schema-2020-12-keyword__name--secondary">
+                  Discriminator
+                </span>
+              </Accordion>
+              <ExpandDeepButton
+                expanded={isExpanded}
+                onClick={handleExpansionDeep}
+              />
+            </>
+          ) : (
+            <span className="json-schema-2020-12-keyword__name json-schema-2020-12-keyword__name--secondary">
+              Discriminator
+            </span>
+          )}
+
+          {discriminator.propertyName && (
+            <span className="json-schema-2020-12__attribute json-schema-2020-12__attribute--muted">
+              {discriminator.propertyName}
+            </span>
+          )}
+          <strong className="json-schema-2020-12__attribute json-schema-2020-12__attribute--primary">
+            object
+          </strong>
+          <ul
+            className={classNames("json-schema-2020-12-keyword__children", {
+              "json-schema-2020-12-keyword__children--collapsed": !isExpanded,
+            })}
+          >
+            {isExpanded && (
+              <li className="json-schema-2020-12-property">
+                <DiscriminatorMapping discriminator={discriminator} />
+              </li>
+            )}
+            {extensions.length > 0 && (
+              <OpenAPI31Extensions
+                openAPISpecObj={discriminator}
+                openAPIExtensions={extensions}
+                getSystem={getSystem}
+              />
+            )}
+          </ul>
+        </div>
+      </JSONSchemaLevelContext.Provider>
+    </JSONSchemaPathContext.Provider>
+  )
+}
+
+Discriminator.propTypes = {
+  schema: PropTypes.oneOfType([PropTypes.object, PropTypes.bool]).isRequired,
+  getSystem: PropTypes.func.isRequired,
+}
+
+export default Discriminator

package/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Discriminator/DiscriminatorMapping.jsx

@@ -0,0 +1,32 @@
+/**
+ * @prettier
+ */
+import React from "react"
+import PropTypes from "prop-types"
+
+const DiscriminatorMapping = ({ discriminator }) => {
+  const mapping = discriminator?.mapping || {}
+
+  if (Object.keys(mapping).length === 0) {
+    return null
+  }
+
+  return Object.entries(mapping).map(([key, value]) => (
+    <div key={`${key}-${value}`} className="json-schema-2020-12-keyword">
+      <span className="json-schema-2020-12-keyword__name json-schema-2020-12-keyword__name--secondary">
+        {key}
+      </span>
+      <span className="json-schema-2020-12-keyword__value json-schema-2020-12-keyword__value--secondary">
+        {value}
+      </span>
+    </div>
+  ))
+}
+
+DiscriminatorMapping.propTypes = {
+  discriminator: PropTypes.shape({
+    mapping: PropTypes.any,
+  }),
+}
+
+export default DiscriminatorMapping

package/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Example.jsx

@@ -0,0 +1,28 @@
+/**
+ * @prettier
+ */
+import React from "react"
+import PropTypes from "prop-types"
+
+const Example = ({ schema, getSystem }) => {
+  const { fn, getComponent } = getSystem()
+  const { hasKeyword } = fn.jsonSchema202012.useFn()
+  const JSONViewer = getComponent("JSONSchema202012JSONViewer")
+
+  if (!hasKeyword(schema, "example")) return null
+
+  return (
+    <JSONViewer
+      name="Example"
+      value={schema.example}
+      className="json-schema-2020-12-keyword json-schema-2020-12-keyword--example"
+    />
+  )
+}
+
+Example.propTypes = {
+  schema: PropTypes.oneOfType([PropTypes.object, PropTypes.bool]).isRequired,
+  getSystem: PropTypes.func.isRequired,
+}
+
+export default Example

package/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/ExternalDocs.jsx

@@ -0,0 +1,143 @@
+/**
+ * @prettier
+ */
+import React, { useCallback } from "react"
+import PropTypes from "prop-types"
+import classNames from "classnames"
+
+import { sanitizeUrl } from "core/utils/url"
+import { getExtensions } from "../../../../../utils"
+
+const ExternalDocs = ({ schema, getSystem }) => {
+  const externalDocs = schema?.externalDocs || {}
+  const { fn, getComponent, getConfigs } = getSystem()
+  const { showExtensions } = getConfigs()
+  const { useComponent, useIsExpanded, usePath, useLevel } = fn.jsonSchema202012
+  const pathToken = "externalDocs"
+  const { path } = usePath(pathToken)
+  const { isExpanded, setExpanded, setCollapsed } = useIsExpanded(pathToken)
+  const [level, nextLevel] = useLevel()
+  const extensions = showExtensions ? getExtensions(externalDocs) : []
+  const isExpandable = !!(
+    externalDocs.description ||
+    externalDocs.url ||
+    extensions.length > 0
+  )
+  const Accordion = useComponent("Accordion")
+  const ExpandDeepButton = useComponent("ExpandDeepButton")
+  const KeywordDescription = getComponent("JSONSchema202012KeywordDescription")
+  const Link = getComponent("Link")
+  const OpenAPI31Extensions = getComponent("OpenAPI31Extensions")
+  const JSONSchemaPathContext = getComponent("JSONSchema202012PathContext")()
+  const JSONSchemaLevelContext = getComponent("JSONSchema202012LevelContext")()
+
+  /**
+   * Event handlers.
+   */
+  const handleExpansion = useCallback(() => {
+    if (isExpanded) {
+      setCollapsed()
+    } else {
+      setExpanded()
+    }
+  }, [isExpanded, setExpanded, setCollapsed])
+  const handleExpansionDeep = useCallback(
+    (e, expandedDeepNew) => {
+      if (expandedDeepNew) {
+        setExpanded({ deep: true })
+      } else {
+        setCollapsed({ deep: true })
+      }
+    },
+    [setExpanded, setCollapsed]
+  )
+
+  /**
+   * Rendering.
+   */
+  if (Object.keys(externalDocs).length === 0) {
+    return null
+  }
+
+  return (
+    <JSONSchemaPathContext.Provider value={path}>
+      <JSONSchemaLevelContext.Provider value={nextLevel}>
+        <div
+          className="json-schema-2020-12-keyword json-schema-2020-12-keyword--externalDocs"
+          data-json-schema-level={level}
+        >
+          {isExpandable ? (
+            <>
+              <Accordion expanded={isExpanded} onChange={handleExpansion}>
+                <span className="json-schema-2020-12-keyword__name json-schema-2020-12-keyword__name--secondary">
+                  External documentation
+                </span>
+              </Accordion>
+              <ExpandDeepButton
+                expanded={isExpanded}
+                onClick={handleExpansionDeep}
+              />
+            </>
+          ) : (
+            <span className="json-schema-2020-12-keyword__name json-schema-2020-12-keyword__name--secondary">
+              External documentation
+            </span>
+          )}
+          <strong className="json-schema-2020-12__attribute json-schema-2020-12__attribute--primary">
+            object
+          </strong>
+          <ul
+            className={classNames("json-schema-2020-12-keyword__children", {
+              "json-schema-2020-12-keyword__children--collapsed": !isExpanded,
+            })}
+          >
+            {isExpanded && (
+              <>
+                {externalDocs.description && (
+                  <li className="json-schema-2020-12-property">
+                    <KeywordDescription
+                      schema={externalDocs}
+                      getSystem={getSystem}
+                    />
+                  </li>
+                )}
+
+                {externalDocs.url && (
+                  <li className="json-schema-2020-12-property">
+                    <div className="json-schema-2020-12-keyword json-schema-2020-12-keyword">
+                      <span className="json-schema-2020-12-keyword__name json-schema-2020-12-keyword__name--secondary">
+                        url
+                      </span>
+                      <span className="json-schema-2020-12-keyword__value json-schema-2020-12-keyword__value--secondary">
+                        <Link
+                          target="_blank"
+                          href={sanitizeUrl(externalDocs.url)}
+                        >
+                          {externalDocs.url}
+                        </Link>
+                      </span>
+                    </div>
+                  </li>
+                )}
+              </>
+            )}
+            {extensions.length > 0 && (
+              <OpenAPI31Extensions
+                openAPISpecObj={externalDocs}
+                openAPIExtensions={extensions}
+                getSystem={getSystem}
+              />
+            )}
+          </ul>
+        </div>
+      </JSONSchemaLevelContext.Provider>
+    </JSONSchemaPathContext.Provider>
+  )
+}
+
+ExternalDocs.propTypes = {
+  schema: PropTypes.oneOfType([PropTypes.object, PropTypes.bool]).isRequired,
+  getSystem: PropTypes.func.isRequired,
+}
+
+export default ExternalDocs

package/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/OpenAPIExtensions.jsx

@@ -0,0 +1,33 @@
+/**
+ * @prettier
+ */
+import React from "react"
+import PropTypes from "prop-types"
+
+const OpenAPIExtensions = ({
+  openAPISpecObj,
+  getSystem,
+  openAPIExtensions,
+}) => {
+  const { fn } = getSystem()
+  const { useComponent } = fn.jsonSchema202012
+
+  const JSONViewer = useComponent("JSONViewer")
+  return openAPIExtensions.map((keyword) => (
+    <JSONViewer
+      key={keyword}
+      name={keyword}
+      value={openAPISpecObj[keyword]}
+      className="json-schema-2020-12-json-viewer-extension-keyword"
+    />
+  ))
+}
+
+OpenAPIExtensions.propTypes = {
+  openAPISpecObj: PropTypes.oneOfType([PropTypes.object, PropTypes.bool])
+    .isRequired,
+  getSystem: PropTypes.func.isRequired,
+  openAPIExtensions: PropTypes.arrayOf(PropTypes.string).isRequired,
+}
+
+export default OpenAPIExtensions