- Example Value -
- + { schema ?
- Model - + : null }
{
(isExecute || this.state.activeTab === "example") && example
}
{
- !isExecute && this.state.activeTab === "model" &&
-
- [ { value.join(", ") } ]
-
-
-}
-
-EnumModel.propTypes = {
- value: ImPropTypes.iterable
-}
-
-class ObjectModel extends Component {
- static propTypes = {
- schema: PropTypes.object.isRequired,
- getComponent: PropTypes.func.isRequired,
- specSelectors: PropTypes.object.isRequired,
- name: PropTypes.string,
- isRef: PropTypes.bool,
- expandDepth: PropTypes.number,
- depth: PropTypes.number
- }
-
- render(){
- let { schema, name, isRef, getComponent, depth, ...props } = this.props
- let { expandDepth } = this.props
- const JumpToPath = getComponent("JumpToPath", true)
- let description = schema.get("description")
- let properties = schema.get("properties")
- let additionalProperties = schema.get("additionalProperties")
- let title = schema.get("title") || name
- let required = schema.get("required")
- const Markdown = getComponent("Markdown")
- const JumpToPathSection = ({ name }) => expandDepth } collapsedContent={ collapsedContent }>
- { braceOpen }
- {
- !isRef ? null :
- {
- !description ? null :
- }
-
- { braceClose }
-
-
- }
-}
-
-class Primitive extends Component {
- static propTypes = {
- schema: PropTypes.object.isRequired,
- name: PropTypes.string,
- getComponent: PropTypes.func.isRequired,
- required: PropTypes.bool
- }
-
- render(){
- let { schema, getComponent, name, required } = this.props
-
- if(!schema || !schema.get) {
- // don't render if schema isn't correctly formed
- return
- }
-
- let type = schema.get("type")
- let format = schema.get("format")
- let xml = schema.get("xml")
- let enumArray = schema.get("enum")
- let title = schema.get("title") || name
- let description = schema.get("description")
- let properties = schema.filter( ( v, key) => ["enum", "type", "format", "description", "$$ref"].indexOf(key) === -1 )
- let style = required ? { fontWeight: "bold" } : {}
- const Markdown = getComponent("Markdown")
-
- return
- {
- title &&
- { title }
-
- }
- { type } { required && *}
- { format && (${format})}
- {
- properties.size ? properties.entrySeq().map( ( [ key, v ] ) =>
-
{ key }: { String(v) }) - : null - } - { - !description ? null : -
xml: - { - xml.entrySeq().map( ( [ key, v ] ) =>
{key}: { String(v) }).toArray() - } - ): null - } - { - enumArray && expandDepth } collapsedContent="[...]">
- [
-
{ `${key}:`}{ String(v) }) - }
- : null - } -
- { required && *}
-
- }
-}
-
-
-class Model extends Component {
+export default class Model extends Component {
static propTypes = {
schema: PropTypes.object.isRequired,
getComponent: PropTypes.func.isRequired,
@@ -229,6 +17,9 @@ class Model extends Component {
if ( ref.indexOf("#/definitions/") !== -1 ) {
return ref.replace(/^.*#\/definitions\//, "")
}
+ if ( ref.indexOf("#/components/schemas/") !== -1 ) {
+ return ref.replace("#/components/schemas/", "")
+ }
}
getRefSchema =( model )=> {
@@ -238,11 +29,16 @@ class Model extends Component {
}
render () {
- let { schema, getComponent, required, name, isRef } = this.props
+ let { getComponent, specSelectors, schema, required, name, isRef } = this.props
+ let ObjectModel = getComponent("ObjectModel")
+ let ArrayModel = getComponent("ArrayModel")
+ let PrimitiveModel = getComponent("PrimitiveModel")
let $$ref = schema && schema.get("$$ref")
let modelName = $$ref && this.getModelName( $$ref )
let modelSchema, type
+ const deprecated = specSelectors.isOAS3() && schema.get("deprecated")
+
if ( schema && (schema.get("type") || schema.get("properties")) ) {
modelSchema = schema
} else if ( $$ref ) {
@@ -256,73 +52,30 @@ class Model extends Component {
switch(type) {
case "object":
- return
+
{
definitions.entrySeq().map( ( [ name, model ])=>{
return
+
+ }
+}
+
+
diff --git a/src/core/components/model.jsx b/src/core/components/model.jsx
index de714403..5e9a3fcf 100644
--- a/src/core/components/model.jsx
+++ b/src/core/components/model.jsx
@@ -1,219 +1,7 @@
import React, { Component } from "react"
import PropTypes from "prop-types"
-import ImPropTypes from "react-immutable-proptypes"
-import { List } from "immutable"
-const braceOpen = "{"
-const braceClose = "}"
-const propStyle = { color: "#999", fontStyle: "italic" }
-
-const EnumModel = ({ value }) => {
- let collapsedContent = Array [ { value.count() } ]
- return
- Enum:-
| description: | -
- |
-
| { key }: | -
- |
-
| { "< * >:" } | -
- |
-
{ key }: { String(v) }) - : null - } - { - !description ? null : -
xml: - { - xml.entrySeq().map( ( [ key, v ] ) =>
{key}: { String(v) }).toArray() - } - ): null - } - { - enumArray &&
{ `${key}:`}{ String(v) }) - }
- : null - } -
-
- }
-}
-
-class Collapse extends Component {
- static propTypes = {
- collapsedContent: PropTypes.any,
- collapsed: PropTypes.bool,
- children: PropTypes.any
- }
-
- static defaultProps = {
- collapsedContent: "{...}",
- collapsed: true,
- }
-
- constructor(props, context) {
- super(props, context)
-
- let { collapsed, collapsedContent } = this.props
-
- this.state = {
- collapsed: collapsed !== undefined ? collapsed : Collapse.defaultProps.collapsed,
- collapsedContent: collapsedContent || Collapse.defaultProps.collapsedContent
- }
- }
-
- toggleCollapsed=()=>{
- this.setState({
- collapsed: !this.state.collapsed
- })
- }
-
- render () {
- return (
-
-
-
- { this.state.collapsed ? this.state.collapsedContent : this.props.children }
- )
+ return
- expandDepth } collapsedContent={ collapsedContent }>
+ { braceOpen }
+ {
+ !isRef ? null :
+ {
+ !description ? null :
+ }
+
+ { braceClose }
+
+
+ }
+}
\ No newline at end of file
diff --git a/src/core/components/operation.jsx b/src/core/components/operation.jsx
index 52807722..26743fbc 100644
--- a/src/core/components/operation.jsx
+++ b/src/core/components/operation.jsx
@@ -116,7 +116,8 @@ export default class Operation extends PureComponent {
specActions,
specSelectors,
authActions,
- authSelectors
+ authSelectors,
+ getConfigs
} = this.props
let summary = operation.get("summary")
@@ -141,6 +142,10 @@ export default class Operation extends PureComponent {
const Markdown = getComponent( "Markdown" )
const Schemes = getComponent( "schemes" )
+ const { deepLinking } = getConfigs()
+
+ const isDeepLinkingEnabled = deepLinking && deepLinking !== "false"
+
// Merge in Live Response
if(response && response.size > 0) {
let notDocumented = !responses.get(String(response.get("status")))
@@ -152,13 +157,18 @@ export default class Operation extends PureComponent {
let onChangeKey = [ path, method ] // Used to add values to _this_ operation ( indexed by path and method )
return (
-
| description: | +
+ |
+
| + { key }{ isRequired && * } + | +
+ |
+
| { "< * >:" } | +
+ |
+
+
- {method.toUpperCase()}
-
- {path}
-
@@ -191,13 +201,16 @@ export default class Operation extends PureComponent {
: null
}
{
+ return tag.indexOf(filter) !== -1
+ })
+ }
+ }
+
+ if (maxDisplayedTags && !isNaN(maxDisplayedTags) && maxDisplayedTags >= 0) {
+ taggedOps = taggedOps.slice(0, maxDisplayedTags)
+ }
return (
Find more details
@@ -41,6 +66,8 @@ export default class Operations extends React.Component {
taggedOps.map( (tagObj, tag) => {
let operations = tagObj.get("operations")
let tagDescription = tagObj.getIn(["tagDetails", "description"], null)
+ let tagExternalDocsDescription = tagObj.getIn(["tagDetails", "externalDocs", "description"])
+ let tagExternalDocsUrl = tagObj.getIn(["tagDetails", "externalDocs", "url"])
let isShownKey = ["operations-tag", tag]
let showTag = layoutSelectors.isShown(isShownKey, docExpansion === "full" || docExpansion === "list")
@@ -48,14 +75,38 @@ export default class Operations extends React.Component {
return (
this.setState({ responseContentType: val })}
+ className="response-content-type" /> : null }
+
{ example ? (
+ { links ?
+ links.toSeq().map((link, key) => {
+ return : null}
)
}
diff --git a/src/core/components/responses.jsx b/src/core/components/responses.jsx
index b0dfc4f7..1c00ff1a 100644
--- a/src/core/components/responses.jsx
+++ b/src/core/components/responses.jsx
@@ -42,13 +42,13 @@ export default class Responses extends React.Component {
- layoutActions.show(isShownKey, !showTag)} className={!tagDescription ? "opblock-tag no-desc" : "opblock-tag" }>
- {tag}
+
- layoutActions.show(isShownKey, !showTag)} className={!tagDescription ? "opblock-tag no-desc" : "opblock-tag" }>
- {tag}
+ layoutActions.show(isShownKey, !showTag)}
+ className={!tagDescription ? "opblock-tag no-desc" : "opblock-tag" }
+ id={isShownKey.join("-")}>
+ e.preventDefault()}
+ href={ isDeepLinkingEnabled ? `#/${tag}` : ""}>
+ {tag}
+
{ !tagDescription ? null :
{ tagDescription }
}
+
+ { !tagExternalDocsDescription ? null :
+
+ { tagExternalDocsDescription }
+ { tagExternalDocsUrl ? ": " : null }
+ { tagExternalDocsUrl ?
+ e.stopPropagation()}
+ target={"_blank"}
+ >{tagExternalDocsUrl} : null
+ }
+
+ }
+
+
+ { !tagExternalDocsDescription ? null :
+
+ { tagExternalDocsDescription }
+ { tagExternalDocsUrl ? ": " : null }
+ { tagExternalDocsUrl ?
+ e.stopPropagation()}
+ target={"_blank"}
+ >{tagExternalDocsUrl} : null
+ }
+
+ }
+
+
{ param.get("type") } { itemType && `[${itemType}]` }
+ { param.get("type") } { itemType && `[${itemType}]` }
({ param.get("in") })
diff --git a/src/core/components/parameters.jsx b/src/core/components/parameters.jsx
index b85cc8ab..a6b981e6 100644
--- a/src/core/components/parameters.jsx
+++ b/src/core/components/parameters.jsx
@@ -72,7 +72,9 @@ export default class Parameters extends Component {
return (
-
{ key }: { String(v) }) + : null + } + { + !description ? null : +
xml: + { + xml.entrySeq().map( ( [ key, v ] ) =>
{key}: { String(v) }).toArray() + } + ): null + } + { + enumArray &&
+ bodyEl =
// Audio
} else if (/^audio\//i.test(contentType)) {
diff --git a/src/core/components/response.jsx b/src/core/components/response.jsx
index b63c8d7b..95602c64 100644
--- a/src/core/components/response.jsx
+++ b/src/core/components/response.jsx
@@ -1,6 +1,6 @@
import React from "react"
import PropTypes from "prop-types"
-import { fromJS } from "immutable"
+import { fromJS, Seq } from "immutable"
import { getSampleSchema } from "core/utils"
const getExampleComponent = ( sampleResponse, examples, HighlightCode ) => {
@@ -31,6 +31,13 @@ const getExampleComponent = ( sampleResponse, examples, HighlightCode ) => {
}
export default class Response extends React.Component {
+ constructor(props, context) {
+ super(props, context)
+
+ this.state = {
+ responseContentType: ""
+ }
+ }
static propTypes = {
code: PropTypes.string.isRequired,
@@ -59,16 +66,29 @@ export default class Response extends React.Component {
} = this.props
let { inferSchema } = fn
+ let { isOAS3 } = specSelectors
- let schema = inferSchema(response.toJS())
let headers = response.get("headers")
let examples = response.get("examples")
+ let links = response.get("links")
const Headers = getComponent("headers")
const HighlightCode = getComponent("highlightCode")
const ModelExample = getComponent("modelExample")
const Markdown = getComponent( "Markdown" )
+ const OperationLink = getComponent("operationLink")
+ const ContentType = getComponent("contentType")
- let sampleResponse = schema ? getSampleSchema(schema, contentType, { includeReadOnly: true }) : null
+ var sampleResponse
+ var schema
+
+ if(isOAS3()) {
+ let oas3SchemaForContentType = response.getIn(["content", this.state.responseContentType, "schema"])
+ sampleResponse = oas3SchemaForContentType ? getSampleSchema(oas3SchemaForContentType.toJS(), this.state.responseContentType, { includeReadOnly: true }) : null
+ schema = oas3SchemaForContentType ? inferSchema(oas3SchemaForContentType.toJS()) : null
+ } else {
+ schema = inferSchema(response.toJS())
+ sampleResponse = schema ? getSampleSchema(schema, contentType, { includeReadOnly: true }) : null
+ }
let example = getExampleComponent( sampleResponse, examples, HighlightCode )
return (
@@ -82,6 +102,12 @@ export default class Response extends React.Component {
+ { isOAS3 ? Parameters
+
+
{ allowTryItOut ? (
Parameters
+{ key }: { String(v) }) + : null + } + { + !description ? null : +
xml: + { + xml.entrySeq().map( ( [ key, v ] ) =>
{key}: { String(v) }).toArray() + } + ): null + } + { + enumArray &&
+
+}
+
+Markdown.propTypes = {
+ source: PropTypes.string.isRequired
+}
+
+export default Markdown
+
const sanitizeOptions = {
textFilter: function(text) {
return text
@@ -10,22 +32,6 @@ const sanitizeOptions = {
}
}
-function Markdown({ source }) {
- const sanitized = sanitize(source, sanitizeOptions)
-
- // sometimes the sanitizer returns "undefined" as a string
- if(!source || !sanitized || sanitized === "undefined") {
- return null
- }
-
- return Responses
- }
{
@@ -68,6 +68,7 @@ export default class Responses extends React.Component {
Code
Description
+ { specSelectors.isOAS3() ? Links : null }
diff --git a/src/core/components/schemes.jsx b/src/core/components/schemes.jsx
index 8be4180a..f9fe8f81 100644
--- a/src/core/components/schemes.jsx
+++ b/src/core/components/schemes.jsx
@@ -19,8 +19,9 @@ export default class Schemes extends React.Component {
}
componentWillReceiveProps(nextProps) {
- if ( this.props.operationScheme && !nextProps.schemes.has(this.props.operationScheme) ) {
- //fire 'change' event if our selected scheme is no longer an option
+ if ( !this.props.operationScheme || !nextProps.schemes.has(this.props.operationScheme) ) {
+ // if we don't have a selected operationScheme or if our selected scheme is no longer an option,
+ // then fire 'change' event and select the first scheme in the list of options
this.setScheme(nextProps.schemes.first())
}
}
diff --git a/src/core/components/version-stamp.jsx b/src/core/components/version-stamp.jsx
new file mode 100644
index 00000000..262cc023
--- /dev/null
+++ b/src/core/components/version-stamp.jsx
@@ -0,0 +1,12 @@
+import React from "react"
+import PropTypes from "prop-types"
+
+const VersionStamp = ({ version }) => {
+ return
{ version }
+}
+
+VersionStamp.propTypes = {
+ version: PropTypes.string.isRequired
+}
+
+export default VersionStamp
diff --git a/src/core/index.js b/src/core/index.js
index 80335da5..126cbc54 100644
--- a/src/core/index.js
+++ b/src/core/index.js
@@ -4,19 +4,21 @@ import System from "core/system"
import win from "core/window"
import ApisPreset from "core/presets/apis"
import * as AllPlugins from "core/plugins/all"
-import { parseSeach, filterConfigs } from "core/utils"
-
-const CONFIGS = [ "url", "urls", "urls.primaryName", "spec", "validatorUrl", "onComplete", "onFailure", "authorizations", "docExpansion",
- "apisSorter", "operationsSorter", "supportedSubmitMethods", "dom_id", "defaultModelRendering", "oauth2RedirectUrl",
- "showRequestHeaders", "custom", "modelPropertyMacro", "parameterMacro", "displayOperationId" , "displayRequestDuration"]
+import { parseSearch } from "core/utils"
// eslint-disable-next-line no-undef
-const { GIT_DIRTY, GIT_COMMIT, PACKAGE_VERSION } = buildInfo
+const { GIT_DIRTY, GIT_COMMIT, PACKAGE_VERSION, HOSTNAME, BUILD_TIME } = buildInfo
module.exports = function SwaggerUI(opts) {
win.versions = win.versions || {}
- win.versions.swaggerUi = `${PACKAGE_VERSION}/${GIT_COMMIT || "unknown"}${GIT_DIRTY ? "-dirty" : ""}`
+ win.versions.swaggerUi = {
+ version: PACKAGE_VERSION,
+ gitRevision: GIT_COMMIT,
+ gitDirty: GIT_DIRTY,
+ buildTimestamp: BUILD_TIME,
+ machine: HOSTNAME
+ }
const defaults = {
// Some general settings, that we floated to the top
@@ -26,15 +28,19 @@ module.exports = function SwaggerUI(opts) {
urls: null,
layout: "BaseLayout",
docExpansion: "list",
+ maxDisplayedTags: null,
+ filter: null,
validatorUrl: "https://online.swagger.io/validator",
configs: {},
custom: {},
displayOperationId: false,
displayRequestDuration: false,
+ deepLinking: false,
// Initial set of plugins ( TODO rename this, or refactor - we don't need presets _and_ plugins. Its just there for performance.
// Instead, we can compile the first plugin ( it can be a collection of plugins ), then batch the rest.
presets: [
+ ApisPreset
],
// Plugins; ( loaded after presets )
@@ -50,7 +56,9 @@ module.exports = function SwaggerUI(opts) {
store: { },
}
- const constructorConfig = deepExtend({}, defaults, opts)
+ let queryConfig = parseSearch()
+
+ const constructorConfig = deepExtend({}, defaults, opts, queryConfig)
const storeConfigs = deepExtend({}, constructorConfig.store, {
system: {
@@ -59,7 +67,8 @@ module.exports = function SwaggerUI(opts) {
plugins: constructorConfig.presets,
state: {
layout: {
- layout: constructorConfig.layout
+ layout: constructorConfig.layout,
+ filter: constructorConfig.filter
},
spec: {
spec: "",
@@ -80,7 +89,6 @@ module.exports = function SwaggerUI(opts) {
store.register([constructorConfig.plugins, inlinePlugin])
var system = store.getSystem()
- let queryConfig = parseSeach()
system.initOAuth = system.authActions.configureAuth
@@ -91,7 +99,7 @@ module.exports = function SwaggerUI(opts) {
let localConfig = system.specSelectors.getLocalConfig ? system.specSelectors.getLocalConfig() : {}
let mergedConfig = deepExtend({}, localConfig, constructorConfig, fetchedConfig || {}, queryConfig)
- store.setConfigs(filterConfigs(mergedConfig, CONFIGS))
+ store.setConfigs(mergedConfig)
if (fetchedConfig !== null) {
if (!queryConfig.url && typeof mergedConfig.spec === "object" && Object.keys(mergedConfig.spec).length) {
diff --git a/src/core/json-schema-components.js b/src/core/json-schema-components.js
index bf4ae514..a8d92023 100644
--- a/src/core/json-schema-components.js
+++ b/src/core/json-schema-components.js
@@ -57,7 +57,8 @@ export class JsonSchema_string extends Component {
if ( enumValue ) {
const Select = getComponent("Select")
- return ()
@@ -121,6 +122,7 @@ export class JsonSchema_array extends PureComponent {
render() {
let { getComponent, required, schema, fn } = this.props
+ let errors = schema.errors || []
let itemSchema = fn.inferSchema(schema.items)
const JsonSchemaForm = getComponent("JsonSchemaForm")
@@ -131,19 +133,17 @@ export class JsonSchema_array extends PureComponent {
if ( enumValue ) {
const Select = getComponent("Select")
- return ()
}
- let errors = schema.errors || []
-
return (
- { !value || value.count() < 1 ?
- (errors.length ? { errors[0] } : null) :
+ { !value || value.count() < 1 ? null :
value.map( (item,i) => {
let schema = Object.assign({}, itemSchema)
if ( errors.length ) {
@@ -153,12 +153,12 @@ export class JsonSchema_array extends PureComponent {
return (
this.onItemChange(val, i)} schema={schema} />
-
+
)
}).toArray()
}
-
+
)
}
@@ -170,12 +170,14 @@ export class JsonSchema_boolean extends Component {
onEnumChange = (val) => this.props.onChange(val)
render() {
- let { getComponent, required, value } = this.props
+ let { getComponent, value, schema } = this.props
+ let errors = schema.errors || []
const Select = getComponent("Select")
- return ()
}
}
diff --git a/src/core/oauth2-authorize.js b/src/core/oauth2-authorize.js
index 5d654318..2e36010e 100644
--- a/src/core/oauth2-authorize.js
+++ b/src/core/oauth2-authorize.js
@@ -68,11 +68,21 @@ export default function authorize ( { auth, authActions, errActions, configs, au
// pass action authorizeOauth2 and authentication data through window
// to authorize with oauth2
+
+ let callback
+ if (flow === "implicit") {
+ callback = authActions.preAuthorizeImplicit
+ } else if (authConfigs.useBasicAuthenticationWithAccessCodeGrant) {
+ callback = authActions.authorizeAccessCodeWithBasicAuthentication
+ } else {
+ callback = authActions.authorizeAccessCodeWithFormParams
+ }
+
win.swaggerUIRedirectOauth2 = {
auth: auth,
state: state,
redirectUrl: redirectUrl,
- callback: flow === "implicit" ? authActions.preAuthorizeImplicit : authActions.authorizeAccessCode,
+ callback: callback,
errCb: errActions.newAuthErr
}
diff --git a/src/core/path-translator.js b/src/core/path-translator.js
deleted file mode 100644
index 4d1ed27b..00000000
--- a/src/core/path-translator.js
+++ /dev/null
@@ -1,67 +0,0 @@
-import get from "lodash/get"
-
-export function transformPathToArray(property, jsSpec) {
- if(property.slice(0,9) === "instance.") {
- var str = property.slice(9)
- } else { // eslint-disable-next-line no-redeclare
- var str = property
- }
-
- var pathArr = []
-
- str
- .split(".")
- .map(item => {
- // "key[0]" becomes ["key", "0"]
- if(item.includes("[")) {
- let index = parseInt(item.match(/\[(.*)\]/)[1])
- let keyName = item.slice(0, item.indexOf("["))
- return [keyName, index.toString()]
- } else {
- return item
- }
- })
- .reduce(function(a, b) {
- // flatten!
- return a.concat(b)
- }, [])
- .concat([""]) // add an empty item into the array, so we don't get stuck with something in our buffer below
- .reduce((buffer, curr) => {
- let obj = pathArr.length ? get(jsSpec, pathArr) : jsSpec
-
- if(get(obj, makeAccessArray(buffer, curr))) {
- if(buffer.length) {
- pathArr.push(buffer)
- }
- if(curr.length) {
- pathArr.push(curr)
- }
- return ""
- } else {
- // attach key to buffer
- return `${buffer}${buffer.length ? "." : ""}${curr}`
- }
- }, "")
-
- if(typeof get(jsSpec, pathArr) !== "undefined") {
- return pathArr
- } else {
- // if our path is not correct (there is no value at the path),
- // return null
- return null
- }
-}
-
-function makeAccessArray(buffer, curr) {
- let arr = []
-
- if(buffer.length) {
- arr.push(buffer)
- }
-
- if(curr.length) {
- arr.push(curr)
- }
-
- return arr
-}
diff --git a/src/core/plugins/auth/actions.js b/src/core/plugins/auth/actions.js
index 221d80a8..e0939398 100644
--- a/src/core/plugins/auth/actions.js
+++ b/src/core/plugins/auth/actions.js
@@ -73,7 +73,7 @@ export const authorizePassword = ( auth ) => ( { authActions } ) => {
let { schema, name, username, password, passwordType, clientId, clientSecret } = auth
let form = {
grant_type: "password",
- scopes: encodeURIComponent(auth.scopes.join(scopeSeparator))
+ scope: encodeURIComponent(auth.scopes.join(scopeSeparator))
}
let query = {}
let headers = {}
@@ -111,7 +111,7 @@ export const authorizeApplication = ( auth ) => ( { authActions } ) => {
return authActions.authorizeRequest({body: buildFormData(form), name, url: schema.get("tokenUrl"), auth, headers })
}
-export const authorizeAccessCode = ( { auth, redirectUrl } ) => ( { authActions } ) => {
+export const authorizeAccessCodeWithFormParams = ( { auth, redirectUrl } ) => ( { authActions } ) => {
let { schema, name, clientId, clientSecret } = auth
let form = {
grant_type: "authorization_code",
@@ -124,6 +124,21 @@ export const authorizeAccessCode = ( { auth, redirectUrl } ) => ( { authActions
return authActions.authorizeRequest({body: buildFormData(form), name, url: schema.get("tokenUrl"), auth})
}
+export const authorizeAccessCodeWithBasicAuthentication = ( { auth, redirectUrl } ) => ( { authActions } ) => {
+ let { schema, name, clientId, clientSecret } = auth
+ let headers = {
+ Authorization: "Basic " + btoa(clientId + ":" + clientSecret)
+ }
+ let form = {
+ grant_type: "authorization_code",
+ code: auth.code,
+ client_id: clientId,
+ redirect_uri: redirectUrl
+ }
+
+ return authActions.authorizeRequest({body: buildFormData(form), name, url: schema.get("tokenUrl"), auth, headers})
+}
+
export const authorizeRequest = ( data ) => ( { fn, authActions, errActions, authSelectors } ) => {
let { body, query={}, headers={}, name, url, auth } = data
let { additionalQueryStringParams } = authSelectors.getConfigs() || {}
diff --git a/src/core/plugins/deep-linking/README.md b/src/core/plugins/deep-linking/README.md
new file mode 100644
index 00000000..5f417982
--- /dev/null
+++ b/src/core/plugins/deep-linking/README.md
@@ -0,0 +1 @@
+See `docs/deep-linking.md`.
diff --git a/src/core/plugins/deep-linking/helpers.js b/src/core/plugins/deep-linking/helpers.js
new file mode 100644
index 00000000..d06bbe27
--- /dev/null
+++ b/src/core/plugins/deep-linking/helpers.js
@@ -0,0 +1,7 @@
+export const setHash = (value) => {
+ if(value) {
+ return history.pushState(null, null, `#${value}`)
+ } else {
+ return window.location.hash = ""
+ }
+}
diff --git a/src/core/plugins/deep-linking/index.js b/src/core/plugins/deep-linking/index.js
new file mode 100644
index 00000000..8cec4dd5
--- /dev/null
+++ b/src/core/plugins/deep-linking/index.js
@@ -0,0 +1,18 @@
+// import reducers from "./reducers"
+// import * as actions from "./actions"
+// import * as selectors from "./selectors"
+import * as specWrapActions from "./spec-wrap-actions"
+import * as layoutWrapActions from "./layout-wrap-actions"
+
+export default function() {
+ return {
+ statePlugins: {
+ spec: {
+ wrapActions: specWrapActions
+ },
+ layout: {
+ wrapActions: layoutWrapActions
+ }
+ }
+ }
+}
diff --git a/src/core/plugins/deep-linking/layout-wrap-actions.js b/src/core/plugins/deep-linking/layout-wrap-actions.js
new file mode 100644
index 00000000..72d98948
--- /dev/null
+++ b/src/core/plugins/deep-linking/layout-wrap-actions.js
@@ -0,0 +1,36 @@
+import { setHash } from "./helpers"
+
+export const show = (ori, { getConfigs }) => (...args) => {
+ ori(...args)
+
+ const isDeepLinkingEnabled = getConfigs().deepLinking
+ if(!isDeepLinkingEnabled || isDeepLinkingEnabled === "false") {
+ return
+ }
+
+ try {
+ let [thing, shown] = args
+ let [type] = thing
+
+ if(type === "operations-tag" || type === "operations") {
+ if(!shown) {
+ return setHash("/")
+ }
+
+ if(type === "operations") {
+ let [, tag, operationId] = thing
+ setHash(`/${tag}/${operationId}`)
+ }
+
+ if(type === "operations-tag") {
+ let [, tag] = thing
+ setHash(`/${tag}`)
+ }
+ }
+
+ } catch(e) {
+ // This functionality is not mission critical, so if something goes wrong
+ // we'll just move on
+ console.error(e)
+ }
+}
diff --git a/src/core/plugins/deep-linking/spec-wrap-actions.js b/src/core/plugins/deep-linking/spec-wrap-actions.js
new file mode 100644
index 00000000..bb13a6ff
--- /dev/null
+++ b/src/core/plugins/deep-linking/spec-wrap-actions.js
@@ -0,0 +1,51 @@
+import scrollTo from "scroll-to-element"
+
+const SCROLL_OFFSET = -5
+let hasHashBeenParsed = false
+
+
+export const updateResolved = (ori, { layoutActions, getConfigs }) => (...args) => {
+ ori(...args)
+
+ const isDeepLinkingEnabled = getConfigs().deepLinking
+ if(!isDeepLinkingEnabled || isDeepLinkingEnabled === "false") {
+ return
+ }
+
+ if(window.location.hash && !hasHashBeenParsed ) {
+ let hash = window.location.hash.slice(1) // # is first character
+
+ if(hash[0] === "!") {
+ // Parse UI 2.x shebangs
+ hash = hash.slice(1)
+ }
+
+ if(hash[0] === "/") {
+ // "/pet/addPet" => "pet/addPet"
+ // makes the split result cleaner
+ // also handles forgotten leading slash
+ hash = hash.slice(1)
+ }
+
+ let [tag, operationId] = hash.split("/")
+
+ if(tag && operationId) {
+ // Pre-expand and scroll to the operation
+ layoutActions.show(["operations-tag", tag], true)
+ layoutActions.show(["operations", tag, operationId], true)
+
+ scrollTo(`#operations-${tag}-${operationId}`, {
+ offset: SCROLL_OFFSET
+ })
+ } else if(tag) {
+ // Pre-expand and scroll to the tag
+ layoutActions.show(["operations-tag", tag], true)
+
+ scrollTo(`#operations-tag-${tag}`, {
+ offset: SCROLL_OFFSET
+ })
+ }
+ }
+
+ hasHashBeenParsed = true
+}
diff --git a/src/core/plugins/layout/actions.js b/src/core/plugins/layout/actions.js
index b8cba718..d65d34e3 100644
--- a/src/core/plugins/layout/actions.js
+++ b/src/core/plugins/layout/actions.js
@@ -1,6 +1,7 @@
import { normalizeArray } from "core/utils"
export const UPDATE_LAYOUT = "layout_update_layout"
+export const UPDATE_FILTER = "layout_update_filter"
export const UPDATE_MODE = "layout_update_mode"
export const SHOW = "layout_show"
@@ -13,6 +14,13 @@ export function updateLayout(layout) {
}
}
+export function updateFilter(filter) {
+ return {
+ type: UPDATE_FILTER,
+ payload: filter
+ }
+}
+
export function show(thing, shown=true) {
thing = normalizeArray(thing)
return {
diff --git a/src/core/plugins/layout/reducers.js b/src/core/plugins/layout/reducers.js
index 44e3c480..4b561015 100644
--- a/src/core/plugins/layout/reducers.js
+++ b/src/core/plugins/layout/reducers.js
@@ -1,5 +1,6 @@
import {
UPDATE_LAYOUT,
+ UPDATE_FILTER,
UPDATE_MODE,
SHOW
} from "./actions"
@@ -8,6 +9,8 @@ export default {
[UPDATE_LAYOUT]: (state, action) => state.set("layout", action.payload),
+ [UPDATE_FILTER]: (state, action) => state.set("filter", action.payload),
+
[SHOW]: (state, action) => {
let thing = action.payload.thing
let shown = action.payload.shown
diff --git a/src/core/plugins/layout/selectors.js b/src/core/plugins/layout/selectors.js
index 0eb0c522..42a3bcbb 100644
--- a/src/core/plugins/layout/selectors.js
+++ b/src/core/plugins/layout/selectors.js
@@ -5,6 +5,8 @@ const state = state => state
export const current = state => state.get("layout")
+export const currentFilter = state => state.get("filter")
+
export const isShown = (state, thing, def) => {
thing = normalizeArray(thing)
return Boolean(state.getIn(["shown", ...thing], def))
diff --git a/src/core/plugins/oas3/components/callbacks.jsx b/src/core/plugins/oas3/components/callbacks.jsx
new file mode 100644
index 00000000..9290c6fe
--- /dev/null
+++ b/src/core/plugins/oas3/components/callbacks.jsx
@@ -0,0 +1,49 @@
+import React from "react"
+import PropTypes from "prop-types"
+
+const Callbacks = (props) => {
+ let { callbacks, getComponent } = props
+ // const Markdown = getComponent("Markdown")
+ const Operation = getComponent("operation", true)
+
+ if(!callbacks) {
+ return No callbacks
+ }
+
+ let callbackElements = callbacks.map((callback, callbackName) => {
+ return
+
+ // return {callbackName}
+ { callback.map((pathItem, pathItemName) => { + return
+ { pathItem.map((operation, method) => {
+ return
+ }) }
+ {JSON.stringify(operation)}
+ }) }
+
+ // }
+ //
+ })
+ return {name}
+ // {callback.description &&{JSON.stringify(callback)}
+ //
+ {callbackElements}
+
+}
+
+Callbacks.propTypes = {
+ getComponent: PropTypes.func.isRequired,
+ callbacks: PropTypes.array.isRequired
+
+}
+
+export default Callbacks
diff --git a/src/core/plugins/oas3/components/index.js b/src/core/plugins/oas3/components/index.js
new file mode 100644
index 00000000..8186ce8e
--- /dev/null
+++ b/src/core/plugins/oas3/components/index.js
@@ -0,0 +1,9 @@
+import Callbacks from "./callbacks"
+import RequestBody from "./request-body"
+import OperationLink from "./operation-link.jsx"
+
+export default {
+ Callbacks,
+ RequestBody,
+ operationLink: OperationLink
+}
diff --git a/src/core/plugins/oas3/components/operation-link.jsx b/src/core/plugins/oas3/components/operation-link.jsx
new file mode 100644
index 00000000..6f9eef0a
--- /dev/null
+++ b/src/core/plugins/oas3/components/operation-link.jsx
@@ -0,0 +1,37 @@
+import React, { Component } from "react"
+import PropTypes from "prop-types"
+import ImPropTypes from "react-immutable-proptypes"
+
+class OperationLink extends Component {
+ render() {
+ const { link, name } = this.props
+
+ let targetOp = link.get("operationId") || link.get("operationRef")
+ let parameters = link.get("parameters") && link.get("parameters").toJS()
+ let description = link.get("description")
+
+ return
+ {name}{description ? `: ${description}` : ""}
+
+ Operation `{targetOp}`
+ Parameters {padString(0, JSON.stringify(parameters, null, 2)) || "{}"}
+
+
+ }
+
+}
+
+function padString(n, string) {
+ if(typeof string !== "string") { return "" }
+ return string
+ .split("\n")
+ .map((line, i) => i > 0 ? Array(n + 1).join(" ") + line : line)
+ .join("\n")
+}
+
+OperationLink.propTypes = {
+ link: ImPropTypes.orderedMap.isRequired,
+ name: PropTypes.String
+}
+
+export default OperationLink
diff --git a/src/core/plugins/oas3/components/request-body.jsx b/src/core/plugins/oas3/components/request-body.jsx
new file mode 100644
index 00000000..cce3b9f3
--- /dev/null
+++ b/src/core/plugins/oas3/components/request-body.jsx
@@ -0,0 +1,42 @@
+import React from "react"
+import PropTypes from "prop-types"
+import ImPropTypes from "react-immutable-proptypes"
+import { OrderedMap } from "immutable"
+import { getSampleSchema } from "core/utils"
+
+
+const RequestBody = ({ requestBody, getComponent, specSelectors, contentType }) => {
+ const Markdown = getComponent("Markdown")
+ const ModelExample = getComponent("modelExample")
+ const HighlightCode = getComponent("highlightCode")
+
+ const requestBodyDescription = (requestBody && requestBody.get("description")) || null
+ const requestBodyContent = (requestBody && requestBody.get("content")) || new OrderedMap()
+ contentType = contentType || requestBodyContent.keySeq().first()
+
+ const mediaTypeValue = requestBodyContent.get(contentType)
+
+ const sampleSchema = getSampleSchema(mediaTypeValue.get("schema").toJS(), contentType)
+
+ return
+ { requestBodyDescription &&
+
+}
+
+RequestBody.propTypes = {
+ requestBody: ImPropTypes.orderedMap.isRequired,
+ getComponent: PropTypes.func.isRequired,
+ specSelectors: PropTypes.object.isRequired,
+ contentType: PropTypes.string.isRequired
+}
+
+export default RequestBody
diff --git a/src/core/plugins/oas3/helpers.js b/src/core/plugins/oas3/helpers.js
new file mode 100644
index 00000000..08fdc0fd
--- /dev/null
+++ b/src/core/plugins/oas3/helpers.js
@@ -0,0 +1,36 @@
+import React from "react"
+
+export function isOAS3(jsSpec) {
+ const oasVersion = jsSpec.get("openapi")
+ if(!oasVersion) {
+ return false
+ }
+
+ return oasVersion.startsWith("3.0.0")
+}
+
+export function isSwagger2(jsSpec) {
+ const swaggerVersion = jsSpec.get("swagger")
+ if(!swaggerVersion) {
+ return false
+ }
+
+ return swaggerVersion.startsWith("2")
+}
+
+export function OAS3ComponentWrapFactory(Component) {
+ return (Ori, system) => (props) => {
+ if(system && system.specSelectors && system.specSelectors.specJson) {
+ const spec = system.specSelectors.specJson()
+
+ if(isOAS3(spec)) {
+ return
+ {message}
+
+ }
+}
+
+export default OAS3ComponentWrapFactory(ModelComponent)
diff --git a/src/core/plugins/oas3/wrap-components/online-validator-badge.js b/src/core/plugins/oas3/wrap-components/online-validator-badge.js
new file mode 100644
index 00000000..e893abb6
--- /dev/null
+++ b/src/core/plugins/oas3/wrap-components/online-validator-badge.js
@@ -0,0 +1,5 @@
+import { OAS3ComponentWrapFactory } from "../helpers"
+
+// We're disabling the Online Validator Badge until the online validator
+// can handle OAS3 specs.
+export default OAS3ComponentWrapFactory(() => null)
diff --git a/src/core/plugins/oas3/wrap-components/parameters.jsx b/src/core/plugins/oas3/wrap-components/parameters.jsx
new file mode 100644
index 00000000..e735085e
--- /dev/null
+++ b/src/core/plugins/oas3/wrap-components/parameters.jsx
@@ -0,0 +1,181 @@
+import React, { Component } from "react"
+import PropTypes from "prop-types"
+import Im, { Map } from "immutable"
+import ImPropTypes from "react-immutable-proptypes"
+import { OAS3ComponentWrapFactory } from "../helpers"
+
+// More readable, just iterate over maps, only
+const eachMap = (iterable, fn) => iterable.valueSeq().filter(Im.Map.isMap).map(fn)
+
+class Parameters extends Component {
+
+ constructor(props) {
+ super(props)
+ this.state = {
+ callbackVisible: false,
+ parametersVisible: true,
+ requestBodyContentType: ""
+ }
+ }
+
+ static propTypes = {
+ parameters: ImPropTypes.list.isRequired,
+ specActions: PropTypes.object.isRequired,
+ operation: PropTypes.object.isRequired,
+ getComponent: PropTypes.func.isRequired,
+ specSelectors: PropTypes.object.isRequired,
+ fn: PropTypes.object.isRequired,
+ tryItOutEnabled: PropTypes.bool,
+ allowTryItOut: PropTypes.bool,
+ onTryoutClick: PropTypes.func,
+ onCancelClick: PropTypes.func,
+ onChangeKey: PropTypes.array,
+ pathMethod: PropTypes.array.isRequired
+ }
+
+
+ static defaultProps = {
+ onTryoutClick: Function.prototype,
+ onCancelClick: Function.prototype,
+ tryItOutEnabled: false,
+ allowTryItOut: true,
+ onChangeKey: [],
+ }
+
+ onChange = ( param, value, isXml ) => {
+ let {
+ specActions: { changeParam },
+ onChangeKey,
+ } = this.props
+
+ changeParam( onChangeKey, param.get("name"), value, isXml)
+ }
+
+ onChangeConsumesWrapper = ( val ) => {
+ let {
+ specActions: { changeConsumesValue },
+ onChangeKey
+ } = this.props
+
+ changeConsumesValue(onChangeKey, val)
+ }
+
+ toggleTab = (tab) => {
+ if(tab === "parameters"){
+ return this.setState({
+ parametersVisible: true,
+ callbackVisible: false
+ })
+ }else if(tab === "callbacks"){
+ return this.setState({
+ callbackVisible: true,
+ parametersVisible: false
+ })
+ }
+ }
+
+ render(){
+
+ let {
+ onTryoutClick,
+ onCancelClick,
+ parameters,
+ allowTryItOut,
+ tryItOutEnabled,
+
+ fn,
+ getComponent,
+ specSelectors,
+ pathMethod,
+ operation
+ } = this.props
+
+ const ParameterRow = getComponent("parameterRow")
+ const TryItOutButton = getComponent("TryItOutButton")
+ const ContentType = getComponent("contentType")
+ const Callbacks = getComponent("Callbacks", true)
+ const RequestBody = getComponent("RequestBody", true)
+
+ const isExecute = tryItOutEnabled && allowTryItOut
+ const { isOAS3 } = specSelectors
+
+ const requestBody = operation.get("requestBody")
+ return (
+
+
+ )
+ }
+}
+
+
+export default OAS3ComponentWrapFactory(Parameters)
diff --git a/src/core/plugins/oas3/wrap-components/try-it-out-button.jsx b/src/core/plugins/oas3/wrap-components/try-it-out-button.jsx
new file mode 100644
index 00000000..61b9771d
--- /dev/null
+++ b/src/core/plugins/oas3/wrap-components/try-it-out-button.jsx
@@ -0,0 +1,5 @@
+import { OAS3ComponentWrapFactory } from "../helpers"
+
+export default OAS3ComponentWrapFactory(() => {
+ return null
+})
diff --git a/src/core/plugins/oas3/wrap-components/version-stamp.jsx b/src/core/plugins/oas3/wrap-components/version-stamp.jsx
new file mode 100644
index 00000000..616fc958
--- /dev/null
+++ b/src/core/plugins/oas3/wrap-components/version-stamp.jsx
@@ -0,0 +1,13 @@
+import React from "react"
+import { OAS3ComponentWrapFactory } from "../helpers"
+
+export default OAS3ComponentWrapFactory((props) => {
+ const { Ori } = props
+
+ return
+
+
+ {this.state.parametersVisible ?
+
+ { allowTryItOut ? (
+ this.toggleTab("parameters")} className={`tab-item ${this.state.parametersVisible && "active"}`}>
+
+ { operation.get("callbacks") ?
+ (
+ Parameters
+ this.toggleTab("callbacks")} className={`tab-item ${this.state.callbackVisible && "active"}`}>
+
+ ) : null
+ }
+ Callbacks
+
+ { !parameters.count() ? :
+
: "" }
+
+ {this.state.callbackVisible ? No parameters
+
+
+
+
+ }
+ | Name | +Description | +
|---|
+
: "" }
+ {
+ isOAS3() && requestBody && this.state.parametersVisible &&
+
+
+ }
+
+
+ Request body
+ +
+
+
+ OAS3+ + +}) diff --git a/src/core/plugins/oas3/wrap-selectors.js b/src/core/plugins/oas3/wrap-selectors.js new file mode 100644 index 00000000..694e456b --- /dev/null +++ b/src/core/plugins/oas3/wrap-selectors.js @@ -0,0 +1,67 @@ +import { createSelector } from "reselect" +import { Map } from "immutable" +import { isOAS3 as isOAS3Helper, isSwagger2 as isSwagger2Helper } from "./helpers" + + +// Helpers + +function onlyOAS3(selector) { + return (ori, system) => (...args) => { + const spec = system.getSystem().specSelectors.specJson() + if(isOAS3Helper(spec)) { + return selector(...args) + } else { + return ori(...args) + } + } +} + +const state = state => { + return state || Map() +} + +const nullSelector = createSelector(() => null) + +const OAS3NullSelector = onlyOAS3(nullSelector) + +const specJson = createSelector( + state, + spec => spec.get("json", Map()) +) + +const specResolved = createSelector( + state, + spec => spec.get("resolved", Map()) +) + +const spec = state => { + let res = specResolved(state) + if(res.count() < 1) + res = specJson(state) + return res +} + +// Wrappers + +export const definitions = onlyOAS3(createSelector( + spec, + spec => spec.getIn(["components", "schemas"]) || Map() +)) + +export const host = OAS3NullSelector +export const basePath = OAS3NullSelector +export const consumes = OAS3NullSelector +export const produces = OAS3NullSelector +export const schemes = OAS3NullSelector + +// New selectors + +export const isOAS3 = (ori, system) => () => { + const spec = system.getSystem().specSelectors.specJson() + return isOAS3Helper(spec) +} + +export const isSwagger2 = (ori, system) => () => { + const spec = system.getSystem().specSelectors.specJson() + return isSwagger2Helper(spec) +} diff --git a/src/core/plugins/spec/selectors.js b/src/core/plugins/spec/selectors.js index a4f94349..fbc12764 100644 --- a/src/core/plugins/spec/selectors.js +++ b/src/core/plugins/spec/selectors.js @@ -46,6 +46,15 @@ export const spec = state => { return res } +export const isOAS3 = createSelector( + // isOAS3 is stubbed out here to work around an issue with injecting more selectors + // in the OAS3 plugin, and to ensure that the function is always available. + // It's not perfect, but our hybrid (core+plugin code) implementation for OAS3 + // needs this. //KS + spec, + () => false +) + export const info = createSelector( spec, spec => returnSelfOrNewMap(spec && spec.get("info")) @@ -200,15 +209,22 @@ export const operationsWithTags = createSelector( } ) -export const taggedOperations = ( state ) =>( { getConfigs } ) => { - let { operationsSorter }= getConfigs() +export const taggedOperations = (state) => ({ getConfigs }) => { + let { tagsSorter, operationsSorter } = getConfigs() + return operationsWithTags(state) + .sortBy( + (val, key) => key, // get the name of the tag to be passed to the sorter + (tagA, tagB) => { + let sortFn = (typeof tagsSorter === "function" ? tagsSorter : sorters.tagsSorter[ tagsSorter ]) + return (!sortFn ? null : sortFn(tagA, tagB)) + } + ) + .map((ops, tag) => { + let sortFn = (typeof operationsSorter === "function" ? operationsSorter : sorters.operationsSorter[ operationsSorter ]) + let operations = (!sortFn ? ops : ops.sort(sortFn)) - return operationsWithTags(state).map((ops, tag) => { - let sortFn = typeof operationsSorter === "function" ? operationsSorter - : sorters.operationsSorter[operationsSorter] - let operations = !sortFn ? ops : ops.sort(sortFn) - - return Map({tagDetails: tagDetails(state, tag), operations: operations})}) + return Map({ tagDetails: tagDetails(state, tag), operations: operations }) + }) } export const responses = createSelector( @@ -277,12 +293,13 @@ export function parametersIncludeType(parameters, typeValue="") { export function contentTypeValues(state, pathMethod) { let op = spec(state).getIn(["paths", ...pathMethod], fromJS({})) const parameters = op.get("parameters") || new List() - const requestContentType = ( - parametersIncludeType(parameters, "file") ? "multipart/form-data" - : parametersIncludeIn(parameters, "formData") ? "application/x-www-form-urlencoded" - : op.get("consumes_value") - ) + const requestContentType = ( + op.get("consumes_value") ? op.get("consumes_value") + : parametersIncludeType(parameters, "file") ? "multipart/form-data" + : parametersIncludeType(parameters, "formData") ? "application/x-www-form-urlencoded" + : undefined + ) return fromJS({ requestContentType, diff --git a/src/core/plugins/split-pane-mode/components/split-pane-mode.jsx b/src/core/plugins/split-pane-mode/components/split-pane-mode.jsx index 73f2acbc..c1a8fa9c 100644 --- a/src/core/plugins/split-pane-mode/components/split-pane-mode.jsx +++ b/src/core/plugins/split-pane-mode/components/split-pane-mode.jsx @@ -1,7 +1,6 @@ import React from "react" import PropTypes from "prop-types" import SplitPane from "react-split-pane" -import "./split-pane-mode.less" const MODE_KEY = ["split-pane-mode"] const MODE_LEFT = "left" diff --git a/src/core/plugins/split-pane-mode/components/split-pane-mode.less b/src/core/plugins/split-pane-mode/components/split-pane-mode.less deleted file mode 100644 index d5437b37..00000000 --- a/src/core/plugins/split-pane-mode/components/split-pane-mode.less +++ /dev/null @@ -1,5 +0,0 @@ -.swagger-ui { - .Resizer.vertical.disabled { - display: none; - } -} diff --git a/src/core/plugins/util/index.js b/src/core/plugins/util/index.js index 57e163f4..033288a6 100644 --- a/src/core/plugins/util/index.js +++ b/src/core/plugins/util/index.js @@ -1,8 +1,7 @@ import { shallowEqualKeys } from "core/utils" -import { transformPathToArray } from "core/path-translator" export default function() { return { - fn: { shallowEqualKeys, transformPathToArray } + fn: { shallowEqualKeys } } } diff --git a/src/core/presets/apis.js b/src/core/presets/apis.js index 3d4b5961..14afc627 100644 --- a/src/core/presets/apis.js +++ b/src/core/presets/apis.js @@ -1,4 +1,5 @@ import BasePreset from "./base" +import OAS3Plugin from "../plugins/oas3" // Just the base, for now. @@ -6,5 +7,6 @@ export default function PresetApis() { return [ BasePreset, + OAS3Plugin ] } diff --git a/src/core/presets/base.js b/src/core/presets/base.js index 20ff4659..10a12645 100644 --- a/src/core/presets/base.js +++ b/src/core/presets/base.js @@ -10,6 +10,7 @@ import auth from "core/plugins/auth" import util from "core/plugins/util" import SplitPaneModePlugin from "core/plugins/split-pane-mode" import downloadUrlPlugin from "core/plugins/download-url" +import deepLinkingPlugin from "core/plugins/deep-linking" import App from "core/components/app" import AuthorizationPopup from "core/components/auth/authorization-popup" @@ -41,10 +42,17 @@ import Footer from "core/components/footer" import ParamBody from "core/components/param-body" import Curl from "core/components/curl" import Schemes from "core/components/schemes" +import ModelCollapse from "core/components/model-collapse" import ModelExample from "core/components/model-example" +import ModelWrapper from "core/components/model-wrapper" import Model from "core/components/model" import Models from "core/components/models" +import EnumModel from "core/components/enum-model" +import ObjectModel from "core/components/object-model" +import ArrayModel from "core/components/array-model" +import PrimitiveModel from "core/components/primitive-model" import TryItOutButton from "core/components/try-it-out-button" +import VersionStamp from "core/components/version-stamp" import Markdown from "core/components/providers/markdown" @@ -88,11 +96,18 @@ export default function() { curl: Curl, schemes: Schemes, modelExample: ModelExample, - model: Model, - models: Models, + ModelWrapper, + ModelCollapse, + Model, + Models, + EnumModel, + ObjectModel, + ArrayModel, + PrimitiveModel, TryItOutButton, Markdown, - BaseLayout + BaseLayout, + VersionStamp } } @@ -119,6 +134,7 @@ export default function() { auth, ast, SplitPaneModePlugin, - downloadUrlPlugin + downloadUrlPlugin, + deepLinkingPlugin ] } diff --git a/src/core/system.js b/src/core/system.js index 24c7523a..e4eee5b8 100644 --- a/src/core/system.js +++ b/src/core/system.js @@ -76,7 +76,7 @@ export default class Store { this.boundSystem = Object.assign({}, this.getRootInjects(), this.getWrappedAndBoundActions(dispatch), - this.getBoundSelectors(getState, this.getSystem), + this.getWrappedAndBoundSelectors(getState, this.getSystem), this.getStateThunks(getState), this.getFn(), this.getConfigs() @@ -176,6 +176,36 @@ export default class Store { }) } + getWrappedAndBoundSelectors(getState, getSystem) { + let selectorGroups = this.getBoundSelectors(getState, getSystem) + return objMap(selectorGroups, (selectors, selectorGroupName) => { + let stateName = [selectorGroupName.slice(0, -9)] // selectors = 9 chars + let wrappers = this.system.statePlugins[stateName].wrapSelectors + if(wrappers) { + return objMap(selectors, (selector, selectorName) => { + let wrap = wrappers[selectorName] + if(!wrap) { + return selector + } + + if(!Array.isArray(wrap)) { + wrap = [wrap] + } + return wrap.reduce((acc, fn) => { + let wrappedSelector = (...args) => { + return fn(acc, this.getSystem())(getState().getIn(stateName), ...args) + } + if(!isFn(wrappedSelector)) { + throw new TypeError("wrapSelector needs to return a function that returns a new function (ie the wrapped action)") + } + return wrappedSelector + }, selector || Function.prototype) + }) + } + return selectors + }) + } + getStates(state) { return Object.keys(this.system.statePlugins).reduce((obj, key) => { obj[key] = state.get(key) @@ -197,8 +227,17 @@ export default class Store { } getComponents(component) { - if(typeof component !== "undefined") + const res = this.system.components[component] + + if(Array.isArray(res)) { + return res.reduce((ori, wrapper) => { + return wrapper(ori, this.getSystem()) + }) + } + if(typeof component !== "undefined") { return this.system.components[component] + } + return this.system.components } @@ -291,6 +330,24 @@ function systemExtend(dest={}, src={}) { return dest } + // Wrap components + // Parses existing components in the system, and prepares them for wrapping via getComponents + if(src.wrapComponents) { + objMap(src.wrapComponents, (wrapperFn, key) => { + const ori = dest.components[key] + if(ori && Array.isArray(ori)) { + dest.components[key] = ori.concat([wrapperFn]) + } else if(ori) { + dest.components[key] = [ori, wrapperFn] + } else { + dest.components[key] = null + } + }) + + delete src.wrapComponents + } + + // Account for wrapActions, make it an array and append to it // Modifies `src` // 80% of this code is just safe traversal. We need to address that ( ie: use a lib ) diff --git a/src/core/utils.js b/src/core/utils.js index caaa88cc..9a04329e 100644 --- a/src/core/utils.js +++ b/src/core/utils.js @@ -41,7 +41,7 @@ export function fromJSOrdered (js) { return !isObject(js) ? js : Array.isArray(js) ? Im.Seq(js).map(fromJSOrdered).toList() : - Im.Seq(js).map(fromJSOrdered).toOrderedMap() + Im.OrderedMap(js).map(fromJSOrdered) } export function bindToState(obj, state) { @@ -228,13 +228,13 @@ export function highlight (el) { var reset = function(el) { var text = el.textContent, - pos = 0, // current position + pos = 0, // current position next1 = text[0], // next character - chr = 1, // current character - prev1, // previous character - prev2, // the one before the previous - token = // current token content - el.innerHTML = "", // (and cleaning the node) + chr = 1, // current character + prev1, // previous character + prev2, // the one before the previous + token = // current token content + el.innerHTML = "", // (and cleaning the node) // current token type: // 0: anything else (whitespaces / newlines) @@ -274,11 +274,11 @@ export function highlight (el) { (tokenType > 8 && chr == "\n") || [ // finalize conditions for other token types // 0: whitespaces - /\S/[test](chr), // merged together + /\S/[test](chr), // merged together // 1: operators - 1, // consist of a single character + 1, // consist of a single character // 2: braces - 1, // consist of a single character + 1, // consist of a single character // 3: (key)word !/[$\w]/[test](chr), // 4: regex @@ -341,12 +341,12 @@ export function highlight (el) { // condition) tokenType = 11 while (![ - 1, // 0: whitespace + 1, // 0: whitespace // 1: operator or braces - /[\/{}[(\-+*=<>:;|\\.,?!&@~]/[test](chr), // eslint-disable-line no-useless-escape - /[\])]/[test](chr), // 2: closing brace - /[$\w]/[test](chr), // 3: (key)word - chr == "/" && // 4: regex + /[\/{}[(\-+*=<>:;|\\.,?!&@~]/[test](chr), // eslint-disable-line no-useless-escape + /[\])]/[test](chr), // 2: closing brace + /[$\w]/[test](chr), // 3: (key)word + chr == "/" && // 4: regex // previous token was an // opening brace or an // operator (otherwise @@ -355,13 +355,13 @@ export function highlight (el) { // workaround for xml // closing tags prev1 != "<", - chr == "\"", // 5: string with " - chr == "'", // 6: string with ' + chr == "\"", // 5: string with " + chr == "'", // 6: string with ' // 7: xml comment chr+next1+text[pos+1]+text[pos+2] == "