@redocly/reference-docs 2.15.1 → 2.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cli/commands/redocly-docs-cli.min.js +63 -56
- package/bin/cli/commands/redocly-docs-cli.min.js.LICENSE.txt +1 -1
- package/dist/console.redocly-reference-docs.min.js +1 -1
- package/dist/oauth2-redirect.js +1 -1
- package/dist/redocly-reference-docs.min.js +592 -585
- package/lib/components/Endpoint/Endpoint.js +1 -1
- package/lib/components/NextSectionButton.js +1 -1
- package/lib/redoc-lib/src/common-elements/fields.d.ts +1 -0
- package/lib/redoc-lib/src/common-elements/fields.js +1 -1
- package/lib/redoc-lib/src/components/ContentItems/ContentItems.js +1 -1
- package/lib/redoc-lib/src/components/Fields/Field.d.ts +1 -0
- package/lib/redoc-lib/src/components/Fields/Field.js +1 -1
- package/lib/redoc-lib/src/components/Fields/FieldDetails.js +1 -1
- package/lib/redoc-lib/src/components/Schema/ObjectSchema.d.ts +2 -7
- package/lib/redoc-lib/src/components/Schema/ObjectSchema.js +1 -1
- package/lib/redoc-lib/src/components/Schema/types.d.ts +1 -0
- package/lib/redoc-lib/src/components/SchemaDefinition/SchemaDefinition.js +1 -1
- package/lib/redoc-lib/src/components/SideMenu/MenuItem.js +1 -1
- package/lib/redoc-lib/src/components/SideMenu/styled.elements.d.ts +1 -1
- package/lib/redoc-lib/src/components/SideMenu/styled.elements.js +1 -1
- package/lib/redoc-lib/src/components/helper.d.ts +2 -0
- package/lib/redoc-lib/src/components/helper.js +1 -1
- package/lib/redoc-lib/src/services/MenuBuilder.d.ts +16 -1
- package/lib/redoc-lib/src/services/MenuBuilder.js +1 -1
- package/lib/redoc-lib/src/services/MenuStore.d.ts +2 -1
- package/lib/redoc-lib/src/services/OpenAPIParser.d.ts +2 -2
- package/lib/redoc-lib/src/services/OpenAPIParser.js +1 -1
- package/lib/redoc-lib/src/services/RedocNormalizedOptions.d.ts +4 -0
- package/lib/redoc-lib/src/services/RedocNormalizedOptions.js +1 -1
- package/lib/redoc-lib/src/services/models/Group.model.d.ts +1 -0
- package/lib/redoc-lib/src/services/models/Group.model.js +1 -1
- package/lib/redoc-lib/src/services/models/Operation.d.ts +1 -0
- package/lib/redoc-lib/src/services/models/Operation.js +1 -1
- package/lib/redoc-lib/src/types/open-api.d.ts +7 -0
- package/lib/redoc-lib/src/utils/openapi.js +1 -1
- package/lib/services/ProMenu.js +1 -1
- package/lib/services/ProStore.d.ts +3 -1
- package/lib/services/ProStore.js +1 -1
- package/lib-esm/components/Endpoint/Endpoint.js +1 -1
- package/lib-esm/components/NextSectionButton.js +1 -1
- package/lib-esm/redoc-lib/src/common-elements/fields.d.ts +1 -0
- package/lib-esm/redoc-lib/src/common-elements/fields.js +1 -1
- package/lib-esm/redoc-lib/src/components/ContentItems/ContentItems.js +1 -1
- package/lib-esm/redoc-lib/src/components/Fields/Field.d.ts +1 -0
- package/lib-esm/redoc-lib/src/components/Fields/Field.js +1 -1
- package/lib-esm/redoc-lib/src/components/Fields/FieldDetails.js +1 -1
- package/lib-esm/redoc-lib/src/components/Schema/ObjectSchema.d.ts +2 -7
- package/lib-esm/redoc-lib/src/components/Schema/ObjectSchema.js +1 -1
- package/lib-esm/redoc-lib/src/components/Schema/types.d.ts +1 -0
- package/lib-esm/redoc-lib/src/components/SchemaDefinition/SchemaDefinition.js +1 -1
- package/lib-esm/redoc-lib/src/components/SideMenu/MenuItem.js +1 -1
- package/lib-esm/redoc-lib/src/components/SideMenu/styled.elements.d.ts +1 -1
- package/lib-esm/redoc-lib/src/components/SideMenu/styled.elements.js +1 -1
- package/lib-esm/redoc-lib/src/components/helper.d.ts +2 -0
- package/lib-esm/redoc-lib/src/components/helper.js +1 -1
- package/lib-esm/redoc-lib/src/services/MenuBuilder.d.ts +16 -1
- package/lib-esm/redoc-lib/src/services/MenuBuilder.js +1 -1
- package/lib-esm/redoc-lib/src/services/MenuStore.d.ts +2 -1
- package/lib-esm/redoc-lib/src/services/OpenAPIParser.d.ts +2 -2
- package/lib-esm/redoc-lib/src/services/OpenAPIParser.js +1 -1
- package/lib-esm/redoc-lib/src/services/RedocNormalizedOptions.d.ts +4 -0
- package/lib-esm/redoc-lib/src/services/RedocNormalizedOptions.js +1 -1
- package/lib-esm/redoc-lib/src/services/models/Group.model.d.ts +1 -0
- package/lib-esm/redoc-lib/src/services/models/Group.model.js +1 -1
- package/lib-esm/redoc-lib/src/services/models/Operation.d.ts +1 -0
- package/lib-esm/redoc-lib/src/services/models/Operation.js +1 -1
- package/lib-esm/redoc-lib/src/types/open-api.d.ts +7 -0
- package/lib-esm/redoc-lib/src/utils/openapi.js +1 -1
- package/lib-esm/services/ProMenu.js +1 -1
- package/lib-esm/services/ProStore.d.ts +3 -1
- package/lib-esm/services/ProStore.js +1 -1
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import
|
|
1
|
+
import*as React from"react";import{observer}from"mobx-react";import{PropertiesTable,PropertiesTableWrap,PropertiesTableCaption}from"../../common-elements/fields-layout";import{Field}from"../Fields/Field";import{DiscriminatorDropdown}from"./DiscriminatorDropdown";import{mapWithLast}from"../../utils";import{OptionsContext}from"../OptionsProvider";export var ObjectSchema=observer((function(e){var t=e.schema,r=t.fields,a=void 0===r?[]:r,i=t.title,n=e.showTitle,o=e.discriminator,l=e.level,s=e.skipWriteOnly,m=e.skipReadOnly,c=e.showAccessMode,p=React.useContext(OptionsContext),d=p.expandSingleSchemaField,u=p.showObjectSchemaExamples,h=p.schemaExpansionLevel,f=m||s?a.filter((function(e){return!(m&&e.schema.readOnly||s&&e.schema.writeOnly)})):a,v=d&&1===f.length||h>=l;return React.createElement(PropertiesTableWrap,null,React.createElement(PropertiesTable,null,n&&React.createElement(PropertiesTableCaption,null,i),React.createElement("tbody",null,mapWithLast(f,(function(e,t){return React.createElement(Field,{key:e.name,isLast:t,field:e,expandByDefault:v,renderDiscriminatorSwitch:(null==o?void 0:o.fieldName)===e.name&&function(){return React.createElement(React.Fragment,null,o.parentSchema?React.createElement(DiscriminatorDropdown,{parent:null==o?void 0:o.parentSchema,enumValues:e.schema.enum}):null)}||void 0,className:e.expanded?"expanded":void 0,showExamples:u,skipReadOnly:m,skipWriteOnly:s,showTitle:n,showAccessMode:c,level:l})})))))}));
|
|
2
2
|
//# sourceMappingURL=ObjectSchema.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__extends}from"tslib";import*as React from"react";import{MiddlePanel,RightPanel,Row,Section}from"../../common-elements";import{MediaTypeModel}from"../../services";import{MediaTypeSamples}from"../PayloadSamples/MediaTypeSamples";import{Schema}from"../Schema";import{CodePanel,ContentPanel}from"../../../../components/Panel";import{LayoutVariant}from"../../../../services/store-types";var SchemaDefinition=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return Object.defineProperty(t,"_mediaModel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),t}return __extends(t,e),Object.defineProperty(t,"getMediaType",{enumerable:!1,configurable:!0,writable:!0,value:function(e,t){if(!e)return{};var a={schema:{$ref:e}};return t&&(a.examples={example:{$ref:t}}),a}}),Object.defineProperty(t.prototype,"mediaModel",{get:function(){var e=this.props,a=e.parser,n=e.schemaRef,
|
|
1
|
+
import{__extends,__makeTemplateObject}from"tslib";import*as React from"react";import styled from"styled-components";import{MiddlePanel,RightPanel,Row,Section}from"../../common-elements";import{MediaTypeModel}from"../../services";import{MediaTypeSamples}from"../PayloadSamples/MediaTypeSamples";import{Schema}from"../Schema";import{CodePanel,ContentPanel}from"../../../../components/Panel";import{LayoutVariant}from"../../../../services/store-types";import{Markdown}from"../Markdown/Markdown";var SchemaDefinition=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return Object.defineProperty(t,"_mediaModel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),t}return __extends(t,e),Object.defineProperty(t,"getMediaType",{enumerable:!1,configurable:!0,writable:!0,value:function(e,t){if(!e)return{};var a={schema:{$ref:e}};return t&&(a.examples={example:{$ref:t}}),a}}),Object.defineProperty(t.prototype,"mediaModel",{get:function(){var e=this.props,a=e.parser,n=e.schemaRef,o=e.exampleRef,i=e.options;return this._mediaModel||(this._mediaModel=new MediaTypeModel(a,"json",!1,t.getMediaType(n,o),i)),this._mediaModel},enumerable:!1,configurable:!0}),Object.defineProperty(t.prototype,"render",{enumerable:!1,configurable:!0,writable:!0,value:function(){var e,t,a=this.props,n=a.showReadOnly,o=void 0===n||n,i=a.showWriteOnly,r=void 0!==i&&i,l=a.layout,m=a.showRightPanel;return React.createElement(Section,null,React.createElement(Row,{layout:l},React.createElement(MiddlePanel,{isStacked:l===LayoutVariant.STACKED},(null===(e=this.mediaModel.schema)||void 0===e?void 0:e.description)&&React.createElement(Description,null,React.createElement(Markdown,{source:null===(t=this.mediaModel.schema)||void 0===t?void 0:t.description})),React.createElement(ContentPanel,null,React.createElement(Schema,{showAccessMode:!0,skipWriteOnly:!r,skipReadOnly:!o,schema:this.mediaModel.schema}))),m?React.createElement(RightPanel,null,React.createElement(CodePanel,null,React.createElement(MediaTypeSamples,{mediaType:this.mediaModel}))):null))}}),t}(React.PureComponent);export{SchemaDefinition};var templateObject_1,Description=styled.div(templateObject_1||(templateObject_1=__makeTemplateObject(["\n margin-bottom: ","px;\n"],["\n margin-bottom: ","px;\n"])),(function(e){return 4*e.theme.spacing.unit}));
|
|
2
2
|
//# sourceMappingURL=SchemaDefinition.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__makeTemplateObject,__rest}from"tslib";import{observer}from"mobx-react";import*as React from"react";import{ShelfIcon}from"../../common-elements/icons";import{shortenHTTPVerb}from"../../utils/openapi";import{MenuItems}from"./MenuItems";import{MenuItemLabel,MenuItemLi,MenuItemLink,MenuItemTitle,OperationBadge}from"./styled.elements";import{OptionsContext}from"../OptionsProvider";import styled from"../../styled-components";import{l}from"../../services/Labels";import{userIsForcingNavigation}from"../../common-elements/linkify";import{SideNavStyle}from"../../../../services/types";export var MenuExternalLink=observer((function(e){var t=e.link;return React.createElement(React.Fragment,null,isSeparator(t)?t.separator?React.createElement(MenuItemLabel,{depth:0,active:!1},t.separator):null:React.createElement(MenuItemLi,{depth:1},React.createElement(MenuItemLink,{href:t.link,target:t.target,active:!1,depth:1},React.createElement(MenuItemTitle,{title:t.label},t.label))),t.separatorLine?React.createElement(SeparatorLine,null):null)}));function preventDefaultIfNotForced(e){e.defaultPrevented||userIsForcingNavigation(e)||e.preventDefault()}var MenuItemLinkOrLabel=React.forwardRef((function(e,t){var n=e.href,a=e.children,r=__rest(e,["href","children"]);return n?React.createElement(MenuItemLink,__assign({href:n,onClick:preventDefaultIfNotForced},r,{ref:t}),a):React.createElement(MenuItemLabel,__assign({},r,{ref:t}),a)})),MenuItemOperationLinkOrLabel=styled(MenuItemLinkOrLabel)(templateObject_1||(templateObject_1=__makeTemplateObject(["\n flex-wrap: wrap;\n"],["\n flex-wrap: wrap;\n"])));export var MenuItem=observer((function(e){var t=e.item,n=e.withoutChildren,a=e.onActivate,r=React.createRef(),i=React.useState(!1),l=i[0],
|
|
1
|
+
import{__assign,__makeTemplateObject,__rest}from"tslib";import{observer}from"mobx-react";import*as React from"react";import{ShelfIcon}from"../../common-elements/icons";import{shortenHTTPVerb}from"../../utils/openapi";import{MenuItems}from"./MenuItems";import{MenuItemLabel,MenuItemLi,MenuItemLink,MenuItemTitle,OperationBadge}from"./styled.elements";import{OptionsContext}from"../OptionsProvider";import styled from"../../styled-components";import{l}from"../../services/Labels";import{userIsForcingNavigation}from"../../common-elements/linkify";import{SideNavStyle}from"../../../../services/types";export var MenuExternalLink=observer((function(e){var t=e.link;return React.createElement(React.Fragment,null,isSeparator(t)?t.separator?React.createElement(MenuItemLabel,{depth:0,active:!1},t.separator):null:React.createElement(MenuItemLi,{depth:1},React.createElement(MenuItemLink,{href:t.link,target:t.target,active:!1,depth:1},React.createElement(MenuItemTitle,{title:t.label},t.label))),t.separatorLine?React.createElement(SeparatorLine,null):null)}));function preventDefaultIfNotForced(e){e.defaultPrevented||userIsForcingNavigation(e)||e.preventDefault()}var MenuItemLinkOrLabel=React.forwardRef((function(e,t){var n=e.href,a=e.children,r=__rest(e,["href","children"]);return n?React.createElement(MenuItemLink,__assign({href:n,onClick:preventDefaultIfNotForced},r,{ref:t}),a):React.createElement(MenuItemLabel,__assign({},r,{ref:t}),a)})),MenuItemOperationLinkOrLabel=styled(MenuItemLinkOrLabel)(templateObject_1||(templateObject_1=__makeTemplateObject(["\n flex-wrap: wrap;\n"],["\n flex-wrap: wrap;\n"])));export var MenuItem=observer((function(e){var t=e.item,n=e.withoutChildren,a=e.onActivate,r=React.createRef(),i=React.useState(!1),l=i[0],c=i[1],o=React.useState("group"===t.type&&t.expanded),m=o[0],p=o[1];React.useEffect((function(){c(t.active)}),[t.active]),React.useEffect((function(){p(t.expanded)}),[t.expanded]);var s=React.useCallback((function(e){userIsForcingNavigation(e)||(null==a||a(t,e),e.stopPropagation())}),[a,t]);return React.useEffect((function(){e.item.active&&r.current&&r.current.scrollIntoViewIfNeeded()}),[e.item,e.item.active,r]),React.createElement(MenuItemLi,{onClick:s,depth:t.depth,"data-item-id":t.id},"operation"===t.type?React.createElement(OperationItemContent,__assign({},e,{item:t,ref:r})):React.createElement(MenuItemLinkOrLabel,{depth:t.depth,active:l,type:t.type,ref:r,href:t.href,hasChildren:t.items&&t.items.length>0},t.depth>0&&t.items.length>0&&React.createElement(ShelfIcon,{direction:m?"down":"right"})||null,t.isSchema?React.createElement(OperationBadge,{type:"schema"},"schema"):null,React.createElement(MenuItemTitle,{title:t.name},t.name,e.children)),!n&&t.items&&t.items.length>0&&React.createElement(MenuItems,{expanded:m,items:t.items,onActivate:a}))}));var OperationItemContent=observer(React.forwardRef((function(e,t){var n,a,r=e.item,i=e.children,c=React.useContext(OptionsContext);return c.sideNavStyle!==SideNavStyle.PathFirst&&!r.search||"operation"!==r.type?(n=c.sideNavStyle===SideNavStyle.IdOnly?r.operationId||r.path:r.name,a=null):(n=React.createElement(MenuItemPath,{title:r.path}," ",r.path," "),a=React.createElement(MenuItemDescription,null," ",r.name," ")),React.createElement(MenuItemOperationLinkOrLabel,{depth:r.depth,active:r.active,deprecated:r.deprecated,ref:t,href:r.href},r.isWebhook?React.createElement(OperationBadge,{type:"hook"},l("webhook")):React.createElement(OperationBadge,{type:r.httpVerb},shortenHTTPVerb(r.httpVerb)),React.createElement(MenuItemTitle,{width:"calc(100% - 42px)"},n,i),a)})));function isSeparator(e){return null!=e.separator||!!e.separatorLine&&!e.link}export var MenuItemPath=styled.code(templateObject_2||(templateObject_2=__makeTemplateObject(["\n line-height: 1.4;\n display: inline-block;\n margin-bottom: 5px;\n ","\n"],["\n line-height: 1.4;\n display: inline-block;\n margin-bottom: 5px;\n ","\n"])),(function(e){var t;return(null===(t=e.theme.sidebar)||void 0===t?void 0:t.breakPath)?"word-break: break-all":""}));var templateObject_1,templateObject_2,templateObject_3,templateObject_4,MenuItemDescription=styled.small(templateObject_3||(templateObject_3=__makeTemplateObject(["\n display: block;\n font-size: 0.87em;\n line-height: 1.2;\n"],["\n display: block;\n font-size: 0.87em;\n line-height: 1.2;\n"])));export var SeparatorLine=styled.span(templateObject_4||(templateObject_4=__makeTemplateObject(["\n display: block;\n width: 100%;\n height: 1px;\n background-color: ",";\n margin: ","px 0;\n"],["\n display: block;\n width: 100%;\n height: 1px;\n background-color: ",";\n margin: ","px 0;\n"])),(function(e){return e.theme.sidebar.separatorLineColor}),(function(e){return e.theme.sidebar.spacing.paddingVertical}));
|
|
2
2
|
//# sourceMappingURL=MenuItem.js.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const OperationBadge: import("styled-components").StyledComponent<"
|
|
1
|
+
export declare const OperationBadge: import("styled-components").StyledComponent<"div", import("../../../../services/extendTheme").ProTheme, {
|
|
2
2
|
className: `operation-type ${string}`;
|
|
3
3
|
} & {
|
|
4
4
|
type: string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__makeTemplateObject}from"tslib";import classnames from"classnames";import{darken}from"polished";import{deprecatedCss,ShelfIcon}from"../../common-elements/";import styled from"../../styled-components";export var OperationBadge=styled.
|
|
1
|
+
import{__makeTemplateObject}from"tslib";import classnames from"classnames";import{darken}from"polished";import{deprecatedCss,ShelfIcon}from"../../common-elements/";import styled from"../../styled-components";export var OperationBadge=styled.div.attrs((function(n){return{className:"operation-type "+n.type}}))(templateObject_1||(templateObject_1=__makeTemplateObject(["\n display: inline-flex;\n align-items: center;\n justify-content: center;\n font-size: ",";\n font-family: ",";\n font-weight: ",";\n line-height: ",";\n color: ",";\n background-color: #333;\n border-radius: ",";\n width: 36px;\n height: 14px;\n text-transform: uppercase;\n text-align: center;\n margin-right: 6px;\n\n &.get {\n background-color: ",";\n }\n &.post {\n background-color: ",";\n }\n &.put {\n background-color: ",";\n }\n &.options {\n background-color: ",";\n }\n &.patch {\n background-color: ",";\n }\n &.delete {\n background-color: ",";\n }\n &.basic {\n background-color: ",";\n }\n &.link {\n background-color: ",";\n }\n &.head {\n background-color: ",";\n }\n &.hook {\n background-color: ",";\n }\n &.schema {\n background-color: ",";\n }\n"],["\n display: inline-flex;\n align-items: center;\n justify-content: center;\n font-size: ",";\n font-family: ",";\n font-weight: ",";\n line-height: ",";\n color: ",";\n background-color: #333;\n border-radius: ",";\n width: 36px;\n height: 14px;\n text-transform: uppercase;\n text-align: center;\n margin-right: 6px;\n\n &.get {\n background-color: ",";\n }\n &.post {\n background-color: ",";\n }\n &.put {\n background-color: ",";\n }\n &.options {\n background-color: ",";\n }\n &.patch {\n background-color: ",";\n }\n &.delete {\n background-color: ",";\n }\n &.basic {\n background-color: ",";\n }\n &.link {\n background-color: ",";\n }\n &.head {\n background-color: ",";\n }\n &.hook {\n background-color: ",";\n }\n &.schema {\n background-color: ",";\n }\n"])),(function(n){return n.theme.components.httpBadges.sizes.small.fontSize}),(function(n){return n.theme.components.httpBadges.fontFamily}),(function(n){return n.theme.components.httpBadges.fontWeight}),(function(n){return n.theme.components.httpBadges.sizes.small.lineHeight}),(function(n){return n.theme.components.httpBadges.color}),(function(n){return n.theme.components.httpBadges.borderRadius}),(function(n){return n.theme.colors.http.get}),(function(n){return n.theme.colors.http.post}),(function(n){return n.theme.colors.http.put}),(function(n){return n.theme.colors.http.options}),(function(n){return n.theme.colors.http.patch}),(function(n){return n.theme.colors.http.delete}),(function(n){return n.theme.colors.http.basic}),(function(n){return n.theme.colors.http.link}),(function(n){return n.theme.colors.http.head}),(function(n){return n.theme.colors.primary.main}),(function(n){return n.theme.colors.http.basic}));export var MenuItemUl=styled.ul(templateObject_2||(templateObject_2=__makeTemplateObject(["\n margin: 0;\n padding: 0;\n\n & & {\n font-size: 14px;\n }\n\n ",";\n"],["\n margin: 0;\n padding: 0;\n\n & & {\n font-size: 14px;\n }\n\n ",";\n"])),(function(n){return n.expanded?"":"display: none;"}));export var MenuItemLi=styled.li(templateObject_3||(templateObject_3=__makeTemplateObject(["\n list-style: none inside none;\n overflow: hidden;\n text-overflow: ellipsis;\n padding: 0;\n ",";\n"],["\n list-style: none inside none;\n overflow: hidden;\n text-overflow: ellipsis;\n padding: 0;\n ",";\n"])),(function(n){return 0===n.depth?"margin-top: 10px":""}));export var MenuItemLabel=styled.label.attrs((function(n){return{role:"menuitem",className:classnames("-depth"+n.depth,{active:n.active})}}))(templateObject_4||(templateObject_4=__makeTemplateObject(["\n cursor: pointer;\n position: relative;\n margin: 1px 0 0 16px;\n display: flex;\n text-decoration: none;\n line-height: 15px;\n\n align-items: ",";\n\n font-family: ",";\n font-size: ",";\n font-weight: ",";\n\n border-top-left-radius: ",";\n border-bottom-left-radius: ",";\n background-color: ",";\n pointer-events: ",";\n\n color: ",";\n\n margin-left: ",";\n\n padding-top: ","px;\n padding-right: ","px;\n padding-bottom: ","px;\n margin-bottom: 1px; // hardcoded for now\n\n padding-left: ","px;\n\n ",";\n\n &:hover {\n background-color: ",";\n color: ",";\n transition: background-color 0.3s, color 0.3s;\n }\n\n "," {\n height: ",";\n width: ",";\n fill: ",";\n margin-right: ","px;\n }\n"],["\n cursor: pointer;\n position: relative;\n margin: 1px 0 0 16px;\n display: flex;\n text-decoration: none;\n line-height: 15px;\n\n align-items: ",";\n\n font-family: ",";\n font-size: ",";\n font-weight: ",";\n\n border-top-left-radius: ",";\n border-bottom-left-radius: ",";\n background-color: ",";\n pointer-events: ",";\n\n color: ",";\n\n margin-left: ",";\n\n padding-top: ","px;\n padding-right: ","px;\n padding-bottom: ","px;\n margin-bottom: 1px; // hardcoded for now\n\n padding-left: ","px;\n\n ",";\n\n &:hover {\n background-color: ",";\n color: ",";\n transition: background-color 0.3s, color 0.3s;\n }\n\n "," {\n height: ",";\n width: ",";\n fill: ",";\n margin-right: ","px;\n }\n"])),(function(n){return n.hasChildren?"center":""}),(function(n){return n.theme.sidebar.fontFamily}),(function(n){return n.theme.sidebar.fontSize}),(function(n){var e=n.theme;return 0===n.depth?e.typography.fontWeightBold:e.typography.fontWeightRegular}),(function(n){return n.theme.sidebar.borderRadius}),(function(n){return n.theme.sidebar.borderRadius}),(function(n){var e=n.active,t=n.theme;return e?t.sidebar.activeBgColor:t.sidebar.backgroundColor}),(function(n){return 0===n.depth?"none":"auto"}),(function(n){var e=n.active,t=n.theme;return e?t.sidebar.activeTextColor:t.sidebar.textColor}),(function(n){var e=n.depth,t=n.theme;return t.sidebar.spacing.offsetLeft+(e>0?e-1:e)*t.sidebar.spacing.offsetNesting+"px"}),(function(n){return n.theme.sidebar.spacing.paddingVertical}),(function(n){return n.theme.sidebar.spacing.paddingHorizontal}),(function(n){return n.theme.sidebar.spacing.paddingVertical}),(function(n){var e=n.theme,t=n.hasChildren,o=n.depth;return t&&0!==o?e.sidebar.spacing.paddingHorizontal:e.sidebar.spacing.paddingHorizontal+e.sidebar.caretSize+.5*e.sidebar.spacing.unit}),(function(n){return n.deprecated&&deprecatedCss||""}),(function(n){return n.theme.sidebar.activeBgColor}),(function(n){return n.theme.sidebar.activeTextColor}),ShelfIcon,(function(n){return n.theme.sidebar.caretSize}),(function(n){return n.theme.sidebar.caretSize}),(function(n){return n.theme.sidebar.caretColor}),(function(n){return n.theme.sidebar.spacing.unit/2}));export var MenuItemLink=MenuItemLabel.withComponent("a");export var MenuItemTitle=styled.span(templateObject_5||(templateObject_5=__makeTemplateObject(["\n display: inline-block;\n vertical-align: middle;\n width: ",";\n overflow: hidden;\n text-overflow: ellipsis;\n line-height: 15px;\n"],["\n display: inline-block;\n vertical-align: middle;\n width: ",";\n overflow: hidden;\n text-overflow: ellipsis;\n line-height: 15px;\n"])),(function(n){return n.width?n.width:"auto"}));export var RedocAttribution=styled.div(templateObject_6||(templateObject_6=__makeTemplateObject(["\n ",";\n"],["\n ",";\n"])),(function(n){var e=n.theme;return"\n font-size: 0.8em;\n margin-top: "+2*e.spacing.unit+"px;\n padding: 0 "+4*e.spacing.unit+"px;\n text-align: left;\n\n opacity: 0.7;\n\n a,\n a:visited,\n a:hover {\n color: "+e.sidebar.textColor+" !important;\n border-top: 1px solid "+darken(.1,e.sidebar.backgroundColor)+";\n padding: "+e.spacing.unit+"px 0;\n display: block;\n }\n"}));var templateObject_1,templateObject_2,templateObject_3,templateObject_4,templateObject_5,templateObject_6;
|
|
2
2
|
//# sourceMappingURL=styled.elements.js.map
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import type { HookConfig } from '../services/RedocNormalizedOptions';
|
|
3
|
+
import type { SchemaModel } from '../services';
|
|
3
4
|
export declare function RenderHook<T>(props: {
|
|
4
5
|
Hook?: HookConfig<T>;
|
|
5
6
|
props: T;
|
|
6
7
|
}): JSX.Element | null;
|
|
8
|
+
export declare function getAccessModeLabelText(schema: SchemaModel): string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import*as React from"react";export function RenderHook(e){if(!e.Hook)return null;var r=e.Hook(e.props);return r&&r.html?React.createElement("span",{dangerouslySetInnerHTML:{__html:r.html}}):r}
|
|
1
|
+
import*as React from"react";export function RenderHook(e){if(!e.Hook)return null;var r=e.Hook(e.props);return r&&r.html?React.createElement("span",{dangerouslySetInnerHTML:{__html:r.html}}):r}export function getAccessModeLabelText(e){return(e.readOnly?"read-only":e.writeOnly&&"write-only")||""}
|
|
2
2
|
//# sourceMappingURL=helper.js.map
|
|
@@ -5,6 +5,8 @@ import type { RedocProNormalizedOptions } from '../../../services';
|
|
|
5
5
|
export declare type TagInfo = OpenAPITag & {
|
|
6
6
|
operations: ExtendedOpenAPIOperation[];
|
|
7
7
|
used?: boolean;
|
|
8
|
+
schemaRendersInTag?: boolean;
|
|
9
|
+
isSchema?: boolean;
|
|
8
10
|
};
|
|
9
11
|
export declare type ExtendedOpenAPIOperation = {
|
|
10
12
|
pointer: string;
|
|
@@ -54,6 +56,19 @@ export declare class MenuBuilder {
|
|
|
54
56
|
* @param options - normalized options
|
|
55
57
|
*/
|
|
56
58
|
static getTagsItems(parser: OpenAPIParser, tagsMap: TagsInfoMap, parent: GroupModel | undefined, group: TagGroup | undefined, options: RedocProNormalizedOptions): ContentItemModel[];
|
|
59
|
+
/**
|
|
60
|
+
* Returns array of schemas with reference to tag, or schemas with reference to schemaDefinitionsTagName tag
|
|
61
|
+
* @param tagsMap all tags
|
|
62
|
+
* @param tag tag to find reference of schema
|
|
63
|
+
* @param item menu item
|
|
64
|
+
* @param schemaDefinitionsTagName config
|
|
65
|
+
*/
|
|
66
|
+
static getTagRelatedSchema({ parser, tag, parent, schemaDefinitionsTagName, }: {
|
|
67
|
+
parser: OpenAPIParser;
|
|
68
|
+
tag: TagInfo;
|
|
69
|
+
parent: GroupModel;
|
|
70
|
+
schemaDefinitionsTagName?: string;
|
|
71
|
+
}): GroupModel[];
|
|
57
72
|
/**
|
|
58
73
|
* Returns array of Operation items for the tag
|
|
59
74
|
* @param parser
|
|
@@ -66,5 +81,5 @@ export declare class MenuBuilder {
|
|
|
66
81
|
/**
|
|
67
82
|
* collects tags and maps each tag to list of operations belonging to this tag
|
|
68
83
|
*/
|
|
69
|
-
static getTagsWithOperations(parser: OpenAPIParser): TagsInfoMap;
|
|
84
|
+
static getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;
|
|
70
85
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__spreadArray}from"tslib";import{isOperationName,SECURITY_DEFINITIONS_COMPONENT_NAME,setSecuritySchemePrefix,JsonPointer,alphabeticallyByProp}from"../utils";import{MarkdownRenderer}from"./MarkdownRenderer";import{GroupModel,OperationModel}from"./models";export var GROUP_DEPTH=0;var MenuBuilder=function(){function e(){}return Object.defineProperty(e,"buildStructure",{enumerable:!1,configurable:!0,writable:!0,value:function(r,t){var a=r.definition,n=[],o=e.getTagsWithOperations(r);return n.push.apply(n,e.addMarkdownItems(a.info.description||"",void 0,1,t)),
|
|
1
|
+
import{__assign,__spreadArray}from"tslib";import{isOperationName,SECURITY_DEFINITIONS_COMPONENT_NAME,setSecuritySchemePrefix,JsonPointer,alphabeticallyByProp}from"../utils";import{MarkdownRenderer}from"./MarkdownRenderer";import{GroupModel,OperationModel}from"./models";export var GROUP_DEPTH=0;var MenuBuilder=function(){function e(){}return Object.defineProperty(e,"buildStructure",{enumerable:!1,configurable:!0,writable:!0,value:function(r,t){var a=r.definition,n=[],i=__spreadArray([],a.tags||[],!0)||[];!i.find((function(e){return(null==e?void 0:e.name)===t.schemaDefinitionsTagName}))&&t.schemaDefinitionsTagName&&i.push({name:t.schemaDefinitionsTagName});var o=e.getTagsWithOperations(r,i),s=a["x-tagGroups"];return n.push.apply(n,e.addMarkdownItems(a.info.description||"",void 0,1,t)),s&&s.length>0?n.push.apply(n,e.getTagGroupsItems(r,void 0,s,o,t)):n.push.apply(n,e.getTagsItems(r,o,void 0,void 0,t)),n}}),Object.defineProperty(e,"addMarkdownItems",{enumerable:!1,configurable:!0,writable:!0,value:function(e,r,t,a){var n=new MarkdownRenderer(a).extractHeadings(e||"");n.length&&r&&r.description&&(r.description=MarkdownRenderer.getTextBeforeHading(r.description,n[0].name));var i=function(e,r,t){return void 0===t&&(t=1),r.map((function(r){var a=new GroupModel("section",r,e);return a.depth=t,r.items&&(a.items=i(a,r.items,t+1)),MarkdownRenderer.containsComponent(a.description||"",SECURITY_DEFINITIONS_COMPONENT_NAME)&&setSecuritySchemePrefix(a.id+"/"),a}))};return i(r,n,t)}}),Object.defineProperty(e,"getTagGroupsItems",{enumerable:!1,configurable:!0,writable:!0,value:function(r,t,a,n,i){for(var o=[],s=0,p=a;s<p.length;s++){var l=p[s],d=new GroupModel("group",l,t);d.depth=GROUP_DEPTH,d.items=e.getTagsItems(r,n,d,l,i),o.push(d)}return o}}),Object.defineProperty(e,"getTagsItems",{enumerable:!1,configurable:!0,writable:!0,value:function(r,t,a,n,i){var o;if(o=void 0===n?Object.keys(t):n.tags,!Array.isArray(o))return console.warn("Unexpected values of tags. Check tags or x-tagGroups in your definition."),[];for(var s=[],p=0,l=o.map((function(e){return t[e]?(t[e].used=!0,t[e]):(console.warn('Non-existing tag "'+e+'" is added to the group "'+(null==n?void 0:n.name)+'"'),null)}));p<l.length;p++){var d=l[p];if(d){var u=new GroupModel("tag",d,a);if(u.depth=GROUP_DEPTH+1,""!==d.name){var m=this.getTagRelatedSchema({parser:r,tag:d,parent:u,schemaDefinitionsTagName:i.schemaDefinitionsTagName});u.items=__spreadArray(__spreadArray(__spreadArray([],m,!0),e.addMarkdownItems(d.description||"",u,u.depth+1,i),!0),this.getOperationsItems(r,u,d,u.depth+1,i),!0),s.push(u)}else{var c=__spreadArray(__spreadArray([],e.addMarkdownItems(d.description||"",u,u.depth+1,i),!0),this.getOperationsItems(r,void 0,d,u.depth+1,i),!0);s.push.apply(s,c)}}}return i.sortTagsAlphabetically&&s.sort(alphabeticallyByProp("name")),s}}),Object.defineProperty(e,"getTagRelatedSchema",{enumerable:!1,configurable:!0,writable:!0,value:function(e){var r,t=e.parser,a=e.tag,n=e.parent,i=e.schemaDefinitionsTagName,o=i?[i]:[];return Object.entries((null===(r=t.definition.components)||void 0===r?void 0:r.schemas)||{}).map((function(e){var r=e[0],t=e[1];if(!(t["x-tags"]||o).includes(a.name))return null;var i=new GroupModel("schema",{name:r,"x-displayName":""+(t.title||r),description:'<SchemaDefinition showWriteOnly={true} schemaRef="#/components/schemas/'+r+'" />',isSchema:!0,level:2},n);return i.depth=n.depth+1,i})).filter(Boolean)}}),Object.defineProperty(e,"getOperationsItems",{enumerable:!1,configurable:!0,writable:!0,value:function(e,r,t,a,n){if(0===t.operations.length)return[];for(var i=[],o=0,s=t.operations;o<s.length;o++){var p=s[o],l=new OperationModel(e,p,r,n);l.depth=a,i.push(l)}return n.sortOperationsAlphabetically&&i.sort(alphabeticallyByProp("name")),i}}),Object.defineProperty(e,"getTagsWithOperations",{enumerable:!1,configurable:!0,writable:!0,value:function(e,r){for(var t={},a=e.definition,n=a["x-webhooks"]||a.webhooks,i=0,o=r||[];i<o.length;i++){var s=o[i];t[s.name]=__assign(__assign({},s),{operations:[]})}function p(e,r,a){for(var n,i=0,o=Object.keys(r||{});i<o.length;i++)for(var s=o[i],l=r[s],d=0,u=Object.keys(l).filter(isOperationName);d<u.length;d++){var m=u[d],c=l[m];if(l.$ref){var g=e.deref(l);p(e,((n={})[s]=g,n),a)}else{var h=null==c?void 0:c.tags;h&&h.length||(h=[""]);for(var f=0,v=h;f<v.length;f++){var b=v[f],y=t[b];void 0===y&&(y={name:b,operations:[]},t[b]=y),y["x-traitTag"]||y.operations.push(__assign(__assign({},c),{pathName:s,pointer:JsonPointer.compile(["paths",s,m]),httpVerb:m,pathParameters:l.parameters||[],pathServers:l.servers,isWebhook:!!a}))}}}}return a.paths&&p(e,a.paths),n&&p(e,n,!0),t}}),e}();export{MenuBuilder};
|
|
2
2
|
//# sourceMappingURL=MenuBuilder.js.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare type MenuItemGroupType = 'group' | 'tag' | 'section';
|
|
1
|
+
export declare type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
|
|
2
2
|
export declare type MenuItemType = MenuItemGroupType | 'operation';
|
|
3
3
|
/** Generic interface for MenuItems */
|
|
4
4
|
export interface IMenuItem {
|
|
@@ -14,6 +14,7 @@ export interface IMenuItem {
|
|
|
14
14
|
parent?: IMenuItem;
|
|
15
15
|
deprecated?: boolean;
|
|
16
16
|
type: MenuItemType;
|
|
17
|
+
isSchema?: boolean;
|
|
17
18
|
deactivate(): void;
|
|
18
19
|
activate(): void;
|
|
19
20
|
collapse(): void;
|
|
@@ -12,10 +12,10 @@ export declare class OpenAPIParser {
|
|
|
12
12
|
definition: OpenAPIDefinition;
|
|
13
13
|
hasSecurityDefinitions: boolean;
|
|
14
14
|
private _refCounter;
|
|
15
|
-
private allowMergeRefs;
|
|
15
|
+
private readonly allowMergeRefs;
|
|
16
16
|
constructor(definition: OpenAPIDefinition, definitionUrl?: string, options?: RedocNormalizedOptions);
|
|
17
17
|
validate(spec: GenericObject): void;
|
|
18
|
-
private containsSecurity;
|
|
18
|
+
private static containsSecurity;
|
|
19
19
|
preprocess(spec: OpenAPIDefinition): void;
|
|
20
20
|
/**
|
|
21
21
|
* get spec part by JsonPointer ($ref)
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__rest,__spreadArray}from"tslib";import{
|
|
1
|
+
import{__assign,__rest,__spreadArray}from"tslib";import{appendToMdHeading,IS_BROWSER}from"../utils/";import{JsonPointer}from"../utils/JsonPointer";import{getDefinitionName,isNamedDefinition,SECURITY_DEFINITIONS_COMPONENT_NAME,SECURITY_DEFINITIONS_JSX_NAME}from"../utils";import{buildComponentComment,MarkdownRenderer}from"./MarkdownRenderer";import{RedocNormalizedOptions}from"./RedocNormalizedOptions";var RefCounter=function(){function e(){Object.defineProperty(this,"_counter",{enumerable:!0,configurable:!0,writable:!0,value:{}})}return Object.defineProperty(e.prototype,"reset",{enumerable:!1,configurable:!0,writable:!0,value:function(){this._counter={}}}),Object.defineProperty(e.prototype,"visit",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this._counter[e]=this._counter[e]?this._counter[e]+1:1}}),Object.defineProperty(e.prototype,"exit",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this._counter[e]=this._counter[e]&&this._counter[e]-1}}),Object.defineProperty(e.prototype,"visited",{enumerable:!1,configurable:!0,writable:!0,value:function(e){return!!this._counter[e]}}),e}(),OpenAPIParser=function(){function e(r,t,i){var n=this;void 0===i&&(i=new RedocNormalizedOptions({})),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"definitionUrl",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hasSecurityDefinitions",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"_refCounter",{enumerable:!0,configurable:!0,writable:!0,value:new RefCounter}),Object.defineProperty(this,"allowMergeRefs",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"byRef",{enumerable:!0,configurable:!0,writable:!0,value:function(e){var r;if(n.definition){"#"!==e.charAt(0)&&(e="#"+e),e=decodeURIComponent(e);try{r=JsonPointer.get(n.definition,e)}catch(e){}return r||{}}}}),this.validate(r),this.preprocess(r),this.definition=r,this.hasSecurityDefinitions=e.containsSecurity(r),this.allowMergeRefs=r.openapi.startsWith("3.1");var o=IS_BROWSER?window.location.href:"";"string"==typeof t&&(this.definitionUrl=new URL(t,o).href)}return Object.defineProperty(e.prototype,"validate",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if(void 0===e.openapi)throw new Error("Document must be valid OpenAPI 3.0.0 definition")}}),Object.defineProperty(e,"containsSecurity",{enumerable:!1,configurable:!0,writable:!0,value:function(e){var r=e.info&&e.info.description||"";return MarkdownRenderer.containsComponent(r,SECURITY_DEFINITIONS_COMPONENT_NAME)||MarkdownRenderer.containsComponent(r,SECURITY_DEFINITIONS_JSX_NAME)}}),Object.defineProperty(e.prototype,"preprocess",{enumerable:!1,configurable:!0,writable:!0,value:function(r){if(r.info&&this.options.hideInfoDescription)r.info.description="";else if(!this.options.noAutoAuth&&r.info&&r.components&&r.components.securitySchemes){var t=r.info.description||"";if(!e.containsSecurity(r)){var i=buildComponentComment(SECURITY_DEFINITIONS_COMPONENT_NAME);r.info.description=appendToMdHeading(t,"Authentication",i)}}}}),Object.defineProperty(e.prototype,"isRef",{enumerable:!1,configurable:!0,writable:!0,value:function(e){return!!e&&(void 0!==(e=e).$ref&&null!==e.$ref)}}),Object.defineProperty(e.prototype,"resetVisited",{enumerable:!1,configurable:!0,writable:!0,value:function(){if("production"!==process.env.NODE_ENV)for(var e in this._refCounter._counter)this._refCounter._counter[e]>0&&console.warn("Not exited reference: "+e);this._refCounter=new RefCounter}}),Object.defineProperty(e.prototype,"exitRef",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.isRef(e)&&this._refCounter.exit(e.$ref)}}),Object.defineProperty(e.prototype,"deref",{enumerable:!1,configurable:!0,writable:!0,value:function(e,r,t){if(void 0===r&&(r=!1),void 0===t&&(t=!1),this.isRef(e)){var i=getDefinitionName(e.$ref);if(i&&this.options.ignoreNamedSchemas.has(i))return{type:"object",title:i};var n=this.byRef(e.$ref),o=this._refCounter.visited(e.$ref);if(this._refCounter.visit(e.$ref),o&&!r)return Object.assign({},n,{"x-circular-ref":!0});var a=n;return this.isRef(n)&&(a=this.deref(n,!1,t),this.exitRef(n)),this.allowMergeRefs?this.mergeRefs(e,n,t):a}return e}}),Object.defineProperty(e.prototype,"mergeRefs",{enumerable:!1,configurable:!0,writable:!0,value:function(e,r,t){e.$ref;var i=__rest(e,["$ref"]),n=Object.keys(i);return 0===n.length?r:t&&n.some((function(e){return"description"!==e&&"title"!==e&&"externalDocs"!==e}))?{allOf:[i,r]}:__assign(__assign({},r),i)}}),Object.defineProperty(e.prototype,"shallowDeref",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if(this.isRef(e)){var r=getDefinitionName(e.$ref);if(r&&this.options.ignoreNamedSchemas.has(r))return{type:"object",title:r};var t=this.byRef(e.$ref);return this.allowMergeRefs?this.mergeRefs(e,t,!1):t}return e}}),Object.defineProperty(e.prototype,"mergeAllOf",{enumerable:!1,configurable:!0,writable:!0,value:function(e,r,t,i){var n,o=this;if(void 0===t&&(t=!1),void 0===i&&(i=new Set),r&&i.add(r),void 0===(e=this.hoistOneOfs(e)).allOf)return e;var a=__assign(__assign({},e),{allOf:void 0,parentRefs:[],title:e.title||getDefinitionName(r)});void 0!==a.properties&&"object"==typeof a.properties&&(a.properties=__assign({},a.properties)),void 0!==a.items&&"object"==typeof a.items&&(a.items=__assign({},a.items));for(var f=e.allOf.map((function(e){var r;if(!(e&&e.$ref&&i.has(e.$ref))){var n=o.deref(e,t,!0),f=e.$ref||void 0,s=o.mergeAllOf(n,f,t,i);return null===(r=a.parentRefs)||void 0===r||r.push.apply(r,s.parentRefs||[]),{$ref:f,schema:s}}})).filter((function(e){return void 0!==e})),s=0,l=f;s<l.length;s++){var u=l[s],p=u.$ref,c=u.schema;if(a.type!==c.type&&void 0!==a.type&&void 0!==c.type&&console.warn('Incompatible types in allOf at "'+r+'": "'+a.type+'" and "'+c.type+'"'),void 0!==c.type&&(a.type=c.type),void 0!==c.properties)for(var d in a.properties=a.properties||{},c.properties)if(a.properties[d]){var b=this.mergeAllOf({allOf:[a.properties[d],c.properties[d]]},r+"/properties/"+d);a.properties[d]=b,this.exitParents(b)}else a.properties[d]=c.properties[d];void 0!==c.items&&(a.items=a.items||{},a.items=this.mergeAllOf({allOf:[a.items,c.items]},r+"/items",!1,i)),void 0!==c.required&&(a.required=(a.required||[]).concat(c.required)),a=__assign(__assign({},c),a),p&&(null===(n=a.parentRefs)||void 0===n||n.push(p),void 0===a.title&&isNamedDefinition(p))}return a}}),Object.defineProperty(e.prototype,"findDerived",{enumerable:!1,configurable:!0,writable:!0,value:function(e){var r={},t=this.definition.components&&this.definition.components.schemas||{};for(var i in t){var n=this.deref(t[i]);void 0!==n.allOf&&n.allOf.find((function(r){return void 0!==r.$ref&&e.indexOf(r.$ref)>-1}))&&(r["#/components/schemas/"+i]=[n["x-discriminator-value"]||i])}return r}}),Object.defineProperty(e.prototype,"exitParents",{enumerable:!1,configurable:!0,writable:!0,value:function(e){for(var r=0,t=e.parentRefs||[];r<t.length;r++){var i=t[r];this.exitRef({$ref:i})}}}),Object.defineProperty(e.prototype,"hoistOneOfs",{enumerable:!1,configurable:!0,writable:!0,value:function(e){var r=this;if(void 0===e.allOf)return e;for(var t=e.allOf,i=function(e){var i=t[e];if(Array.isArray(i.oneOf)){var n=t.slice(0,e),o=t.slice(e+1);return{value:{oneOf:i.oneOf.map((function(e){var t=r.mergeAllOf({allOf:__spreadArray(__spreadArray(__spreadArray([],n,!0),[e],!1),o,!0)});return r.exitParents(t),t}))}}}},n=0;n<t.length;n++){var o=i(n);if("object"==typeof o)return o.value}return e}}),e}();export{OpenAPIParser};
|
|
2
2
|
//# sourceMappingURL=OpenAPIParser.js.map
|
|
@@ -103,8 +103,10 @@ export interface RedocRawOptions {
|
|
|
103
103
|
hideSchemaPattern?: boolean;
|
|
104
104
|
hideOneOfDescription?: boolean;
|
|
105
105
|
hideFab?: boolean;
|
|
106
|
+
schemaDefinitionsTagName?: string;
|
|
106
107
|
minCharacterLengthToInitSearch?: number;
|
|
107
108
|
maxResponseHeadersToShowInTryIt?: number;
|
|
109
|
+
showObjectSchemaExamples?: boolean;
|
|
108
110
|
}
|
|
109
111
|
export declare class RedocNormalizedOptions {
|
|
110
112
|
static normalizeExpandResponses(value: RedocRawOptions['expandResponses']): 'all' | {
|
|
@@ -167,8 +169,10 @@ export declare class RedocNormalizedOptions {
|
|
|
167
169
|
hideSchemaPattern: boolean;
|
|
168
170
|
hideOneOfDescription: boolean;
|
|
169
171
|
hideFab: boolean;
|
|
172
|
+
schemaDefinitionsTagName?: string;
|
|
170
173
|
minCharacterLengthToInitSearch: number;
|
|
171
174
|
maxResponseHeadersToShowInTryIt: number;
|
|
175
|
+
showObjectSchemaExamples: boolean;
|
|
172
176
|
constructor(raw: RedocRawOptions, defaults?: RedocRawOptions);
|
|
173
177
|
}
|
|
174
178
|
export {};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__decorate}from"tslib";import{observable,makeObservable}from"mobx";import defaultTheme,{resolveTheme}from"../theme";import{argValueToBoolean,argValueToExpandLevel,argValueToNumber,argValueToInt,isNumeric,mergeObjects,querySelector}from"../utils";import{setRedocLabels}from"./Labels";var RedocNormalizedOptions=function(){function e(a,t){var r,i,o,l,n,s;void 0===t&&(t={}),Object.defineProperty(this,"theme",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"scrollYOffset",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideHostname",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideInfoDescription",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandResponses",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"requiredPropsFirst",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortPropsAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortEnumValuesAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortOperationsAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortTagsAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"noAutoAuth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"nativeScrollbars",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"pathInMiddlePanel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"untrustedDefinition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideDownloadButton",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"downloadDefinitionUrl",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"disableSearch",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showChangeLayoutButton",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"onlyRequiredInSamples",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showConsole",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sendXUserAgentInTryIt",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"generatedPayloadSamplesMaxDepth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showExtensions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideSingleRequestSampleTab",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideRequestPayloadSample",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"menuToggle",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"jsonSampleExpandLevel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"enumSkipQuotes",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideSchemaTitles",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"simpleOneOfTypeLabel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"payloadSampleIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandSingleSchemaField",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"schemaExpansionLevel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"samplesTabsMaxCount",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"unstable_tryItButtonOverride",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"allowedMdComponents",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandDefaultServerVariables",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandDefaultRequest",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandDefaultResponse",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"maxDisplayedEnumValues",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"ignoreNamedSchemas",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"unstable_ignoreMimeParameters",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"unstable_externalCodeSamples",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hooks",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideSchemaPattern",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideOneOfDescription",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideFab",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"minCharacterLengthToInitSearch",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"maxResponseHeadersToShowInTryIt",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this);var u=null===(r=(a=__assign(__assign({},t),a)).theme)||void 0===r?void 0:r.extensionsHook;(null===(i=a.theme)||void 0===i?void 0:i.menu)&&!(null===(o=a.theme)||void 0===o?void 0:o.sidebar)&&(console.warn('Theme setting "menu" is deprecated. Rename to "sidebar"'),a.theme.sidebar=a.theme.menu),(null===(l=a.theme)||void 0===l?void 0:l.codeSample)&&!(null===(n=a.theme)||void 0===n?void 0:n.codeBlock)&&(console.warn('Theme setting "codeSample" is deprecated. Rename to "codeBlock"'),a.theme.codeBlock=a.theme.codeSample),this.theme=resolveTheme(mergeObjects({},defaultTheme,__assign(__assign({},a.theme),{extensionsHook:void 0}))),this.theme.mediaQueries={print:"@media print"};for(var b=0,d=Object.entries(this.theme.breakpoints);b<d.length;b++){var h=d[b],c=h[0],m=h[1];this.theme.mediaQueries[c]="@media screen and (min-width: "+m+")"}this.theme.extensionsHook=u,setRedocLabels(a.labels),this.scrollYOffset=e.normalizeScrollYOffset(a.scrollYOffset),this.hideHostname=e.normalizeHideHostname(a.hideHostname),this.expandResponses=e.normalizeExpandResponses(a.expandResponses),this.requiredPropsFirst=argValueToBoolean(a.requiredPropsFirst),this.sortPropsAlphabetically=argValueToBoolean(a.sortPropsAlphabetically),this.sortEnumValuesAlphabetically=argValueToBoolean(a.sortEnumValuesAlphabetically),this.sortOperationsAlphabetically=argValueToBoolean(a.sortOperationsAlphabetically),this.sortTagsAlphabetically=argValueToBoolean(a.sortTagsAlphabetically),this.noAutoAuth=argValueToBoolean(a.noAutoAuth),this.nativeScrollbars=argValueToBoolean(a.nativeScrollbars),this.pathInMiddlePanel=argValueToBoolean(a.pathInMiddlePanel),this.untrustedDefinition=argValueToBoolean(a.untrustedDefinition),this.hideDownloadButton=void 0===a.hideDownloadButton?null:argValueToBoolean(a.hideDownloadButton),this.downloadDefinitionUrl=a.downloadDefinitionUrl,this.hideInfoDescription=argValueToBoolean(a.hideInfoDescription),this.disableSearch=argValueToBoolean(a.disableSearch),this.onlyRequiredInSamples=argValueToBoolean(a.onlyRequiredInSamples),this.generatedPayloadSamplesMaxDepth=argValueToInt(a.generatedPayloadSamplesMaxDepth)||8,this.sendXUserAgentInTryIt=argValueToBoolean(a.sendXUserAgentInTryIt),this.showExtensions=e.normalizeShowExtensions(a.showExtensions),this.hideSingleRequestSampleTab=argValueToBoolean(a.hideSingleRequestSampleTab),this.hideRequestPayloadSample=argValueToBoolean(a.hideRequestPayloadSample),this.menuToggle=argValueToBoolean(a.menuToggle,!0),this.jsonSampleExpandLevel=argValueToExpandLevel(a.jsonSampleExpandLevel,2),this.enumSkipQuotes=argValueToBoolean(a.enumSkipQuotes),this.hideSchemaTitles=argValueToBoolean(a.hideSchemaTitles),this.simpleOneOfTypeLabel=argValueToBoolean(a.simpleOneOfTypeLabel),this.payloadSampleIdx=e.normalizePayloadSampleIdx(a.payloadSampleIdx),this.expandSingleSchemaField=argValueToBoolean(a.expandSingleSchemaField),this.schemaExpansionLevel=argValueToExpandLevel(a.schemaExpansionLevel),this.samplesTabsMaxCount=argValueToInt(a.samplesTabsMaxCount)||5,this.unstable_tryItButtonOverride=a.unstable_tryItButtonOverride||null,this.unstable_ignoreMimeParameters=argValueToBoolean(a.unstable_ignoreMimeParameters),this.allowedMdComponents=a.allowedMdComponents||{},this.expandDefaultServerVariables=argValueToBoolean(a.expandDefaultServerVariables),this.expandDefaultRequest=argValueToBoolean(a.expandDefaultRequest,!0),this.expandDefaultResponse=argValueToBoolean(a.expandDefaultResponse,!0),this.maxDisplayedEnumValues=argValueToNumber(a.maxDisplayedEnumValues);var p=Array.isArray(a.ignoreNamedSchemas)?a.ignoreNamedSchemas:null===(s=a.ignoreNamedSchemas)||void 0===s?void 0:s.split(",").map((function(e){return e.trim()}));this.ignoreNamedSchemas=new Set(p),this.unstable_externalCodeSamples=a.unstable_externalCodeSamples||[],this.hooks=a.hooks||{},this.hooks.ReplaceTryItAuthPanel&&!this.hooks.ReplaceTryItSecurityPanel&&(console.warn("[warn] ReplaceTryItAuthPanel is deprecated, use ReplaceTryItSecurityPanel instead"),this.hooks.ReplaceTryItSecurityPanel=this.hooks.ReplaceTryItAuthPanel),this.hideSchemaPattern=argValueToBoolean(a.hideSchemaPattern),this.hideOneOfDescription=argValueToBoolean(a.hideOneOfDescription),this.hideFab=argValueToBoolean(a.hideFab),this.minCharacterLengthToInitSearch=argValueToNumber(a.minCharacterLengthToInitSearch)||3,this.maxResponseHeadersToShowInTryIt=argValueToNumber(a.maxResponseHeadersToShowInTryIt)||0}return Object.defineProperty(e,"normalizeExpandResponses",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if("all"===e)return"all";if("string"==typeof e){var a={};return e.split(",").forEach((function(e){a[e.trim()]=!0})),a}return void 0!==e&&console.warn('expandResponses must be a string but received value "'+e+'" of type '+typeof e),{}}}),Object.defineProperty(e,"normalizeHideHostname",{enumerable:!1,configurable:!0,writable:!0,value:function(e){return!!e}}),Object.defineProperty(e,"normalizeScrollYOffset",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if("string"==typeof e&&!isNumeric(e)){var a=querySelector(e);a||console.warn("scrollYOffset value is a selector to non-existing element. Using offset 0 by default");var t=a&&a.getBoundingClientRect().bottom||0;return function(){return t}}return"number"==typeof e||isNumeric(e)?function(){return"number"==typeof e?e:parseFloat(e)}:"function"==typeof e?function(){var a=e();return"number"!=typeof a&&console.warn('scrollYOffset should return number but returned value "'+a+'" of type '+typeof a),a}:(void 0!==e&&console.warn("Wrong value for scrollYOffset ReDoc option: should be string, number or function"),function(){return 0})}}),Object.defineProperty(e,"normalizeShowExtensions",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if(void 0===e)return!1;if(""===e)return!0;if("string"!=typeof e)return e;switch(e){case"true":return!0;case"false":return!1;default:return e.split(",").map((function(e){return e.trim()}))}}}),Object.defineProperty(e,"normalizePayloadSampleIdx",{enumerable:!1,configurable:!0,writable:!0,value:function(e){return"number"==typeof e?Math.max(0,e):"string"==typeof e&&isFinite(e)?parseInt(e,10):0}}),__decorate([observable],e.prototype,"showConsole",void 0),e}();export{RedocNormalizedOptions};
|
|
1
|
+
import{__assign,__decorate}from"tslib";import{observable,makeObservable}from"mobx";import defaultTheme,{resolveTheme}from"../theme";import{argValueToBoolean,argValueToExpandLevel,argValueToNumber,argValueToInt,isNumeric,mergeObjects,querySelector}from"../utils";import{setRedocLabels}from"./Labels";var RedocNormalizedOptions=function(){function e(a,t){var i,r,o,l,n,s;void 0===t&&(t={}),Object.defineProperty(this,"theme",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"scrollYOffset",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideHostname",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideInfoDescription",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandResponses",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"requiredPropsFirst",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortPropsAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortEnumValuesAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortOperationsAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sortTagsAlphabetically",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"noAutoAuth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"nativeScrollbars",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"pathInMiddlePanel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"untrustedDefinition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideDownloadButton",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"downloadDefinitionUrl",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"disableSearch",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showChangeLayoutButton",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"onlyRequiredInSamples",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showConsole",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sendXUserAgentInTryIt",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"generatedPayloadSamplesMaxDepth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showExtensions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideSingleRequestSampleTab",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideRequestPayloadSample",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"menuToggle",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"jsonSampleExpandLevel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"enumSkipQuotes",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideSchemaTitles",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"simpleOneOfTypeLabel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"payloadSampleIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandSingleSchemaField",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"schemaExpansionLevel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"samplesTabsMaxCount",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"unstable_tryItButtonOverride",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"allowedMdComponents",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandDefaultServerVariables",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandDefaultRequest",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"expandDefaultResponse",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"maxDisplayedEnumValues",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"ignoreNamedSchemas",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"unstable_ignoreMimeParameters",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"unstable_externalCodeSamples",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hooks",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideSchemaPattern",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideOneOfDescription",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"hideFab",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"schemaDefinitionsTagName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"minCharacterLengthToInitSearch",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"maxResponseHeadersToShowInTryIt",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showObjectSchemaExamples",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this);var u=null===(i=(a=__assign(__assign({},t),a)).theme)||void 0===i?void 0:i.extensionsHook;(null===(r=a.theme)||void 0===r?void 0:r.menu)&&!(null===(o=a.theme)||void 0===o?void 0:o.sidebar)&&(console.warn('Theme setting "menu" is deprecated. Rename to "sidebar"'),a.theme.sidebar=a.theme.menu),(null===(l=a.theme)||void 0===l?void 0:l.codeSample)&&!(null===(n=a.theme)||void 0===n?void 0:n.codeBlock)&&(console.warn('Theme setting "codeSample" is deprecated. Rename to "codeBlock"'),a.theme.codeBlock=a.theme.codeSample),this.theme=resolveTheme(mergeObjects({},defaultTheme,__assign(__assign({},a.theme),{extensionsHook:void 0}))),this.theme.mediaQueries={print:"@media print"};for(var b=0,d=Object.entries(this.theme.breakpoints);b<d.length;b++){var h=d[b],c=h[0],m=h[1];this.theme.mediaQueries[c]="@media screen and (min-width: "+m+")"}this.theme.extensionsHook=u,setRedocLabels(a.labels),this.scrollYOffset=e.normalizeScrollYOffset(a.scrollYOffset),this.hideHostname=e.normalizeHideHostname(a.hideHostname),this.expandResponses=e.normalizeExpandResponses(a.expandResponses),this.requiredPropsFirst=argValueToBoolean(a.requiredPropsFirst),this.sortPropsAlphabetically=argValueToBoolean(a.sortPropsAlphabetically),this.sortEnumValuesAlphabetically=argValueToBoolean(a.sortEnumValuesAlphabetically),this.sortOperationsAlphabetically=argValueToBoolean(a.sortOperationsAlphabetically),this.sortTagsAlphabetically=argValueToBoolean(a.sortTagsAlphabetically),this.noAutoAuth=argValueToBoolean(a.noAutoAuth),this.nativeScrollbars=argValueToBoolean(a.nativeScrollbars),this.pathInMiddlePanel=argValueToBoolean(a.pathInMiddlePanel),this.untrustedDefinition=argValueToBoolean(a.untrustedDefinition),this.hideDownloadButton=void 0===a.hideDownloadButton?null:argValueToBoolean(a.hideDownloadButton),this.downloadDefinitionUrl=a.downloadDefinitionUrl,this.hideInfoDescription=argValueToBoolean(a.hideInfoDescription),this.disableSearch=argValueToBoolean(a.disableSearch),this.onlyRequiredInSamples=argValueToBoolean(a.onlyRequiredInSamples),this.generatedPayloadSamplesMaxDepth=argValueToInt(a.generatedPayloadSamplesMaxDepth)||8,this.sendXUserAgentInTryIt=argValueToBoolean(a.sendXUserAgentInTryIt),this.showExtensions=e.normalizeShowExtensions(a.showExtensions),this.hideSingleRequestSampleTab=argValueToBoolean(a.hideSingleRequestSampleTab),this.hideRequestPayloadSample=argValueToBoolean(a.hideRequestPayloadSample),this.menuToggle=argValueToBoolean(a.menuToggle,!0),this.jsonSampleExpandLevel=argValueToExpandLevel(a.jsonSampleExpandLevel,2),this.enumSkipQuotes=argValueToBoolean(a.enumSkipQuotes),this.hideSchemaTitles=argValueToBoolean(a.hideSchemaTitles),this.simpleOneOfTypeLabel=argValueToBoolean(a.simpleOneOfTypeLabel),this.payloadSampleIdx=e.normalizePayloadSampleIdx(a.payloadSampleIdx),this.expandSingleSchemaField=argValueToBoolean(a.expandSingleSchemaField),this.schemaExpansionLevel=argValueToExpandLevel(a.schemaExpansionLevel),this.samplesTabsMaxCount=argValueToInt(a.samplesTabsMaxCount)||5,this.unstable_tryItButtonOverride=a.unstable_tryItButtonOverride||null,this.unstable_ignoreMimeParameters=argValueToBoolean(a.unstable_ignoreMimeParameters),this.allowedMdComponents=a.allowedMdComponents||{},this.expandDefaultServerVariables=argValueToBoolean(a.expandDefaultServerVariables),this.expandDefaultRequest=argValueToBoolean(a.expandDefaultRequest,!0),this.expandDefaultResponse=argValueToBoolean(a.expandDefaultResponse,!0),this.maxDisplayedEnumValues=argValueToNumber(a.maxDisplayedEnumValues);var p=Array.isArray(a.ignoreNamedSchemas)?a.ignoreNamedSchemas:null===(s=a.ignoreNamedSchemas)||void 0===s?void 0:s.split(",").map((function(e){return e.trim()}));this.ignoreNamedSchemas=new Set(p),this.unstable_externalCodeSamples=a.unstable_externalCodeSamples||[],this.hooks=a.hooks||{},this.hooks.ReplaceTryItAuthPanel&&!this.hooks.ReplaceTryItSecurityPanel&&(console.warn("[warn] ReplaceTryItAuthPanel is deprecated, use ReplaceTryItSecurityPanel instead"),this.hooks.ReplaceTryItSecurityPanel=this.hooks.ReplaceTryItAuthPanel),this.hideSchemaPattern=argValueToBoolean(a.hideSchemaPattern),this.hideOneOfDescription=argValueToBoolean(a.hideOneOfDescription),this.hideFab=argValueToBoolean(a.hideFab),this.schemaDefinitionsTagName=a.schemaDefinitionsTagName,this.minCharacterLengthToInitSearch=argValueToNumber(a.minCharacterLengthToInitSearch)||3,this.maxResponseHeadersToShowInTryIt=argValueToNumber(a.maxResponseHeadersToShowInTryIt)||0,this.showObjectSchemaExamples=argValueToBoolean(a.showObjectSchemaExamples)}return Object.defineProperty(e,"normalizeExpandResponses",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if("all"===e)return"all";if("string"==typeof e){var a={};return e.split(",").forEach((function(e){a[e.trim()]=!0})),a}return void 0!==e&&console.warn('expandResponses must be a string but received value "'+e+'" of type '+typeof e),{}}}),Object.defineProperty(e,"normalizeHideHostname",{enumerable:!1,configurable:!0,writable:!0,value:function(e){return!!e}}),Object.defineProperty(e,"normalizeScrollYOffset",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if("string"==typeof e&&!isNumeric(e)){var a=querySelector(e);a||console.warn("scrollYOffset value is a selector to non-existing element. Using offset 0 by default");var t=a&&a.getBoundingClientRect().bottom||0;return function(){return t}}return"number"==typeof e||isNumeric(e)?function(){return"number"==typeof e?e:parseFloat(e)}:"function"==typeof e?function(){var a=e();return"number"!=typeof a&&console.warn('scrollYOffset should return number but returned value "'+a+'" of type '+typeof a),a}:(void 0!==e&&console.warn("Wrong value for scrollYOffset ReDoc option: should be string, number or function"),function(){return 0})}}),Object.defineProperty(e,"normalizeShowExtensions",{enumerable:!1,configurable:!0,writable:!0,value:function(e){if(void 0===e)return!1;if(""===e)return!0;if("string"!=typeof e)return e;switch(e){case"true":return!0;case"false":return!1;default:return e.split(",").map((function(e){return e.trim()}))}}}),Object.defineProperty(e,"normalizePayloadSampleIdx",{enumerable:!1,configurable:!0,writable:!0,value:function(e){return"number"==typeof e?Math.max(0,e):"string"==typeof e&&isFinite(e)?parseInt(e,10):0}}),__decorate([observable],e.prototype,"showConsole",void 0),e}();export{RedocNormalizedOptions};
|
|
2
2
|
//# sourceMappingURL=RedocNormalizedOptions.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__decorate}from"tslib";import{action,observable,makeObservable}from"mobx";import{safeSlugify}from"../../utils";import{MarkdownRenderer}from"../MarkdownRenderer";var GroupModel=function(){function e(e,t,r){Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"absoluteIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"parent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"active",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"depth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"level",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this),this.id=t.id||e+"/"+safeSlugify(t.name),this.type=e,this.name=t["x-displayName"]||t.name,this.level=t.level||1,this.description=t.description||"";var i=t.items;i&&i.length&&(this.description=MarkdownRenderer.getTextBeforeHading(this.description,i[0].name)),this.parent=r,this.externalDocs=t.externalDocs,"group"===this.type&&(this.expanded=!0)}return Object.defineProperty(e.prototype,"activate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!0}}),Object.defineProperty(e.prototype,"expand",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.parent&&this.parent.expand(),this.expanded=!0}}),Object.defineProperty(e.prototype,"collapse",{enumerable:!1,configurable:!0,writable:!0,value:function(){"group"!==this.type&&(this.expanded=!1)}}),Object.defineProperty(e.prototype,"deactivate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!1}}),__decorate([observable],e.prototype,"active",void 0),__decorate([observable],e.prototype,"expanded",void 0),__decorate([action],e.prototype,"activate",null),__decorate([action],e.prototype,"expand",null),__decorate([action],e.prototype,"collapse",null),__decorate([action],e.prototype,"deactivate",null),e}();export{GroupModel};
|
|
1
|
+
import{__decorate}from"tslib";import{action,observable,makeObservable}from"mobx";import{safeSlugify}from"../../utils";import{MarkdownRenderer}from"../MarkdownRenderer";var GroupModel=function(){function e(e,t,r){Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"absoluteIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isSchema",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"parent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"active",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"depth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"level",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this),this.id=t.id||e+"/"+safeSlugify(t.name),this.type=e,this.name=t["x-displayName"]||t.name,this.level=t.level||1,this.isSchema=t.isSchema,this.description=t.description||"";var i=t.items;i&&i.length&&(this.description=MarkdownRenderer.getTextBeforeHading(this.description,i[0].name)),this.parent=r,this.externalDocs=t.externalDocs,"group"===this.type&&(this.expanded=!0)}return Object.defineProperty(e.prototype,"activate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!0}}),Object.defineProperty(e.prototype,"expand",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.parent&&this.parent.expand(),this.expanded=!0}}),Object.defineProperty(e.prototype,"collapse",{enumerable:!1,configurable:!0,writable:!0,value:function(){"group"!==this.type&&(this.expanded=!1)}}),Object.defineProperty(e.prototype,"deactivate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!1}}),__decorate([observable],e.prototype,"active",void 0),__decorate([observable],e.prototype,"expanded",void 0),__decorate([action],e.prototype,"activate",null),__decorate([action],e.prototype,"expand",null),__decorate([action],e.prototype,"collapse",null),__decorate([action],e.prototype,"deactivate",null),e}();export{GroupModel};
|
|
2
2
|
//# sourceMappingURL=Group.model.js.map
|
|
@@ -82,6 +82,7 @@ export declare class OperationModel implements IMenuItem {
|
|
|
82
82
|
get parameters(): FieldModel[];
|
|
83
83
|
get responses(): ResponseModel[];
|
|
84
84
|
get callbacks(): CallbackModel[];
|
|
85
|
+
get hideTryItPanel(): boolean;
|
|
85
86
|
setActiveServer(activeServer: Server): void;
|
|
86
87
|
private generateCodeSamples;
|
|
87
88
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__decorate}from"tslib";import{action,makeObservable,observable}from"mobx";import{SecurityRequirementModel}from"./SecurityRequirement";import{extractExtensions,getOperationSummary,getStatusCodeType,isStatusCode,memoize,mergeParams,normalizeServers,sanitizeItemId,sortByField,sortByRequired}from"../../utils";import{CallbackModel}from"./Callback";import{FieldModel}from"./Field";import{RequestBodyModel}from"./RequestBody";import{ResponseModel}from"./Response";import{getCodeSample}from"../../../../services/code-samples/generator";import{getInitialServerWithVariables}from"../../../../components/console/utils";export function isPayloadSample(e){return"payload"===e.lang&&"requestBodyContent"in e}var isCodeSamplesWarningPrinted=!1,OperationModel=function(){function e(e,t,i,r,o){var a,n;void 0===o&&(o=!1),Object.defineProperty(this,"parser",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"operationDefinition",{enumerable:!0,configurable:!0,writable:!0,value:t}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"absoluteIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"href",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:"operation"}),Object.defineProperty(this,"parent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"depth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"ready",{enumerable:!0,configurable:!0,writable:!0,value:!0}),Object.defineProperty(this,"active",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"activeMimeName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeExampleName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeServer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"defaultExampleName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"defaultMimeType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"pointer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"operationId",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"httpVerb",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"deprecated",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"path",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"servers",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"security",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"extensions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isCallback",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isWebhook",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isEvent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this),this.pointer=t.pointer,this.description=t.description,this.parent=i,this.externalDocs=t.externalDocs,this.deprecated=!!t.deprecated,this.httpVerb=t.httpVerb,this.deprecated=!!t.deprecated,this.operationId=t.operationId,this.path=t.pathName,this.isCallback=o,this.isWebhook=t.isWebhook,this.isEvent=this.isCallback||this.isWebhook,this.name=getOperationSummary(t),this.defaultExampleName=t.defaultSampleName;var l=null===(n=null===(a=this.requestBody)||void 0===a?void 0:a.content)||void 0===n?void 0:n.mediaTypes,s=(l||[])[0],p=Object.keys((null==s?void 0:s.examples)||[])[0];this.activeExampleName=!1!==t.defaultSampleName&&(t.defaultSampleName||p),this.defaultMimeType=t.defaultMimeType;var u=null==l?void 0:l.find((function(e){return e.name===t.defaultMimeType}));this.activeMimeName=(null==u?void 0:u.name)||(null==s?void 0:s.name),this.isCallback?(this.security=(t.security||[]).map((function(t){return new SecurityRequirementModel(t,e)})),this.servers=normalizeServers("",t.servers||t.pathServers||[])):(this.id=sanitizeItemId(void 0!==t.operationId?"operation/"+t.operationId:void 0!==i?i.id+this.pointer:this.pointer),this.security=(t.security||e.definition.security||[]).map((function(t){return new SecurityRequirementModel(t,e)})),this.servers=normalizeServers(e.definitionUrl,t.servers||t.pathServers||e.definition.servers||[])),r.showExtensions&&(this.extensions=extractExtensions(t,r.showExtensions)),this.activeServer=getInitialServerWithVariables(this.servers)}return Object.defineProperty(e.prototype,"activate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!0}}),Object.defineProperty(e.prototype,"deactivate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!1}}),Object.defineProperty(e.prototype,"toggle",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.expanded=!this.expanded}}),Object.defineProperty(e.prototype,"activateMimeName",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.activeMimeName=e}}),Object.defineProperty(e.prototype,"activateExampleName",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.activeExampleName=e}}),Object.defineProperty(e.prototype,"expand",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.parent&&this.parent.expand()}}),Object.defineProperty(e.prototype,"collapse",{enumerable:!1,configurable:!0,writable:!0,value:function(){}}),Object.defineProperty(e.prototype,"requestBody",{get:function(){return this.operationDefinition.requestBody&&new RequestBodyModel({parser:this.parser,infoOrRef:this.operationDefinition.requestBody,options:this.options,operation:this,isEvent:this.isEvent})},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"payload",{get:function(){var e,t=null===(e=this.requestBody)||void 0===e?void 0:e.content;return(null==t?void 0:t.hasSample)?{lang:"payload",label:"Payload",source:"",requestBodyContent:t}:void 0},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"hasSamples",{get:function(){var e,t;return(null===(t=null===(e=this.requestBody)||void 0===e?void 0:e.content)||void 0===t?void 0:t.hasSample)||this.definitionSamples.length>0},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"definitionSamples",{get:function(){var e=this.operationDefinition["x-codeSamples"]||this.operationDefinition["x-code-samples"]||[];return this.operationDefinition["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),e},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"allCodeSamples",{get:function(){var e,t=this.options,i=t.payloadSampleIdx,r=t.hideRequestPayloadSample,o=[];if(!this.isWebhook){var a=this.options.generateCodeSamples||{},n=new Set(this.definitionSamples.map((function(e){return e.lang.toLowerCase()}))),l=(null===(e=a.languages)||void 0===e?void 0:e.filter((function(e){var t=e.lang;return!n.has(t.toLowerCase())})))||[];o=this.generateCodeSamples(l,a)}var s=this.definitionSamples.concat(o),p=Math.min(s.length,i);return this.payload&&!r&&s.splice(p,0,this.payload),s},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"parameters",{get:function(){var e=this,t=mergeParams(this.parser,this.operationDefinition.pathParameters,this.operationDefinition.parameters).map((function(t){return new FieldModel(e.parser,t,e.pointer,e.options,void 0,{operation:e,type:"request"})}));return this.options.sortPropsAlphabetically?sortByField(t,"name"):this.options.requiredPropsFirst?sortByRequired(t):t},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"responses",{get:function(){var e=this,t=!1;return Object.keys(this.operationDefinition.responses||[]).filter((function(e){return"default"===e||("success"===getStatusCodeType(e)&&(t=!0),isStatusCode(e))})).map((function(i){return new ResponseModel({parser:e.parser,code:i,defaultAsError:t,infoOrRef:e.operationDefinition.responses[i],options:e.options,isEvent:e.isEvent,operation:e})}))},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"callbacks",{get:function(){var e=this;return Object.keys(this.operationDefinition.callbacks||[]).map((function(t){var i;return new CallbackModel(e.parser,t,null===(i=e.operationDefinition.callbacks)||void 0===i?void 0:i[t],e.pointer,e.options)}))},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"setActiveServer",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.activeServer=e}}),Object.defineProperty(e.prototype,"generateCodeSamples",{enumerable:!1,configurable:!0,writable:!0,value:function(e,t){var i=this,r=t.skipOptionalParameters,o=t.withOAuth2Call;return e.map((function(e){var t=e.lang,a=e.label,n=e.options;return{lang:t,label:a,get:function(e){return getCodeSample(__assign(__assign({},e),{lang:t,options:__assign(__assign({},n),{skipOptionalParameters:r,withOAuth2Call:o,spec:i.parser.definition,generatedPayloadSamplesMaxDepth:i.options.generatedPayloadSamplesMaxDepth})}))}}}))}}),__decorate([observable],e.prototype,"ready",void 0),__decorate([observable],e.prototype,"active",void 0),__decorate([observable],e.prototype,"expanded",void 0),__decorate([observable],e.prototype,"activeMimeName",void 0),__decorate([observable],e.prototype,"activeExampleName",void 0),__decorate([observable.ref],e.prototype,"activeServer",void 0),__decorate([action],e.prototype,"activate",null),__decorate([action],e.prototype,"deactivate",null),__decorate([action],e.prototype,"toggle",null),__decorate([action],e.prototype,"activateMimeName",null),__decorate([action],e.prototype,"activateExampleName",null),__decorate([memoize],e.prototype,"requestBody",null),__decorate([memoize],e.prototype,"payload",null),__decorate([memoize],e.prototype,"hasSamples",null),__decorate([memoize],e.prototype,"definitionSamples",null),__decorate([memoize],e.prototype,"allCodeSamples",null),__decorate([memoize],e.prototype,"parameters",null),__decorate([memoize],e.prototype,"responses",null),__decorate([memoize],e.prototype,"callbacks",null),__decorate([action],e.prototype,"setActiveServer",null),e}();export{OperationModel};
|
|
1
|
+
import{__assign,__decorate}from"tslib";import{action,makeObservable,observable}from"mobx";import{SecurityRequirementModel}from"./SecurityRequirement";import{extractExtensions,getOperationSummary,getStatusCodeType,isStatusCode,memoize,mergeParams,normalizeServers,sanitizeItemId,sortByField,sortByRequired}from"../../utils";import{CallbackModel}from"./Callback";import{FieldModel}from"./Field";import{RequestBodyModel}from"./RequestBody";import{ResponseModel}from"./Response";import{getCodeSample}from"../../../../services/code-samples/generator";import{getInitialServerWithVariables}from"../../../../components/console/utils";export function isPayloadSample(e){return"payload"===e.lang&&"requestBodyContent"in e}var isCodeSamplesWarningPrinted=!1,OperationModel=function(){function e(e,t,i,r,o){var a,n;void 0===o&&(o=!1),Object.defineProperty(this,"parser",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"operationDefinition",{enumerable:!0,configurable:!0,writable:!0,value:t}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"absoluteIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"href",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:"operation"}),Object.defineProperty(this,"parent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"depth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"ready",{enumerable:!0,configurable:!0,writable:!0,value:!0}),Object.defineProperty(this,"active",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"activeMimeName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeExampleName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeServer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"defaultExampleName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"defaultMimeType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"pointer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"operationId",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"httpVerb",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"deprecated",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"path",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"servers",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"security",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"extensions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isCallback",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isWebhook",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isEvent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this),this.pointer=t.pointer,this.description=t.description,this.parent=i,this.externalDocs=t.externalDocs,this.deprecated=!!t.deprecated,this.httpVerb=t.httpVerb,this.deprecated=!!t.deprecated,this.operationId=t.operationId,this.path=t.pathName,this.isCallback=o,this.isWebhook=t.isWebhook,this.isEvent=this.isCallback||this.isWebhook,this.name=getOperationSummary(t),this.defaultExampleName=t.defaultSampleName;var l=null===(n=null===(a=this.requestBody)||void 0===a?void 0:a.content)||void 0===n?void 0:n.mediaTypes,s=(l||[])[0],p=Object.keys((null==s?void 0:s.examples)||[])[0];this.activeExampleName=!1!==t.defaultSampleName&&(t.defaultSampleName||p),this.defaultMimeType=t.defaultMimeType;var u=null==l?void 0:l.find((function(e){return e.name===t.defaultMimeType}));this.activeMimeName=(null==u?void 0:u.name)||(null==s?void 0:s.name),this.isCallback?(this.security=(t.security||[]).map((function(t){return new SecurityRequirementModel(t,e)})),this.servers=normalizeServers("",t.servers||t.pathServers||[])):(this.id=sanitizeItemId(void 0!==t.operationId?"operation/"+t.operationId:void 0!==i?i.id+this.pointer:this.pointer),this.security=(t.security||e.definition.security||[]).map((function(t){return new SecurityRequirementModel(t,e)})),this.servers=normalizeServers(e.definitionUrl,t.servers||t.pathServers||e.definition.servers||[])),r.showExtensions&&(this.extensions=extractExtensions(t,r.showExtensions)),this.activeServer=getInitialServerWithVariables(this.servers)}return Object.defineProperty(e.prototype,"activate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!0}}),Object.defineProperty(e.prototype,"deactivate",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.active=!1}}),Object.defineProperty(e.prototype,"toggle",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.expanded=!this.expanded}}),Object.defineProperty(e.prototype,"activateMimeName",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.activeMimeName=e}}),Object.defineProperty(e.prototype,"activateExampleName",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.activeExampleName=e}}),Object.defineProperty(e.prototype,"expand",{enumerable:!1,configurable:!0,writable:!0,value:function(){this.parent&&this.parent.expand()}}),Object.defineProperty(e.prototype,"collapse",{enumerable:!1,configurable:!0,writable:!0,value:function(){}}),Object.defineProperty(e.prototype,"requestBody",{get:function(){return this.operationDefinition.requestBody&&new RequestBodyModel({parser:this.parser,infoOrRef:this.operationDefinition.requestBody,options:this.options,operation:this,isEvent:this.isEvent})},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"payload",{get:function(){var e,t=null===(e=this.requestBody)||void 0===e?void 0:e.content;return(null==t?void 0:t.hasSample)?{lang:"payload",label:"Payload",source:"",requestBodyContent:t}:void 0},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"hasSamples",{get:function(){var e,t;return(null===(t=null===(e=this.requestBody)||void 0===e?void 0:e.content)||void 0===t?void 0:t.hasSample)||this.definitionSamples.length>0},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"definitionSamples",{get:function(){var e=this.operationDefinition["x-codeSamples"]||this.operationDefinition["x-code-samples"]||[];return this.operationDefinition["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),e},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"allCodeSamples",{get:function(){var e,t=this.options,i=t.payloadSampleIdx,r=t.hideRequestPayloadSample,o=[];if(!this.isWebhook){var a=this.options.generateCodeSamples||{},n=new Set(this.definitionSamples.map((function(e){return e.lang.toLowerCase()}))),l=(null===(e=a.languages)||void 0===e?void 0:e.filter((function(e){var t=e.lang;return!n.has(t.toLowerCase())})))||[];o=this.generateCodeSamples(l,a)}var s=this.definitionSamples.concat(o),p=Math.min(s.length,i);return this.payload&&!r&&s.splice(p,0,this.payload),s},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"parameters",{get:function(){var e=this,t=mergeParams(this.parser,this.operationDefinition.pathParameters,this.operationDefinition.parameters).map((function(t){return new FieldModel(e.parser,t,e.pointer,e.options,void 0,{operation:e,type:"request"})}));return this.options.sortPropsAlphabetically?sortByField(t,"name"):this.options.requiredPropsFirst?sortByRequired(t):t},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"responses",{get:function(){var e=this,t=!1;return Object.keys(this.operationDefinition.responses||[]).filter((function(e){return"default"===e||("success"===getStatusCodeType(e)&&(t=!0),isStatusCode(e))})).map((function(i){return new ResponseModel({parser:e.parser,code:i,defaultAsError:t,infoOrRef:e.operationDefinition.responses[i],options:e.options,isEvent:e.isEvent,operation:e})}))},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"callbacks",{get:function(){var e=this;return Object.keys(this.operationDefinition.callbacks||[]).map((function(t){var i;return new CallbackModel(e.parser,t,null===(i=e.operationDefinition.callbacks)||void 0===i?void 0:i[t],e.pointer,e.options)}))},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"hideTryItPanel",{get:function(){return!0===this.operationDefinition["x-hideTryItPanel"]},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"setActiveServer",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.activeServer=e}}),Object.defineProperty(e.prototype,"generateCodeSamples",{enumerable:!1,configurable:!0,writable:!0,value:function(e,t){var i=this,r=t.skipOptionalParameters,o=t.withOAuth2Call;return e.map((function(e){var t=e.lang,a=e.label,n=e.options;return{lang:t,label:a,get:function(e){return getCodeSample(__assign(__assign({},e),{lang:t,options:__assign(__assign({},n),{skipOptionalParameters:r,withOAuth2Call:o,spec:i.parser.definition,generatedPayloadSamplesMaxDepth:i.options.generatedPayloadSamplesMaxDepth})}))}}}))}}),__decorate([observable],e.prototype,"ready",void 0),__decorate([observable],e.prototype,"active",void 0),__decorate([observable],e.prototype,"expanded",void 0),__decorate([observable],e.prototype,"activeMimeName",void 0),__decorate([observable],e.prototype,"activeExampleName",void 0),__decorate([observable.ref],e.prototype,"activeServer",void 0),__decorate([action],e.prototype,"activate",null),__decorate([action],e.prototype,"deactivate",null),__decorate([action],e.prototype,"toggle",null),__decorate([action],e.prototype,"activateMimeName",null),__decorate([action],e.prototype,"activateExampleName",null),__decorate([memoize],e.prototype,"requestBody",null),__decorate([memoize],e.prototype,"payload",null),__decorate([memoize],e.prototype,"hasSamples",null),__decorate([memoize],e.prototype,"definitionSamples",null),__decorate([memoize],e.prototype,"allCodeSamples",null),__decorate([memoize],e.prototype,"parameters",null),__decorate([memoize],e.prototype,"responses",null),__decorate([memoize],e.prototype,"callbacks",null),__decorate([memoize],e.prototype,"hideTryItPanel",null),__decorate([action],e.prototype,"setActiveServer",null),e}();export{OperationModel};
|
|
2
2
|
//# sourceMappingURL=Operation.js.map
|
|
@@ -11,6 +11,10 @@ export interface OpenAPIDefinition {
|
|
|
11
11
|
externalDocs?: OpenAPIExternalDocumentation;
|
|
12
12
|
'x-webhooks'?: OpenAPIPaths;
|
|
13
13
|
webhooks?: OpenAPIPaths;
|
|
14
|
+
'x-tagGroups'?: Array<{
|
|
15
|
+
name: string;
|
|
16
|
+
tags: Array<string>;
|
|
17
|
+
}>;
|
|
14
18
|
}
|
|
15
19
|
export interface OpenAPIInfo {
|
|
16
20
|
title: string;
|
|
@@ -309,3 +313,6 @@ export interface OpenAPILicense {
|
|
|
309
313
|
url?: string;
|
|
310
314
|
identifier?: string;
|
|
311
315
|
}
|
|
316
|
+
export interface ParsedDocument extends OpenAPIDefinition {
|
|
317
|
+
swagger: unknown;
|
|
318
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__spreadArray}from"tslib";import{dirname}from"path";import UrlTemplate from"url-template";import{IS_BROWSER}from"./dom";import{isNumeric,removeQueryString,resolveUrl}from"./helpers";function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}export function isStatusCode(e){return"default"===e||isNumeric(e)||isWildcardStatusCode(e)}export function getStatusCodeType(e,r){if(void 0===r&&(r=!1),"default"===e)return r?"error":"success";var t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");var i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}var operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};export function isOperationName(e){return e in operationNames}export function getOperationSummary(e){return e.summary||e.operationId||e.description&&e.description.substring(0,50)||"<no summary>"}var schemaKeywordTypes={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",unevaluatedProperties:"object",properties:"object"};export function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;for(var r=0,t=Object.keys(schemaKeywordTypes);r<t.length;r++){var i=t[r],n=schemaKeywordTypes[i];if(void 0!==e[i])return n}return"any"}export function isPrimitiveType(e,r){if(void 0===r&&(r=e.type),void 0!==e.oneOf||void 0!==e.anyOf)return!1;var t=!0,i=Array.isArray(r);return("object"===r||i&&(null==r?void 0:r.includes("object")))&&(t=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties),void 0!==e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t}export function isJsonLike(e){return-1!==e.search(/json/i)}export function isFormUrlEncoded(e){return"application/x-www-form-urlencoded"===e}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((function(e){return e.toString()})).join(t):"object"==typeof e?Object.keys(e).map((function(r){return""+r+t+e[r]})).join(t):r+"="+e.toString()}function deepObjectEncodeField(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?Object.keys(e).map((function(t){return e[t]?r+"["+t+"]="+e[t]:void 0})).filter(Boolean).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function serializeFormValue(e,r,t){var i,n="__redoc_param_name__",a=r?"*":"";return UrlTemplate.parse("{?"+n+a+"}").expand((i={},i[n]=t,i)).substring(1).replace(/__redoc_param_name__/g,e)}export function urlFormEncodePayload(e,r){if(void 0===r&&(r={}),Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((function(t){var i=e[t],n=r[t]||{},a=n.style,o=void 0===a?"form":a,s=n.explode,u=void 0===s||s;switch(o){case"form":return serializeFormValue(t,u,i);case"spaceDelimited":return delimitedEncodeField(i,t,"%20");case"pipeDelimited":return delimitedEncodeField(i,t,"|");case"deepObject":return deepObjectEncodeField(i,t);default:return console.warn("Incorrect or unsupported encoding style: "+o),""}})).join("&")}function serializePathParameter(e,r,t,i){var n,a=t?"*":"",o="";"label"===r?o=".":"matrix"===r&&(o=";");var s="__redoc_param_name__";return UrlTemplate.parse("{"+o+s+a+"}").expand((n={},n[s]=i,n)).replace(/__redoc_param_name__/g,e)}export function serializeQueryParameter(e,r,t,i){switch(r){case"form":return serializeFormValue(e,t,i);case"spaceDelimited":return Array.isArray(i)?t?serializeFormValue(e,t,i):e+"="+i.join("%20"):(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(i)?t?serializeFormValue(e,t,i):e+"="+i.join("|"):(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!t||Array.isArray(i)||"object"!=typeof i?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(i,e);default:return console.warn("Unexpected style for query: "+r),""}}function serializeHeaderParameter(e,r,t){var i;if("simple"===e){var n=r?"*":"",a="__redoc_param_name__",o=UrlTemplate.parse("{"+a+n+"}");return decodeURIComponent(o.expand(((i={})[a]=t,i)))}return console.warn("Unexpected style for header: "+e),""}function serializeCookieParameter(e,r,t,i){return"form"===r?serializeFormValue(e,t,i):(console.warn("Unexpected style for cookie: "+r),"")}export function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn("Parameter serialization as "+r+" is not supported"),"")}export function serializeParameterValue(e,r){var t=e.name,i=e.style,n=e.explode,a=void 0!==n&&n,o=e.serializationMime;if(o)switch(e.in){case"path":case"header":return serializeParameterValueWithMime(r,o);case"cookie":case"query":return t+"="+serializeParameterValueWithMime(r,o);default:return console.warn("Unexpected parameter location: "+e.in),""}if(!i)return console.warn("Missing style attribute or content for parameter "+t),"";switch(e.in){case"path":return serializePathParameter(t,i,a,r);case"query":return serializeQueryParameter(t,i,a,r);case"header":return serializeHeaderParameter(i,a,r);case"cookie":return serializeCookieParameter(t,i,a,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}export function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}var DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;export function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}export function getDefinitionName(e){var r;return null===(r=null==e?void 0:e.match(DEFINITION_NAME_REGEX))||void 0===r?void 0:r.pop()}function humanizeMultipleOfConstraint(e){if(void 0!==e){var r=e.toString(10);return/^0\.0*1$/.test(r)?"decimal places <= "+r.split(".")[1].length:"multiple of "+r}}function humanizeRangeConstraint(e,r,t){var i;return void 0!==r&&void 0!==t?i=r===t?r+" "+e:"[ "+r+" .. "+t+" ] "+e:void 0!==t?i="<= "+t+" "+e:void 0!==r&&(i=1===r?"non-empty":">= "+r+" "+e),i}export function humanizeNumberRange(e){var r,t,i="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!==(r=e.minimum)&&void 0!==r?r:1/0):e.minimum,n="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!==(t=e.maximum)&&void 0!==t?t:-1/0):e.maximum,a="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,o="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?(a?"( ":"[ ")+i+" .. "+n+(o?" )":" ]"):void 0!==n?(o?"< ":"<= ")+n:void 0!==i?(a?"> ":">= ")+i:void 0}export function humanizeConstraints(e){var r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);var i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);var n=humanizeMultipleOfConstraint(e.multipleOf);void 0!==n&&r.push(n);var a=humanizeNumberRange(e);return void 0!==a&&r.push(a),e.uniqueItems&&r.push("unique"),r}export function sortByRequired(e,r){void 0===r&&(r=[]);var t=[],i=[],n=[];return e.forEach((function(e){e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort((function(e,t){return r.indexOf(e.name)-r.indexOf(t.name)})),__spreadArray(__spreadArray(__spreadArray([],i,!0),n,!0),t,!0)}export function sortByField(e,r){return __spreadArray([],e,!0).sort((function(e,t){return e[r].localeCompare(t[r])}))}export function mergeParams(e,r,t){void 0===r&&(r=[]),void 0===t&&(t=[]);var i={};return t.forEach((function(r){r=e.shallowDeref(r),i[r.name+"_"+r.in]=!0})),(r=r.filter((function(r){return r=e.shallowDeref(r),!i[r.name+"_"+r.in]}))).concat(t)}export function mergeSimilarMediaTypes(e){var r={};return Object.keys(e).forEach((function(t){var i=e[t],n=t.split(";")[0].trim();r[n]?r[n]=__assign(__assign({},r[n]),i):r[n]=i})),r}export function expandDefaultServerVariables(e,r){return void 0===r&&(r={}),e.replace(/(?:{)([\w-.]+)(?:})/g,(function(e,t){return r[t]&&r[t].default||e}))}export function normalizeServers(e,r){var t=void 0===e?removeQueryString(function(){if(!IS_BROWSER)return"";var e=window.location.href;return e.endsWith(".html")?dirname(e):e}()):dirname(e);return 0===r.length&&(r=[{url:"/"}]),r.map((function(e){return __assign(__assign({},e),{url:(r=e.url,resolveUrl(t,r)),description:e.description||""});var r}))}export var SECURITY_DEFINITIONS_COMPONENT_NAME="security-definitions";export var SECURITY_DEFINITIONS_JSX_NAME="SecurityDefinitions";export var SCHEMA_DEFINITION_JSX_NAME="SchemaDefinition";export var SECURITY_SCHEMES_SECTION_PREFIX="section/Authentication/";export function setSecuritySchemePrefix(e){SECURITY_SCHEMES_SECTION_PREFIX=e}export var shortenHTTPVerb=function(e){return{delete:"del",options:"opts"}[e]||e};export function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0}}export function extractExtensions(e,r){return Object.keys(e).filter((function(e){return!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1})).reduce((function(r,t){return r[t]=e[t],r}),{})}export function pluralizeType(e){return e.split(" or ").map((function(e){return e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2")})).join(" or ")}export function getContentWithLegacyExamples(e){var r=e.content,t=e["x-examples"],i=e["x-example"];if(t){r=__assign({},r);for(var n=0,a=Object.keys(t);n<a.length;n++){var o=t[c=a[n]];r[c]=__assign(__assign({},r[c]),{examples:o})}}else if(i){r=__assign({},r);for(var s=0,u=Object.keys(i);s<u.length;s++){var c,l=i[c=u[s]];r[c]=__assign(__assign({},r[c]),{example:l})}}return r}
|
|
1
|
+
import{__assign,__spreadArray}from"tslib";import{dirname}from"path";import UrlTemplate from"url-template";import{IS_BROWSER}from"./dom";import{isNumeric,removeQueryString,resolveUrl}from"./helpers";function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}export function isStatusCode(e){return"default"===e||isNumeric(e)||isWildcardStatusCode(e)}export function getStatusCodeType(e,r){if(void 0===r&&(r=!1),"default"===e)return r?"error":"success";var t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");var i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}var operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};export function isOperationName(e){return e in operationNames}export function getOperationSummary(e){return e.summary||e.operationId||e.description&&e.description.substring(0,50)||"<no summary>"}var schemaKeywordTypes={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",unevaluatedProperties:"object",properties:"object"};export function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;for(var r=0,t=Object.keys(schemaKeywordTypes);r<t.length;r++){var i=t[r],n=schemaKeywordTypes[i];if(void 0!==e[i])return n}return"any"}export function isPrimitiveType(e,r){if(void 0===r&&(r=e.type),void 0!==e.oneOf||void 0!==e.anyOf)return!1;var t=!0,i=Array.isArray(r);return("object"===r||i&&(null==r?void 0:r.includes("object")))&&(t=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties),void 0!==e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t}export function isJsonLike(e){return-1!==e.search(/json/i)}export function isFormUrlEncoded(e){return"application/x-www-form-urlencoded"===e}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((function(e){return e.toString()})).join(t):"object"==typeof e?Object.keys(e).map((function(r){return""+r+t+e[r]})).join(t):r+"="+e.toString()}function deepObjectEncodeField(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?Object.keys(e).map((function(t){return e[t]?r+"["+t+"]="+e[t]:void 0})).filter(Boolean).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function serializeFormValue(e,r,t){var i,n="__redoc_param_name__",a=r?"*":"";return UrlTemplate.parse("{?"+n+a+"}").expand((i={},i[n]=t,i)).substring(1).replace(/__redoc_param_name__/g,e)}export function urlFormEncodePayload(e,r){if(void 0===r&&(r={}),Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((function(t){var i=e[t],n=r[t]||{},a=n.style,o=void 0===a?"form":a,s=n.explode,u=void 0===s||s;switch(o){case"form":return serializeFormValue(t,u,i);case"spaceDelimited":return delimitedEncodeField(i,t,"%20");case"pipeDelimited":return delimitedEncodeField(i,t,"|");case"deepObject":return deepObjectEncodeField(i,t);default:return console.warn("Incorrect or unsupported encoding style: "+o),""}})).join("&")}function serializePathParameter(e,r,t,i){var n,a=t?"*":"",o="";"label"===r?o=".":"matrix"===r&&(o=";");var s="__redoc_param_name__";return UrlTemplate.parse("{"+o+s+a+"}").expand((n={},n[s]=i,n)).replace(/__redoc_param_name__/g,e)}export function serializeQueryParameter(e,r,t,i){switch(r){case"form":return serializeFormValue(e,t,i);case"spaceDelimited":return Array.isArray(i)?t?serializeFormValue(e,t,i):e+"="+i.join("%20"):(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(i)?t?serializeFormValue(e,t,i):e+"="+i.join("|"):(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!t||Array.isArray(i)||"object"!=typeof i?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(i,e);default:return console.warn("Unexpected style for query: "+r),""}}function serializeHeaderParameter(e,r,t){var i;if("simple"===e){var n=r?"*":"",a="__redoc_param_name__",o=UrlTemplate.parse("{"+a+n+"}");return decodeURIComponent(o.expand(((i={})[a]=t,i)))}return console.warn("Unexpected style for header: "+e),""}function serializeCookieParameter(e,r,t,i){return"form"===r?serializeFormValue(e,t,i):(console.warn("Unexpected style for cookie: "+r),"")}export function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn("Parameter serialization as "+r+" is not supported"),"")}export function serializeParameterValue(e,r){var t=e.name,i=e.style,n=e.explode,a=void 0!==n&&n,o=e.serializationMime;if(o)switch(e.in){case"path":case"header":return serializeParameterValueWithMime(r,o);case"cookie":case"query":return t+"="+serializeParameterValueWithMime(r,o);default:return console.warn("Unexpected parameter location: "+e.in),""}if(!i)return console.warn("Missing style attribute or content for parameter "+t),"";switch(e.in){case"path":return serializePathParameter(t,i,a,r);case"query":return serializeQueryParameter(t,i,a,r);case"header":return serializeHeaderParameter(i,a,r);case"cookie":return serializeCookieParameter(t,i,a,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}export function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}var DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;export function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}export function getDefinitionName(e){var r;return null===(r=null==e?void 0:e.match(DEFINITION_NAME_REGEX))||void 0===r?void 0:r.pop()}function humanizeMultipleOfConstraint(e){if(void 0!==e){var r=e.toString(10);return/^0\.0*1$/.test(r)?"decimal places <= "+r.split(".")[1].length:"multiple of "+r}}function humanizeRangeConstraint(e,r,t){var i;return void 0!==r&&void 0!==t?i=r===t?r+" "+e:"[ "+r+" .. "+t+" ] "+e:void 0!==t?i="<= "+t+" "+e:void 0!==r&&(i=1===r?"non-empty":">= "+r+" "+e),i}export function humanizeNumberRange(e){var r,t,i="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!==(r=e.minimum)&&void 0!==r?r:1/0):e.minimum,n="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!==(t=e.maximum)&&void 0!==t?t:-1/0):e.maximum,a="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,o="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?(a?"( ":"[ ")+i+" .. "+n+(o?" )":" ]"):void 0!==n?(o?"< ":"<= ")+n:void 0!==i?(a?"> ":">= ")+i:void 0}export function humanizeConstraints(e){var r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);var i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);var n=humanizeMultipleOfConstraint(e.multipleOf);void 0!==n&&r.push(n);var a=humanizeNumberRange(e);return void 0!==a&&r.push(a),e.uniqueItems&&r.push("unique"),r}export function sortByRequired(e,r){void 0===r&&(r=[]);var t=[],i=[],n=[];return e.forEach((function(e){e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort((function(e,t){return r.indexOf(e.name)-r.indexOf(t.name)})),__spreadArray(__spreadArray(__spreadArray([],i,!0),n,!0),t,!0)}export function sortByField(e,r){return __spreadArray([],e,!0).sort((function(e,t){return e[r].localeCompare(t[r])}))}export function mergeParams(e,r,t){void 0===r&&(r=[]),void 0===t&&(t=[]);var i={};return t.forEach((function(r){r=e.shallowDeref(r),i[r.name+"_"+r.in]=!0})),(r=r.filter((function(r){return r=e.shallowDeref(r),!i[r.name+"_"+r.in]}))).concat(t)}export function mergeSimilarMediaTypes(e){var r={};return Object.keys(e).forEach((function(t){var i=e[t],n=t.split(";")[0].trim();r[n]?r[n]=__assign(__assign({},r[n]),i):r[n]=i})),r}export function expandDefaultServerVariables(e,r){return void 0===r&&(r={}),e.replace(/(?:{)([\w-.]+)(?:})/g,(function(e,t){return r[t]&&r[t].default||e}))}export function normalizeServers(e,r){var t=void 0===e?removeQueryString(function(){if(!IS_BROWSER)return"";var e=window.location.href;return e.endsWith(".html")?dirname(e):e}()):dirname(e);return 0===r.length&&(r=[{url:"/"}]),r.map((function(e){return __assign(__assign({},e),{url:(r=e.url,resolveUrl(t,r)),description:e.description||""});var r}))}export var SECURITY_DEFINITIONS_COMPONENT_NAME="security-definitions";export var SECURITY_DEFINITIONS_JSX_NAME="SecurityDefinitions";export var SCHEMA_DEFINITION_JSX_NAME="SchemaDefinition";export var SECURITY_SCHEMES_SECTION_PREFIX="section/Authentication/";export function setSecuritySchemePrefix(e){SECURITY_SCHEMES_SECTION_PREFIX=e}export var shortenHTTPVerb=function(e){return{delete:"del",options:"opts"}[e]||e};export function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-hideTryItPanel":!0}}export function extractExtensions(e,r){return Object.keys(e).filter((function(e){return!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1})).reduce((function(r,t){return r[t]=e[t],r}),{})}export function pluralizeType(e){return e.split(" or ").map((function(e){return e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2")})).join(" or ")}export function getContentWithLegacyExamples(e){var r=e.content,t=e["x-examples"],i=e["x-example"];if(t){r=__assign({},r);for(var n=0,a=Object.keys(t);n<a.length;n++){var o=t[c=a[n]];r[c]=__assign(__assign({},r[c]),{examples:o})}}else if(i){r=__assign({},r);for(var s=0,u=Object.keys(i);s<u.length;s++){var c,l=i[c=u[s]];r[c]=__assign(__assign({},r[c]),{example:l})}}return r}
|
|
2
2
|
//# sourceMappingURL=openapi.js.map
|