@upendra19/swagger-ui-custom 1.0.0 → 1.0.1

package/docker/configurator/helpers.js

@@ -1,13 +0,0 @@
-module.exports.indent = function indent(str, len, fromLine = 0) {
-
-  return str
-    .split("\n")
-    .map((line, i) => {
-      if (i + 1 >= fromLine) {
-        return `${Array(len + 1).join(" ")}${line}`
-      } else {
-        return line
-      }
-    })
-    .join("\n")
-}

package/docker/configurator/index.js

@@ -1,52 +0,0 @@
-/*
- * Replace static code with configured data based on environment-variables.
- * This code should be called BEFORE the webserver serve the api-documentation.
- */
-const fs = require("fs")
-const path = require("path")
-
-const translator = require("./translator")
-const oauthBlockBuilder = require("./oauth")
-const indent = require("./helpers").indent
-
-const START_MARKER = "//<editor-fold desc=\"Changeable Configuration Block\">"
-const END_MARKER = "//</editor-fold>"
-
-const targetPath = path.normalize(process.cwd() + "/" + process.argv[2])
-
-const originalHtmlContent = fs.readFileSync(targetPath, "utf8")
-
-const startMarkerIndex = originalHtmlContent.indexOf(START_MARKER)
-const endMarkerIndex = originalHtmlContent.indexOf(END_MARKER)
-
-const beforeStartMarkerContent = originalHtmlContent.slice(0, startMarkerIndex)
-const afterEndMarkerContent = originalHtmlContent.slice(
-  endMarkerIndex + END_MARKER.length
-)
-
-if (startMarkerIndex < 0 || endMarkerIndex < 0) {
-  console.error("ERROR: Swagger UI was unable to inject Docker configuration data!")
-  console.error("!      This can happen when you provide custom HTML/JavaScript to Swagger UI.")
-  console.error("!  ")
-  console.error(`!      In order to solve this, add the "${START_MARKER}"`)
-  console.error(`!      and "${END_MARKER}" markers to your JavaScript.`)
-  console.error("!      See the repository for an example:")
-  console.error("!      https://github.com/swagger-api/swagger-ui/blob/8c946a02e73ef877d73b7635de27924418ba50f3/dist/swagger-initializer.js#L2-L19")
-  console.error("!  ")
-  console.error("!      If you're seeing this message and aren't using custom HTML,")
-  console.error("!      this message may be a bug. Please file an issue:")
-  console.error("!      https://github.com/swagger-api/swagger-ui/issues/new/choose")
-  process.exit(0)
-}
-
-fs.writeFileSync(
-  targetPath,
-  `${beforeStartMarkerContent}
-      ${START_MARKER}
-      window.ui = SwaggerUIBundle({
-        ${indent(translator(process.env, {injectBaseConfig: true}), 8, 2)}
-      })
-      ${indent(oauthBlockBuilder(process.env), 6, 2)}
-      ${END_MARKER}
-${afterEndMarkerContent}`
-)

package/docker/configurator/oauth.js

@@ -1,55 +0,0 @@
-const translator = require("./translator")
-const indent = require("./helpers").indent
-
-const oauthBlockSchema = {
-  OAUTH_CLIENT_ID: {
-    type: "string",
-    name: "clientId"
-  },
-  OAUTH_CLIENT_SECRET: {
-    type: "string",
-    name: "clientSecret",
-    onFound: () => console.warn("Swagger UI warning: don't use `OAUTH_CLIENT_SECRET` in production!")
-  },
-  OAUTH_REALM: {
-    type: "string",
-    name: "realm"
-  },
-  OAUTH_APP_NAME: {
-    type: "string",
-    name: "appName"
-  },
-  OAUTH_SCOPE_SEPARATOR: {
-    type: "string",
-    name: "scopeSeparator"
-  },
-  OAUTH_SCOPES: {
-    type: "string",
-    name: "scopes"
-  },
-  OAUTH_ADDITIONAL_PARAMS: {
-    type: "object",
-    name: "additionalQueryStringParams"
-  },
-  OAUTH_USE_BASIC_AUTH: {
-    type: "boolean",
-    name: "useBasicAuthenticationWithAccessCodeGrant"
-  },
-  OAUTH_USE_PKCE: {
-    type: "boolean",
-    name: "usePkceWithAuthorizationCodeGrant"
-  }
-}
-
-module.exports = function oauthBlockBuilder(env) {
-  const translatorResult = translator(env, { schema: oauthBlockSchema })
-
-  if(translatorResult) {
-    return (
-      `ui.initOAuth({
-${indent(translatorResult, 2)}
-})`)
-  }
-
-  return ``
-}

package/docker/configurator/translator.js

@@ -1,111 +0,0 @@
-// Converts an object of environment variables into a Swagger UI config object
-const configSchema = require("./variables")
-
-const defaultBaseConfig = {
-  url: {
-    value: "https://petstore.swagger.io/v2/swagger.json",
-    schema: {
-      type: "string",
-      base: true
-    }
-  },
-  dom_id: {
-    value: "#swagger-ui",
-    schema: {
-      type: "string",
-      base: true
-    }
-  },
-  deepLinking: {
-    value: "true",
-    schema: {
-      type: "boolean",
-      base: true
-    }
-  },
-  presets: {
-    value: `[\n  SwaggerUIBundle.presets.apis,\n  SwaggerUIStandalonePreset\n]`,
-    schema: {
-      type: "array",
-      base: true
-    }
-  },
-  plugins: {
-    value: `[\n  SwaggerUIBundle.plugins.DownloadUrl\n]`,
-    schema: {
-      type: "array",
-      base: true
-    }
-  },
-  layout: {
-    value: "StandaloneLayout",
-    schema: {
-      type: "string",
-      base: true
-    }
-  },
-  queryConfigEnabled: {
-    value: "false",
-    schema: {
-      type: "boolean",
-      base: true,
-    }
-  }
-}
-
-function objectToKeyValueString(env, { injectBaseConfig = false, schema = configSchema, baseConfig = defaultBaseConfig } = {}) {
-  let valueStorage = injectBaseConfig ? Object.assign({}, baseConfig) : {}
-  const keys = Object.keys(env)
-
-  // Compute an intermediate representation that holds candidate values and schemas.
-  //
-  // This is useful for deduping between multiple env keys that set the same
-  // config variable.
-
-  keys.forEach(key => {
-    const varSchema = schema[key]
-    const value = env[key]
-
-    if(!varSchema) return
-
-    if(varSchema.onFound) {
-      varSchema.onFound()
-    }
-
-    const storageContents = valueStorage[varSchema.name]
-
-    if(storageContents) {
-      if (varSchema.legacy === true && !storageContents.schema.base) {
-        // If we're looking at a legacy var, it should lose out to any already-set value
-        // except for base values
-        return
-      }
-      delete valueStorage[varSchema.name]
-    }
-
-    valueStorage[varSchema.name] = {
-      value,
-      schema: varSchema
-    }
-  })
-
-  // Compute a key:value string based on valueStorage's contents.
-
-  let result = ""
-
-  Object.keys(valueStorage).forEach(key => {
-    const value = valueStorage[key]
-
-    const escapedName = /[^a-zA-Z0-9]/.test(key) ? `"${key}"` : key
-
-    if (value.schema.type === "string") {
-      result += `${escapedName}: "${value.value}",\n`
-    } else {
-      result += `${escapedName}: ${value.value === "" ? `undefined` : value.value},\n`
-    }
-  })
-
-  return result.trim()
-}
-
-module.exports = objectToKeyValueString

package/docker/configurator/variables.js

@@ -1,125 +0,0 @@
-const standardVariables = {
-  CONFIG_URL: {
-    type: "string",
-    name: "configUrl"
-  },
-  DOM_ID: {
-    type: "string",
-    name: "dom_id"
-  },
-  SPEC: {
-    type: "object",
-    name: "spec"
-  },
-  URL: {
-    type: "string",
-    name: "url"
-  },
-  URLS: {
-    type: "array",
-    name: "urls"
-  },
-  URLS_PRIMARY_NAME: {
-    type: "string",
-    name: "urls.primaryName"
-  },
-  QUERY_CONFIG_ENABLED: {
-    type: "boolean",
-    name: "queryConfigEnabled"
-  },
-  LAYOUT: {
-    type: "string",
-    name: "layout"
-  },
-  DEEP_LINKING: {
-    type: "boolean",
-    name: "deepLinking"
-  },
-  DISPLAY_OPERATION_ID: {
-    type: "boolean",
-    name: "displayOperationId"
-  },
-  DEFAULT_MODELS_EXPAND_DEPTH: {
-    type: "number",
-    name: "defaultModelsExpandDepth"
-  },
-  DEFAULT_MODEL_EXPAND_DEPTH: {
-    type: "number",
-    name: "defaultModelExpandDepth"
-  },
-  DEFAULT_MODEL_RENDERING: {
-    type: "string",
-    name: "defaultModelRendering"
-  },
-  DISPLAY_REQUEST_DURATION: {
-    type: "boolean",
-    name: "displayRequestDuration"
-  },
-  DOC_EXPANSION: {
-    type: "string",
-    name: "docExpansion"
-  },
-  FILTER: {
-    type: "string",
-    name: "filter"
-  },
-  MAX_DISPLAYED_TAGS: {
-    type: "number",
-    name: "maxDisplayedTags"
-  },
-  SHOW_EXTENSIONS: {
-    type: "boolean",
-    name: "showExtensions"
-  },
-  SHOW_COMMON_EXTENSIONS: {
-    type: "boolean",
-    name: "showCommonExtensions"
-  },
-  USE_UNSAFE_MARKDOWN: {
-    type: "boolean",
-    name: "useUnsafeMarkdown"
-  },
-  OAUTH2_REDIRECT_URL: {
-    type: "string",
-    name: "oauth2RedirectUrl"
-  },
-  PERSIST_AUTHORIZATION: {
-    type: "boolean",
-    name: "persistAuthorization"
-  },
-  SHOW_MUTATED_REQUEST: {
-    type: "boolean",
-    name: "showMutatedRequest"
-  },
-  SUPPORTED_SUBMIT_METHODS: {
-    type: "array",
-    name: "supportedSubmitMethods"
-  },
-  TRY_IT_OUT_ENABLED: {
-    type: "boolean",
-    name: "tryItOutEnabled"
-  },
-  VALIDATOR_URL: {
-    type: "string",
-    name: "validatorUrl"
-  },
-  WITH_CREDENTIALS: {
-    type: "boolean",
-    name: "withCredentials",
-  }
-}
-
-const legacyVariables = {
-  API_URL: {
-    type: "string",
-    name: "url",
-    legacy: true
-  },
-  API_URLS: {
-    type: "array",
-    name: "urls",
-    legacy: true
-  }
-}
-
-module.exports = Object.assign({}, standardVariables, legacyVariables)

package/docker/cors.conf

@@ -1,14 +0,0 @@
-add_header 'Access-Control-Allow-Origin' '*' always;
-add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS' always;
-#
-# Custom headers and headers various browsers *should* be OK with but aren't
-#
-add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type' always;
-#
-# Tell client that this pre-flight info is valid for 20 days
-#
-add_header 'Access-Control-Max-Age' $access_control_max_age always;
-
-if ($request_method = OPTIONS) {
-  return 204;
-}

package/docker/default.conf.template

@@ -1,43 +0,0 @@
-  types {
-    text/plain yaml;
-    text/plain yml;
-  }
-
-  gzip on;
-  gzip_static on;
-  gzip_disable "msie6";
-
-  gzip_vary on;
-  gzip_types text/plain text/css application/javascript;
-
-  map $request_method $access_control_max_age {
-    OPTIONS 1728000; # 20 days
-  }
-  server_tokens off; # Hide Nginx version
-
-  server {
-    listen            $PORT;
-    server_name       localhost;
-    index             index.html index.htm;
-
-    location $BASE_URL {
-      absolute_redirect off;
-      alias            /usr/share/nginx/html/;
-      expires 1d;
-
-      location ~ swagger-initializer.js {
-        expires -1;
-        include templates/cors.conf;
-      }
-
-      location ~* \.(?:json|yml|yaml)$ {
-        #SWAGGER_ROOT
-        expires -1;
-
-        include templates/cors.conf;
-      }
-
-      include templates/cors.conf;
-      include templates/embedding.conf;
-    }
-  }

package/docker/docker-entrypoint.d/40-swagger-ui.sh

@@ -1,52 +0,0 @@
-#! /bin/sh
-
-set -e
-NGINX_ROOT=/usr/share/nginx/html
-INITIALIZER_SCRIPT=$NGINX_ROOT/swagger-initializer.js
-NGINX_CONF=/etc/nginx/conf.d/default.conf
-
-node /usr/share/nginx/configurator $INITIALIZER_SCRIPT
-
-
-if [ "$SWAGGER_JSON_URL" ]; then
-  sed -i "s|https://petstore.swagger.io/v2/swagger.json|$SWAGGER_JSON_URL|g" $INITIALIZER_SCRIPT
-  sed -i "s|http://example.com/api|$SWAGGER_JSON_URL|g" $INITIALIZER_SCRIPT
-fi
-
-if [[ -f "$SWAGGER_JSON" ]]; then
-  cp -s "$SWAGGER_JSON" "$NGINX_ROOT"
-  REL_PATH="./$(basename $SWAGGER_JSON)"
-
-  if [[ -z "$SWAGGER_ROOT" ]]; then
-    SWAGGER_ROOT="$(dirname $SWAGGER_JSON)"
-  fi
-
-  if [[ "$BASE_URL" != "/" ]]
-  then
-    BASE_URL=$(echo $BASE_URL | sed 's/\/$//')
-    sed -i \
-      "s|#SWAGGER_ROOT|rewrite ^$BASE_URL(/.*)$ \$1 break;\n        #SWAGGER_ROOT|" \
-      $NGINX_CONF
-  fi
-  sed -i "s|#SWAGGER_ROOT|root $SWAGGER_ROOT/;|g" $NGINX_CONF
-
-  sed -i "s|https://petstore.swagger.io/v2/swagger.json|$REL_PATH|g" $INITIALIZER_SCRIPT
-  sed -i "s|http://example.com/api|$REL_PATH|g" $INITIALIZER_SCRIPT
-fi
-
-# enable/disable the address and port for IPv6 addresses that nginx listens on
-if [[ -n "${PORT_IPV6}" ]]; then
-    sed -i "s|${PORT};|${PORT};\n    listen            [::]:${PORT_IPV6};|g" $NGINX_CONF
-fi
-
-# enable/disable CORS
-if [ "$CORS" != "true" ]; then
-  truncate -s 0 /etc/nginx/templates/cors.conf
-fi
-
-# allow/disallow embedding the swagger-ui in frames/iframes from different origins
-if [ "$EMBEDDING" != "false" ]; then
-  truncate -s 0 /etc/nginx/templates/embedding.conf
-fi
-
-find $NGINX_ROOT -type f -regex ".*\.\(html\|js\|css\)" -exec sh -c "gzip < {} > {}.gz" \;

package/docker/embedding.conf

@@ -1,5 +0,0 @@
-#
-# Prevent displaying inside an iframe
-#
-add_header 'X-Frame-Options' 'DENY' always;
-add_header 'Content-Security-Policy' "frame-ancestors 'none'" always;

package/snapcraft.yaml

@@ -1,28 +0,0 @@
-name: swagger-ui
-version: master
-summary: The World's Most Popular API Framework
-description: |
-  Swagger UI is part of the Swagger project. The Swagger project allows you to
-  produce, visualize and consume your OWN RESTful services. No proxy or 3rd
-  party services required. Do it your own way.
-
-  Swagger UI is a dependency-free collection of HTML, Javascript, and CSS
-  assets that dynamically generate beautiful documentation and sandbox from a
-  Swagger-compliant API. Because Swagger UI has no dependencies, you can host
-  it in any server environment, or on your local machine.
-
-grade: devel
-confinement: strict
-
-apps:
-  swagger-ui:
-    command: sh -c \"cd $SNAP/lib/node_modules/swagger-ui/dist && http-server -a localhost -p 8080\"
-    daemon: simple
-    plugs: [network, network-bind]
-
-parts:
-  swagger-ui:
-    source: .
-    plugin: nodejs
-    npm-run: [build]
-    node-packages: [handlebars, http-server]

package/src/core/assets/rolling-load.svg

@@ -1 +0,0 @@
-<svg width="200px"  height="200px"  xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="xMidYMid" class="lds-rolling" style="background-image: none; background-position: initial initial; background-repeat: initial initial;"><circle cx="50" cy="50" fill="none" ng-attr-stroke="{{config.color}}" ng-attr-stroke-width="{{config.width}}" ng-attr-r="{{config.radius}}" ng-attr-stroke-dasharray="{{config.dasharray}}" stroke="#555555" stroke-width="10" r="35" stroke-dasharray="164.93361431346415 56.97787143782138"><animateTransform attributeName="transform" type="rotate" calcMode="linear" values="0 50 50;360 50 50" keyTimes="0;1" dur="1s" begin="0s" repeatCount="indefinite"></animateTransform></circle></svg>

package/src/core/components/app.jsx

@@ -1,30 +0,0 @@
-/**
- * @prettier
- */
-import React from "react"
-import PropTypes from "prop-types"
-
-class App extends React.Component {
-  getLayout() {
-    const { getComponent, layoutSelectors } = this.props
-    const layoutName = layoutSelectors.current()
-    const Component = getComponent(layoutName, true)
-
-    return Component
-      ? Component
-      : () => <h1> No layout defined for &quot;{layoutName}&quot; </h1>
-  }
-
-  render() {
-    const Layout = this.getLayout()
-
-    return <Layout />
-  }
-}
-
-App.propTypes = {
-  getComponent: PropTypes.func.isRequired,
-  layoutSelectors: PropTypes.object.isRequired,
-}
-
-export default App

package/src/core/components/auth/api-key-auth.jsx

@@ -1,93 +0,0 @@
-import React from "react"
-import PropTypes from "prop-types"
-
-export default class ApiKeyAuth extends React.Component {
-  static propTypes = {
-    authorized: PropTypes.object,
-    getComponent: PropTypes.func.isRequired,
-    errSelectors: PropTypes.object.isRequired,
-    schema: PropTypes.object.isRequired,
-    name: PropTypes.string.isRequired,
-    onChange: PropTypes.func,
-    authSelectors: PropTypes.object.isRequired
-  }
-
-  constructor(props, context) {
-    super(props, context)
-    let { name, schema } = this.props
-    let value = this.getValue()
-
-    this.state = {
-      name: name,
-      schema: schema,
-      value: value
-    }
-  }
-
-  getValue () {
-    let { name, authorized } = this.props
-
-    return authorized && authorized.getIn([name, "value"])
-  }
-
-  onChange =(e) => {
-    let { onChange } = this.props
-    let value = e.target.value
-    let newState = Object.assign({}, this.state, { value: value })
-
-    this.setState(newState)
-    onChange(newState)
-  }
-
-  render() {
-    let { schema, getComponent, errSelectors, name, authSelectors } = this.props
-    const Input = getComponent("Input")
-    const Row = getComponent("Row")
-    const Col = getComponent("Col")
-    const AuthError = getComponent("authError")
-    const Markdown = getComponent("Markdown", true)
-    const JumpToPath = getComponent("JumpToPath", true)
-    const path = authSelectors.selectAuthPath(name)
-    let value = this.getValue()
-    let errors = errSelectors.allErrors().filter( err => err.get("authId") === name)
-
-    return (
-      <div>
-        <h4>
-          <code>{ name || schema.get("name") }</code>&nbsp;(apiKey)
-          <JumpToPath path={path} />
-        </h4>
-        { value && <h6>Authorized</h6>}
-        <Row>
-          <Markdown source={ schema.get("description") } />
-        </Row>
-        <Row>
-          <p>Name: <code>{ schema.get("name") }</code></p>
-        </Row>
-        <Row>
-          <p>In: <code>{ schema.get("in") }</code></p>
-        </Row>
-        <Row>
-          <label htmlFor="api_key_value">Value:</label>
-          {
-            value ? <code> ****** </code>
-                  : <Col>
-                      <Input 
-                        id="api_key_value" 
-                        type="text" 
-                        onChange={ this.onChange } 
-                        autoFocus
-                      />
-                    </Col>
-          }
-        </Row>
-        {
-          errors.valueSeq().map( (error, key) => {
-            return <AuthError error={ error }
-                              key={ key }/>
-          } )
-        }
-      </div>
-    )
-  }
-}

package/src/core/components/auth/auth-item.jsx

@@ -1,60 +0,0 @@
-import React from "react"
-import PropTypes from "prop-types"
-import ImPropTypes from "react-immutable-proptypes"
-
-export default class Auths extends React.Component {
-  static propTypes = {
-    authorized: ImPropTypes.orderedMap.isRequired,
-    schema: ImPropTypes.orderedMap.isRequired,
-    name: PropTypes.string.isRequired,
-    getComponent: PropTypes.func.isRequired,
-    onAuthChange: PropTypes.func.isRequired,
-    errSelectors: PropTypes.object.isRequired,
-    authSelectors: PropTypes.object.isRequired,
-  }
-
-  render() {
-    let {
-      schema,
-      name,
-      getComponent,
-      onAuthChange,
-      authorized,
-      errSelectors,
-      authSelectors
-    } = this.props
-    const ApiKeyAuth = getComponent("apiKeyAuth")
-    const BasicAuth = getComponent("basicAuth")
-
-    let authEl
-
-    const type = schema.get("type")
-
-    switch(type) {
-      case "apiKey": authEl = <ApiKeyAuth key={ name }
-                                        schema={ schema }
-                                        name={ name }
-                                        errSelectors={ errSelectors }
-                                        authorized={ authorized }
-                                        getComponent={ getComponent }
-                                        onChange={ onAuthChange }
-                                        authSelectors = { authSelectors } />
-        break
-      case "basic": authEl = <BasicAuth key={ name }
-                                      schema={ schema }
-                                      name={ name }
-                                      errSelectors={ errSelectors }
-                                      authorized={ authorized }
-                                      getComponent={ getComponent }
-                                      onChange={ onAuthChange }
-                                      authSelectors = { authSelectors } />
-        break
-      default: authEl = <div key={ name }>Unknown security definition type { type }</div>
-    }
-
-    return (<div key={`${name}-jump`}>
-      { authEl }
-    </div>)
-  }
-
-}