@redocly/openapi-docs 0.83.0-rc.2 → 0.83.0-rc.4
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/dist/redocly-openapi-docs.min.js +1021 -1048
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +1 -1
- package/lib/components/RedoclyOpenAPIDocs/styled.d.ts +0 -2
- package/lib/components/RedoclyOpenAPIDocs/styled.js +4 -38
- package/lib/components/RedoclyOpenAPIDocs/types.d.ts +5 -4
- package/lib/components/RedoclyOpenAPIDocs/utils.d.ts +2 -2
- package/lib/components/SectionContent/SectionContent.js +3 -3
- package/lib/components/SideMenu/hooks/useMenuItems.js +1 -1
- package/lib/components/common/panels.js +3 -3
- package/lib/components/index.d.ts +0 -1
- package/lib/components/index.js +1 -1
- package/lib/icons/CurlIcon/CurlIcon.js +1 -1
- package/lib/icons/GOIcon/GOIcon.js +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/models/operation.js +1 -1
- package/lib/models/schema.js +1 -1
- package/lib/models/types.d.ts +1 -1
- package/lib/services/config-options/helpers.d.ts +3 -3
- package/lib/services/config-options/normalizeOptions.d.ts +3 -2
- package/lib/services/config-options/types.d.ts +0 -48
- package/lib/services/menu/operation.js +1 -1
- package/lib/standalone.d.ts +2 -2
- package/lib/utils/openapi.d.ts +1 -0
- package/lib/utils/openapi.js +1 -1
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +1 -1
- package/lib-esm/components/RedoclyOpenAPIDocs/styled.d.ts +0 -2
- package/lib-esm/components/RedoclyOpenAPIDocs/styled.js +2 -36
- package/lib-esm/components/RedoclyOpenAPIDocs/types.d.ts +5 -4
- package/lib-esm/components/RedoclyOpenAPIDocs/utils.d.ts +2 -2
- package/lib-esm/components/SectionContent/SectionContent.js +2 -2
- package/lib-esm/components/SideMenu/hooks/useMenuItems.js +1 -1
- package/lib-esm/components/common/panels.js +3 -3
- package/lib-esm/components/index.d.ts +0 -1
- package/lib-esm/components/index.js +1 -1
- package/lib-esm/icons/CurlIcon/CurlIcon.js +1 -1
- package/lib-esm/icons/GOIcon/GOIcon.js +1 -1
- package/lib-esm/index.d.ts +1 -1
- package/lib-esm/models/operation.js +1 -1
- package/lib-esm/models/schema.js +1 -1
- package/lib-esm/models/types.d.ts +1 -1
- package/lib-esm/services/config-options/helpers.d.ts +3 -3
- package/lib-esm/services/config-options/normalizeOptions.d.ts +3 -2
- package/lib-esm/services/config-options/types.d.ts +0 -48
- package/lib-esm/services/menu/operation.js +1 -1
- package/lib-esm/standalone.d.ts +2 -2
- package/lib-esm/utils/openapi.d.ts +1 -0
- package/lib-esm/utils/openapi.js +1 -1
- package/package.json +5 -4
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.RedoclyOpenAPIDocsStandalone=exports.RedoclyOpenAPIDocs=void 0;const jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),theme_1=require("@redocly/theme"),UnsupportedFeatureScreen_1=require("../UnsupportedFeatureScreen"),Providers_1=require("./Providers"),Overlay_1=require("../Overlay"),styled_1=require("./styled"),StickySidebar_1=require("../StickySidebar"),SideMenu_1=require("../SideMenu"),Content_1=require("../Content"),hooks_1=require("../../hooks"),withRouter_1=require("../../hoc/withRouter"),withStore_1=require("../../hoc/withStore"),utils_1=require("../../utils"),useLicense_1=require("../../hooks/useLicense"),RedoclyOpenAPIDocsComponent=(0,utils_1.compose)(withRouter_1.withRouter,withStore_1.withStore,react_1.memo)((({licenseKey:e,onLoaded:o,children:t,options:i,layout:n,collapsedSidebar:r,parser:s,withCommonStyles:l})=>{var d,u,a,c,_;const m=(0,react_1.useRef)(null),{isValid:p,licenseInfo:h}=(0,useLicense_1.useLicense)(e);(0,hooks_1.useUppercase2LowercaseRedirect)(),(0,theme_1.useMount)((()=>{null==o||o()}));const{hideSidebar:v,scrollYOffset:x}=i||{},{contentItems:y}=(0,hooks_1.useContentItems)({parser:s,options:i}),S=null===(u=null===(d=s.definition)||void 0===d?void 0:d.info)||void 0===u?void 0:u["x-logo"];return(0,jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment,{children:[l&&(0,jsx_runtime_1.jsx)(theme_1.GlobalStyle,{}),(0,jsx_runtime_1.jsxs)(styled_1.
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.RedoclyOpenAPIDocsStandalone=exports.RedoclyOpenAPIDocs=void 0;const jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),theme_1=require("@redocly/theme"),UnsupportedFeatureScreen_1=require("../UnsupportedFeatureScreen"),Providers_1=require("./Providers"),Overlay_1=require("../Overlay"),styled_1=require("./styled"),StickySidebar_1=require("../StickySidebar"),SideMenu_1=require("../SideMenu"),Content_1=require("../Content"),hooks_1=require("../../hooks"),withRouter_1=require("../../hoc/withRouter"),withStore_1=require("../../hoc/withStore"),utils_1=require("../../utils"),useLicense_1=require("../../hooks/useLicense"),RedoclyOpenAPIDocsComponent=(0,utils_1.compose)(withRouter_1.withRouter,withStore_1.withStore,react_1.memo)((({licenseKey:e,onLoaded:o,children:t,options:i,layout:n,collapsedSidebar:r,parser:s,withCommonStyles:l})=>{var d,u,a,c,_;const m=(0,react_1.useRef)(null),{isValid:p,licenseInfo:h}=(0,useLicense_1.useLicense)(e);(0,hooks_1.useUppercase2LowercaseRedirect)(),(0,theme_1.useMount)((()=>{null==o||o()}));const{hideSidebar:v,scrollYOffset:x}=i||{},{contentItems:y}=(0,hooks_1.useContentItems)({parser:s,options:i}),S=null===(u=null===(d=s.definition)||void 0===d?void 0:d.info)||void 0===u?void 0:u["x-logo"];return(0,jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment,{children:[l&&(0,jsx_runtime_1.jsx)(theme_1.GlobalStyle,{}),(0,jsx_runtime_1.jsxs)(styled_1.RedocWrap,{className:"redoc-wrap",ref:m,children:[(0,jsx_runtime_1.jsx)(UnsupportedFeatureScreen_1.UnsupportedFeatureScreen,{}),!p&&(0,jsx_runtime_1.jsx)(Overlay_1.Overlay,{licenseInfo:h}),(0,jsx_runtime_1.jsx)(styled_1.CssFixes,{layout:n}),!v&&(0,jsx_runtime_1.jsxs)(StickySidebar_1.StickyResponsiveSidebar,{scrollYOffset:x,className:"menu-content",collapsedSidebar:!r,children:[(0,jsx_runtime_1.jsx)(theme_1.SidebarLogo,{imageUrl:null==S?void 0:S.url,href:(null==S?void 0:S.href)||(null===(_=null===(c=null===(a=s.definition)||void 0===a?void 0:a.info)||void 0===c?void 0:c.contact)||void 0===_?void 0:_.url),altText:null==S?void 0:S.altText,backgroundColor:null==S?void 0:S.backgroundColor}),(0,jsx_runtime_1.jsx)(SideMenu_1.SideMenu,{items:p?y:[]})]}),(0,jsx_runtime_1.jsxs)(theme_1.ThreePanelLayout,{className:"api-content",id:"api-content",layout:n===theme_1.LayoutVariant.THREE_PANEL?theme_1.LayoutVariant.THREE_PANEL:theme_1.LayoutVariant.STACKED,collapsedSidebar:r,children:[(0,jsx_runtime_1.jsx)(Content_1.Content,{items:p?y:[],routingBasePath:i.routingBasePath}),t]})]})]})}));function RedoclyOpenAPIDocs({onLoaded:e,children:o,store:t,withCommonStyles:i}){var n,r,s;return(null==t?void 0:t.definition)?(0,jsx_runtime_1.jsx)(Providers_1.StoreProvider,Object.assign({},t,{children:(0,jsx_runtime_1.jsx)(RedoclyOpenAPIDocsComponent,{onLoaded:e,basePath:null===(n=t.options)||void 0===n?void 0:n.routingBasePath,licenseKey:null===(r=t.options)||void 0===r?void 0:r.licenseKey,disableRouter:null===(s=t.options)||void 0===s?void 0:s.disableRouter,withCommonStyles:i,children:o})})):null}function RedoclyOpenAPIDocsStandalone({definition:e,definitionUrl:o,options:t={},activeItemId:i,activeSampleLanguage:n,activeDeepLink:r}){return(0,jsx_runtime_1.jsx)(Providers_1.AppProvider,{definition:e,definitionUrl:o,options:t,activeItemId:i,activeSampleLanguage:n,activeDeepLink:r,children:(0,jsx_runtime_1.jsx)(RedoclyOpenAPIDocs,{withCommonStyles:!0})})}exports.RedoclyOpenAPIDocs=RedoclyOpenAPIDocs,exports.RedoclyOpenAPIDocsStandalone=RedoclyOpenAPIDocsStandalone;
|
|
2
2
|
//# sourceMappingURL=RedoclyOpenAPIDocs.js.map
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
import type { FlattenSimpleInterpolation } from 'styled-components';
|
|
2
2
|
import type { CssFixesProps } from './types';
|
|
3
3
|
export declare const RedocWrap: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
4
|
-
export declare const BackgroundStub: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
5
|
-
export declare const RedocWrapStyled: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
6
4
|
export declare const getMarginFixesByName: (variableName: string) => FlattenSimpleInterpolation;
|
|
7
5
|
export declare const CssFixes: import("styled-components").GlobalStyleComponent<CssFixesProps, import("styled-components").DefaultTheme>;
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,a,i){void 0===i&&(i=a);var
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,a,i){void 0===i&&(i=a);var r=Object.getOwnPropertyDescriptor(t,a);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[a]}}),Object.defineProperty(e,i,r)}:function(e,t,a,i){void 0===i&&(i=a),e[i]=t[a]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var a in e)"default"!==a&&Object.prototype.hasOwnProperty.call(e,a)&&__createBinding(t,e,a);return __setModuleDefault(t,e),t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.CssFixes=exports.getMarginFixesByName=exports.RedocWrap=void 0;const theme_1=require("@redocly/theme"),styled_components_1=__importStar(require("styled-components")),common_1=require("../common");exports.RedocWrap=styled_components_1.default.div`
|
|
2
2
|
display: flex;
|
|
3
3
|
position: relative;
|
|
4
4
|
text-align: left;
|
|
5
|
+
background-color: var(--bg-color);
|
|
5
6
|
tap-highlight-color: rgba(0, 0, 0, 0);
|
|
6
7
|
text-size-adjust: 100%;
|
|
7
8
|
text-rendering: var(--text-rendering, auto) !important;
|
|
@@ -17,52 +18,17 @@
|
|
|
17
18
|
box-sizing: border-box;
|
|
18
19
|
-webkit-tap-highlight-color: rgba(255, 255, 255, 0);
|
|
19
20
|
}
|
|
20
|
-
`,exports.BackgroundStub=styled_components_1.default.div`
|
|
21
|
-
position: absolute;
|
|
22
|
-
display: none;
|
|
23
|
-
top: 0;
|
|
24
|
-
bottom: 0;
|
|
25
|
-
right: 0;
|
|
26
|
-
left: 0;
|
|
27
|
-
background: var(--panel-samples-block-bg-color);
|
|
28
|
-
|
|
29
|
-
@media screen and (min-width: ${theme_1.breakpoints.medium}) {
|
|
30
|
-
display: initial;
|
|
31
|
-
left: calc(100% - var(--panel-samples-width));
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
@media print {
|
|
35
|
-
display: none;
|
|
36
|
-
}
|
|
37
|
-
`,exports.RedocWrapStyled=(0,styled_components_1.default)(exports.RedocWrap)`
|
|
38
|
-
background-color: var(--bg-color);
|
|
39
21
|
`;const getMarginFixesByName=e=>styled_components_1.css`
|
|
40
22
|
margin: 0 max(calc((100% - var(--panel-samples-width) - var(${e})) / 2), 0);
|
|
41
23
|
`;exports.getMarginFixesByName=getMarginFixesByName,exports.CssFixes=styled_components_1.createGlobalStyle`
|
|
42
|
-
|
|
43
|
-
content: " ";
|
|
44
|
-
display: block;
|
|
45
|
-
height: 0;
|
|
46
|
-
clear: both;
|
|
47
|
-
visibility: hidden;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
${panels_1.SamplesPanel} {
|
|
24
|
+
${common_1.SamplesPanel} {
|
|
51
25
|
${({layout:e})=>{if(e===theme_1.LayoutVariant.STACKED)return styled_components_1.css`
|
|
52
26
|
width: 100%;
|
|
53
27
|
padding-left: var(--panel-gap-horizontal);
|
|
54
28
|
`}}
|
|
55
29
|
}
|
|
56
30
|
|
|
57
|
-
${
|
|
58
|
-
${({layout:e})=>{if(e===theme_1.LayoutVariant.STACKED)return styled_components_1.css`
|
|
59
|
-
@media screen and (min-width: ${theme_1.breakpoints.medium}) {
|
|
60
|
-
display: none;
|
|
61
|
-
}
|
|
62
|
-
`}}
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
${panels_1.SamplesMiddlePanel} {
|
|
31
|
+
${common_1.SamplesMiddlePanel} {
|
|
66
32
|
${({layout:e})=>e===theme_1.LayoutVariant.THREE_PANEL?styled_components_1.css`
|
|
67
33
|
margin: 0;
|
|
68
34
|
@media screen and (min-width: ${theme_1.breakpoints.small}) {
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { LayoutVariant } from '@redocly/theme';
|
|
2
|
-
import type { CodeSampleConfig
|
|
2
|
+
import type { CodeSampleConfig } from '../../services';
|
|
3
|
+
import type { RedocConfig } from '@redocly/config';
|
|
3
4
|
import type { OpenAPIDefinition } from '../../types';
|
|
4
5
|
import type { RoutingProps, StoreProps } from '../../hoc/types';
|
|
5
6
|
import type { OperationStore } from '../../jotai/operation';
|
|
@@ -10,7 +11,7 @@ export interface RedoclyOpenAPIDocsProps extends RoutingProps, StoreProps {
|
|
|
10
11
|
withCommonStyles?: boolean;
|
|
11
12
|
}
|
|
12
13
|
export interface StoreProviderProps {
|
|
13
|
-
options?:
|
|
14
|
+
options?: RedocConfig;
|
|
14
15
|
definition: OpenAPIDefinition;
|
|
15
16
|
definitionUrl?: string;
|
|
16
17
|
withState?: {
|
|
@@ -27,7 +28,7 @@ export interface StoreProviderProps {
|
|
|
27
28
|
export interface AppProviderProps {
|
|
28
29
|
definitionUrl?: string;
|
|
29
30
|
definition?: GenericObject;
|
|
30
|
-
options?:
|
|
31
|
+
options?: RedocConfig;
|
|
31
32
|
activeItemId?: string;
|
|
32
33
|
activeSampleLanguage?: CodeSampleConfig['lang'] | string;
|
|
33
34
|
activeDeepLink?: string;
|
|
@@ -38,7 +39,7 @@ export interface AppProviderProps {
|
|
|
38
39
|
export interface RedoclyOpenAPIDocsStandaloneProps {
|
|
39
40
|
definition?: GenericObject;
|
|
40
41
|
definitionUrl?: string;
|
|
41
|
-
options?:
|
|
42
|
+
options?: RedocConfig;
|
|
42
43
|
activeItemId?: string;
|
|
43
44
|
activeSampleLanguage?: CodeSampleConfig['lang'];
|
|
44
45
|
activeDeepLink?: string;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { DependencyList } from 'react';
|
|
2
2
|
import type { OpenAPIDefinition } from '../../types';
|
|
3
|
-
import type {
|
|
3
|
+
import type { RedocConfig } from '@redocly/config';
|
|
4
4
|
export declare function fixSpec(resolvedSpec: OpenAPIDefinition): void;
|
|
5
|
-
export declare function loadSingle(spec: any, specUrl: any, options?:
|
|
5
|
+
export declare function loadSingle(spec: any, specUrl: any, options?: RedocConfig): Promise<OpenAPIDefinition>;
|
|
6
6
|
export declare function loadAndBundleSpecOrMd(url: string, title?: string): Promise<OpenAPIDefinition>;
|
|
7
7
|
export declare function useDeepCompareMemoize(value: DependencyList): Array<number>;
|
|
8
8
|
export declare function getMarkdownHeaderId(children: any): string | undefined;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SectionContent=void 0;const jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),theme_1=require("@redocly/theme"),jotai_1=require("jotai"),styled_components_1=__importDefault(require("styled-components")),ContentItem_1=require("../ContentItem"),PageFooter_1=require("../PageFooter"),store_1=require("../../jotai/store"),RenderHook_1=require("../RenderHook"),RightPanel_1=require("../RightPanel"),app_1=require("../../jotai/app"),common_1=require("../common");function SectionContent({items:e,hideFooterAndHeader:t}){const{unstable_hooks:{MiddlePanelHeader:n},routingBasePath:
|
|
1
|
+
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SectionContent=void 0;const jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),theme_1=require("@redocly/theme"),jotai_1=require("jotai"),styled_components_1=__importDefault(require("styled-components")),ContentItem_1=require("../ContentItem"),PageFooter_1=require("../PageFooter"),store_1=require("../../jotai/store"),RenderHook_1=require("../RenderHook"),RightPanel_1=require("../RightPanel"),app_1=require("../../jotai/app"),common_1=require("../common");function SectionContent({items:e,hideFooterAndHeader:t}){const{unstable_hooks:{MiddlePanelHeader:n},routingBasePath:a}=(0,jotai_1.useAtomValue)(store_1.globalOptionsAtom),i=(0,jotai_1.useAtomValue)(app_1.layoutAtom),r=i===theme_1.LayoutVariant.STACKED,o=(0,react_1.useMemo)((()=>t?null:(0,jsx_runtime_1.jsx)(MiddlePanelWrapper,{isStacked:r,children:(0,jsx_runtime_1.jsx)(PageFooter_1.PageFooter,{})})),[t,r]),s=(0,react_1.useMemo)((()=>t||!theme_1.OpenApiHeader&&!n?null:(0,jsx_runtime_1.jsx)(MiddlePanelWrapper,{isStacked:r,children:n?(0,jsx_runtime_1.jsx)(RenderHook_1.RenderHook,{Hook:n,props:void 0}):(0,jsx_runtime_1.jsx)(theme_1.OpenApiHeader,{})})),[n,t,r]);return 0===e.length?null:(0,jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment,{children:[s,(0,jsx_runtime_1.jsxs)(Container,{children:[(0,jsx_runtime_1.jsx)(SectionContainer,{layout:i,children:e.filter((({type:e})=>"section"===e)).map((e=>(0,jsx_runtime_1.jsx)(ContentItem_1.ContentItem,{item:e,routingBasePath:a},e.id)))}),(0,jsx_runtime_1.jsx)(RightPanelContainer,{isStacked:r,tabIndex:0,children:(0,jsx_runtime_1.jsx)(RightPanel_1.RightPanel,{item:e[0]})})]}),e.filter((({type:e})=>"section"!==e)).map((e=>(0,jsx_runtime_1.jsx)(ContentItem_1.ContentItem,{item:e,routingBasePath:a},e.id))),o]})}exports.SectionContent=SectionContent;const Container=styled_components_1.default.div`
|
|
2
2
|
display: flex;
|
|
3
3
|
width: 100%;
|
|
4
4
|
margin-bottom: var(--spacing-xxl);
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
`,SectionContainer=styled_components_1.default.div`
|
|
10
10
|
width: 100%;
|
|
11
11
|
|
|
12
|
-
@media screen and (min-width: ${theme_1.breakpoints.
|
|
12
|
+
@media screen and (min-width: ${theme_1.breakpoints.large}) {
|
|
13
13
|
width: ${({layout:e})=>e===theme_1.LayoutVariant.STACKED?"100%":"calc(100% - var(--panel-samples-width))"};
|
|
14
14
|
}
|
|
15
15
|
`,RightPanelContainer=(0,styled_components_1.default)(common_1.SamplesPanel)`
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
overflow-y: auto;
|
|
19
19
|
max-height: calc(100vh - var(--navbar-height) - var(--panel-gap-vertical) * 2);
|
|
20
20
|
|
|
21
|
-
@media screen and (min-width: ${theme_1.breakpoints.
|
|
21
|
+
@media screen and (min-width: ${theme_1.breakpoints.large}) {
|
|
22
22
|
display: ${({isStacked:e})=>e?"none":"block"};
|
|
23
23
|
}
|
|
24
24
|
`;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useMenuItems=void 0;const theme_1=require("@redocly/theme"),react_1=require("react"),react_router_dom_1=require("react-router-dom"),utils_1=require("../../../utils");function useMenuItems({items:e}){const t=(0,react_router_dom_1.useLocation)(),s=(0,theme_1.useActiveSectionId)(t,!1,!1);return(0,react_1.useMemo)((()=>mapAndSetActiveItems(e,s,t)),[s,e,t])}function mapAndSetActiveItems(e,t="",s){const i=[];return convertOpenAPIDocs2Sidebar({contentItems:e,sidebarItems:i,activeItemId:t,location:s}),i}function isItemActive(e,t="",s){return!!e.href&&(t?e.id===t:(0,utils_1.pathMatchedLink)(s,e.href))}function isSubItemActive(e,t="",s){return(e.items||[]).some((e=>isItemActive(e,t,s)||isSubItemActive(e,t,s)))}function convertOpenAPIDocs2Sidebar(e){const{contentItems:t,sidebarItems:s,activeItemId:i,location:c}=e;let n=!0;for(const
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useMenuItems=void 0;const theme_1=require("@redocly/theme"),react_1=require("react"),react_router_dom_1=require("react-router-dom"),utils_1=require("../../../utils");function useMenuItems({items:e}){const t=(0,react_router_dom_1.useLocation)(),s=(0,theme_1.useActiveSectionId)(t,!1,!1);return(0,react_1.useMemo)((()=>mapAndSetActiveItems(e,s,t)),[s,e,t])}function mapAndSetActiveItems(e,t="",s){const i=[];return convertOpenAPIDocs2Sidebar({contentItems:e,sidebarItems:i,activeItemId:t,location:s}),i}function isItemActive(e,t="",s){return!!e.href&&(t?e.id===t:(0,utils_1.pathMatchedLink)(s,e.href))}function isSubItemActive(e,t="",s){return(e.items||[]).some((e=>isItemActive(e,t,s)||isSubItemActive(e,t,s)))}function convertOpenAPIDocs2Sidebar(e){const{contentItems:t,sidebarItems:s,activeItemId:i,location:c}=e;let n=!0;for(const a of t){const t=isItemActive(a,i,c),o=isSubItemActive(a,i,c);switch(a.type){case"group":s.push({type:"separator",label:a.name,active:t,hasActiveSubItem:o}),convertOpenAPIDocs2Sidebar(Object.assign(Object.assign({},e),{contentItems:a.items,sidebarItems:s}));break;case"tag":const r={type:"group",label:a.name,items:[],link:a.href,active:t,hasActiveSubItem:o,modified:!0};s.push(r),convertOpenAPIDocs2Sidebar({contentItems:a.items,sidebarItems:r.items||[],activeItemId:i,location:c});break;case"operation":case"schema":a.isWebhook&&n&&(s.push({type:"separator",label:"Webhooks",variant:"secondary"}),n=!1),s.push({type:"link",label:a.name,httpVerb:"schema"===a.type?"schema":a.httpVerb,link:a.href,badges:a.badges,active:t,hasActiveSubItem:o,modified:!0,deprecated:a.deprecated});break;case"section":if(-1===a.depth)continue;const m={type:a.items.length?"group":"link",label:a.name,link:a.href,items:[],active:t,hasActiveSubItem:o,modified:!0};s.push(m),a.items.length&&convertOpenAPIDocs2Sidebar({contentItems:a.items,sidebarItems:m.items,activeItemId:i,location:c})}}}exports.useMenuItems=useMenuItems;
|
|
2
2
|
//# sourceMappingURL=useMenuItems.js.map
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
display: none;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
|
-
@media screen and (min-width: ${theme_1.breakpoints.
|
|
12
|
+
@media screen and (min-width: ${theme_1.breakpoints.large}) {
|
|
13
13
|
width: ${a?"100%":"calc(100% - var(--panel-samples-width))"};
|
|
14
14
|
padding-left: ${t?"var(--panel-gap-horizontal)":"calc(var(--panel-gap-horizontal) * 2)"};
|
|
15
15
|
padding-right: ${t?"var(--panel-gap-vertical)":"var(--panel-gap-horizontal)"};
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
display: none;
|
|
93
93
|
}
|
|
94
94
|
|
|
95
|
-
@media screen and (min-width: ${theme_1.breakpoints.
|
|
95
|
+
@media screen and (min-width: ${theme_1.breakpoints.large}) {
|
|
96
96
|
width: var(--panel-samples-width);
|
|
97
97
|
padding-top: 0;
|
|
98
98
|
padding-bottom: 0;
|
|
@@ -112,7 +112,7 @@
|
|
|
112
112
|
width: 100%;
|
|
113
113
|
padding: 0;
|
|
114
114
|
|
|
115
|
-
@media screen and (min-width: ${theme_1.breakpoints.
|
|
115
|
+
@media screen and (min-width: ${theme_1.breakpoints.large}) {
|
|
116
116
|
flex-direction: ${({layout:e})=>e!==theme_1.LayoutVariant.STACKED?"row":"column"};
|
|
117
117
|
}
|
|
118
118
|
|
package/lib/components/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,o,n)}:function(e,t,r,o){void 0===o&&(o=r),e[o]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SelectWrapper=exports.Example=exports.ExampleValue=exports.PayloadSamples=exports.OperationItem=exports.Discriminator=exports.ContentItems=exports.ContentItem=exports.SectionItem=
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,o,n)}:function(e,t,r,o){void 0===o&&(o=r),e[o]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SelectWrapper=exports.Example=exports.ExampleValue=exports.PayloadSamples=exports.OperationItem=exports.Discriminator=exports.ContentItems=exports.ContentItem=exports.SectionItem=void 0,__exportStar(require("./RedoclyOpenAPIDocs"),exports),__exportStar(require("./pluggable"),exports),__exportStar(require("./common"),exports),__exportStar(require("./ApiInfo"),exports);var SectionItem_1=require("./SectionItem");Object.defineProperty(exports,"SectionItem",{enumerable:!0,get:function(){return SectionItem_1.SectionItem}});var ContentItem_1=require("./ContentItem");Object.defineProperty(exports,"ContentItem",{enumerable:!0,get:function(){return ContentItem_1.ContentItem}});var ContentItems_1=require("./ContentItems");Object.defineProperty(exports,"ContentItems",{enumerable:!0,get:function(){return ContentItems_1.ContentItems}});var Discriminator_1=require("./Discriminator");Object.defineProperty(exports,"Discriminator",{enumerable:!0,get:function(){return Discriminator_1.Discriminator}}),__exportStar(require("./Schema/"),exports);var OperationItem_1=require("./OperationItem");Object.defineProperty(exports,"OperationItem",{enumerable:!0,get:function(){return OperationItem_1.OperationItem}}),__exportStar(require("./Markdown"),exports),__exportStar(require("./Responses"),exports),__exportStar(require("./ResponseSamples/ResponseSamples"),exports);var PayloadSamples_1=require("./PayloadSamples");Object.defineProperty(exports,"PayloadSamples",{enumerable:!0,get:function(){return PayloadSamples_1.PayloadSamples}}),Object.defineProperty(exports,"ExampleValue",{enumerable:!0,get:function(){return PayloadSamples_1.ExampleValue}}),Object.defineProperty(exports,"Example",{enumerable:!0,get:function(){return PayloadSamples_1.Example}}),Object.defineProperty(exports,"SelectWrapper",{enumerable:!0,get:function(){return PayloadSamples_1.SelectWrapper}}),__exportStar(require("./MediaTypeSwitch"),exports),__exportStar(require("./RequestParameters"),exports),__exportStar(require("./SelectOrLabel"),exports),__exportStar(require("./ErrorBoundary"),exports),__exportStar(require("./SideMenu/"),exports),__exportStar(require("./StickySidebar/StickyResponsiveSidebar"),exports),__exportStar(require("./SchemaDefinition/SchemaDefinition"),exports),__exportStar(require("./RequestSamples/RequestSamples"),exports);
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.CurlIcon=exports.Icon=void 0;const jsx_runtime_1=require("react/jsx-runtime"),styled_components_1=__importDefault(require("styled-components")),Icon=()=>(0,jsx_runtime_1.jsxs)("svg",{width:"
|
|
1
|
+
"use strict";var __importDefault=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.CurlIcon=exports.Icon=void 0;const jsx_runtime_1=require("react/jsx-runtime"),styled_components_1=__importDefault(require("styled-components")),Icon=()=>(0,jsx_runtime_1.jsxs)("svg",{width:"14",height:"14",viewBox:"0 0 24 21",fill:"none",xmlns:"http://www.w3.org/2000/svg",children:[(0,jsx_runtime_1.jsxs)("g",{clipPath:"url(#clip0_3789_6604)",children:[(0,jsx_runtime_1.jsx)("path",{d:"M22.2305 2.73601C21.6963 2.73601 21.264 2.30296 21.264 1.76946C21.264 1.2352 21.6963 0.802917 22.2305 0.802917C22.764 0.802917 23.1971 1.2352 23.1971 1.76946C23.1971 2.30296 22.764 2.73601 22.2305 2.73601ZM12.6313 19.2502C12.097 19.2502 11.6647 18.8172 11.6647 18.2837C11.6647 17.7494 12.097 17.3171 12.6313 17.3171C13.1648 17.3171 13.5971 17.7494 13.5971 18.2837C13.5971 18.8172 13.1648 19.2502 12.6313 19.2502ZM22.2305 0C21.2533 0 20.4611 0.792261 20.4611 1.76946C20.4611 1.97799 20.5136 2.17206 20.5798 2.35776L12.2789 16.585C11.4768 16.7532 10.8618 17.4313 10.8618 18.2837C10.8618 19.2609 11.6541 20.0531 12.6313 20.0531C13.6077 20.0531 14.4 19.2609 14.4 18.2837C14.4 18.0873 14.3475 17.9077 14.2889 17.7312L22.6316 3.45749C23.4094 3.27103 24 2.60434 24 1.76946C24 0.792261 23.2077 0 22.2305 0Z",fill:"#0C544C"}),(0,jsx_runtime_1.jsx)("path",{d:"M14.9906 2.73601C14.4563 2.73601 14.024 2.30296 14.024 1.76946C14.024 1.2352 14.4563 0.802917 14.9906 0.802917C15.5241 0.802917 15.9564 1.2352 15.9564 1.76946C15.9564 2.30296 15.5241 2.73601 14.9906 2.73601ZM5.39059 19.2502C4.85708 19.2502 4.42404 18.8172 4.42404 18.2837C4.42404 17.7494 4.85708 17.3171 5.39059 17.3171C5.92485 17.3171 6.35713 17.7494 6.35713 18.2837C6.35713 18.8172 5.92485 19.2502 5.39059 19.2502ZM14.9906 0C14.0126 0 13.2211 0.792261 13.2211 1.76946C13.2211 1.97799 13.2736 2.17206 13.3399 2.35776L5.03898 16.585C4.23606 16.7532 3.62112 17.4313 3.62112 18.2837C3.62112 19.2609 4.41339 20.0531 5.39059 20.0531C6.36779 20.0531 7.16005 19.2609 7.16005 18.2837C7.16005 18.0873 7.10754 17.9077 7.04894 17.7312L15.3917 3.45749C16.1695 3.27103 16.7601 2.60434 16.7601 1.76946C16.7601 0.792261 15.967 0 14.9906 0Z",fill:"#073551"}),(0,jsx_runtime_1.jsx)("path",{d:"M1.76946 5.69424C2.30296 5.69424 2.73601 6.12729 2.73601 6.66079C2.73601 7.19429 2.30296 7.62733 1.76946 7.62733C1.2352 7.62733 0.802917 7.19429 0.802917 6.66079C0.802917 6.12729 1.2352 5.69424 1.76946 5.69424ZM1.76946 8.43025C2.74666 8.43025 3.53892 7.63799 3.53892 6.66079C3.53892 6.4652 3.48565 6.28483 3.42705 6.10826C3.19264 5.4058 2.55031 4.89133 1.76946 4.89133C1.64465 4.89133 1.53506 4.93775 1.41709 4.96286C0.614936 5.1303 0 5.8084 0 6.66079C0 7.63799 0.792261 8.43025 1.76946 8.43025Z",fill:"#073551"}),(0,jsx_runtime_1.jsx)("path",{d:"M0.802917 12.8436C0.802917 12.3094 1.23596 11.8771 1.76946 11.8771C2.30296 11.8771 2.73601 12.3094 2.73601 12.8436C2.73601 13.3771 2.30296 13.8094 1.76946 13.8094C1.23596 13.8094 0.802917 13.3771 0.802917 12.8436ZM3.53892 12.8436C3.53892 12.6473 3.48565 12.4677 3.42705 12.2911C3.19264 11.5886 2.55107 11.0742 1.76946 11.0742C1.64465 11.0742 1.53506 11.1206 1.41709 11.145C0.614936 11.3131 0 11.9912 0 12.8436C0 13.8201 0.792261 14.6131 1.76946 14.6131C2.74666 14.6131 3.53892 13.8201 3.53892 12.8436Z",fill:"#073551"})]}),(0,jsx_runtime_1.jsx)("defs",{children:(0,jsx_runtime_1.jsx)("clipPath",{id:"clip0_3789_6604",children:(0,jsx_runtime_1.jsx)("rect",{width:"24",height:"20.0531",fill:"white"})})})]});exports.Icon=Icon,exports.CurlIcon=(0,styled_components_1.default)(exports.Icon).attrs((()=>({"data-component-name":"icons/CurlIcon"})))``;
|
|
2
2
|
//# sourceMappingURL=CurlIcon.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GOIcon=exports.Icon=void 0;const jsx_runtime_1=require("react/jsx-runtime"),styled_components_1=__importDefault(require("styled-components")),Icon=()=>(0,jsx_runtime_1.jsxs)("svg",{xmlns:"http://www.w3.org/2000/svg",width:"
|
|
1
|
+
"use strict";var __importDefault=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GOIcon=exports.Icon=void 0;const jsx_runtime_1=require("react/jsx-runtime"),styled_components_1=__importDefault(require("styled-components")),Icon=()=>(0,jsx_runtime_1.jsxs)("svg",{xmlns:"http://www.w3.org/2000/svg",width:"21",height:"19",viewBox:"0 0 12 5",fill:"none",children:[(0,jsx_runtime_1.jsxs)("g",{clipPath:"url(#clip0_6351_16646)",children:[(0,jsx_runtime_1.jsx)("path",{d:"M1.33603 1.58431C1.31445 1.58431 1.30906 1.57353 1.31985 1.55735L1.4331 1.41173C1.44389 1.39555 1.47086 1.38477 1.49243 1.38477H3.41779C3.43936 1.38477 3.44476 1.40095 3.43397 1.41712L3.34229 1.55735C3.3315 1.57353 3.30454 1.58971 3.28836 1.58971L1.33603 1.58431Z",fill:"#3B3C45"}),(0,jsx_runtime_1.jsx)("path",{d:"M0.521573 2.08627C0.5 2.08627 0.494607 2.07548 0.505393 2.0593L0.61865 1.91368C0.629436 1.89751 0.656402 1.88672 0.677975 1.88672H3.13726C3.15884 1.88672 3.16962 1.9029 3.16423 1.91908L3.12108 2.04851C3.11569 2.07009 3.09412 2.08087 3.07255 2.08087L0.521573 2.08627Z",fill:"#00ACD7"}),(0,jsx_runtime_1.jsx)("path",{d:"M1.82626 2.57845C1.80469 2.57845 1.79929 2.56227 1.81008 2.54609L1.88559 2.41127C1.89637 2.39509 1.91794 2.37891 1.93952 2.37891H3.01815C3.03973 2.37891 3.05051 2.39509 3.05051 2.41666L3.03972 2.54609C3.03972 2.56767 3.01815 2.58385 3.00197 2.58385L1.82626 2.57845Z",fill:"#00ACD7"}),(0,jsx_runtime_1.jsx)("path",{d:"M7.42518 1.49193C7.08541 1.57822 6.8535 1.64294 6.51913 1.72923C6.43823 1.7508 6.43284 1.75619 6.36273 1.6753C6.28183 1.58361 6.2225 1.52429 6.10925 1.47036C5.76948 1.30317 5.44049 1.35171 5.13308 1.55125C4.76635 1.78855 4.57758 2.13911 4.58298 2.57596C4.58837 3.00741 4.885 3.36336 5.31106 3.42269C5.67779 3.47122 5.9852 3.34179 6.2279 3.06674C6.27643 3.00741 6.31958 2.94269 6.37351 2.86719C6.17936 2.86719 5.93666 2.86719 5.33263 2.86719C5.21937 2.86719 5.19241 2.79708 5.23016 2.70539C5.30027 2.5382 5.42971 2.25776 5.50521 2.11754C5.52139 2.08518 5.55914 2.03125 5.64004 2.03125C5.91509 2.03125 6.92901 2.03125 7.60316 2.03125C7.59237 2.17686 7.59237 2.32248 7.5708 2.46809C7.51147 2.8564 7.36586 3.21235 7.12856 3.52516C6.74025 4.03751 6.23329 4.3557 5.5915 4.442C5.06297 4.51211 4.57219 4.40964 4.14074 4.08605C3.74164 3.78403 3.51513 3.38493 3.4558 2.88876C3.38569 2.3009 3.55827 1.77237 3.91422 1.30856C4.29714 0.806995 4.8041 0.488798 5.42431 0.375541C5.93127 0.283857 6.41666 0.343182 6.8535 0.639807C7.13934 0.828568 7.34428 1.08744 7.47911 1.40024C7.51147 1.44878 7.4899 1.47575 7.42518 1.49193Z",fill:"#00ACD7"}),(0,jsx_runtime_1.jsx)("path",{d:"M9.21072 4.4733C8.71994 4.46252 8.2723 4.3223 7.89478 3.9987C7.57658 3.72365 7.37704 3.3731 7.31232 2.95782C7.21524 2.34839 7.38243 1.80907 7.74916 1.32908C8.14287 0.811337 8.61747 0.541679 9.25925 0.428422C9.80936 0.331345 10.3271 0.385277 10.7963 0.703474C11.2224 0.994705 11.4866 1.38841 11.5567 1.90615C11.6484 2.63423 11.4381 3.22748 10.9365 3.73444C10.5806 4.09578 10.1437 4.3223 9.64217 4.42477C9.49655 4.45173 9.35094 4.45712 9.21072 4.4733ZM10.4943 2.29446C10.4889 2.22435 10.4889 2.17042 10.4781 2.11649C10.381 1.58256 9.89026 1.28054 9.3779 1.39919C8.87634 1.51245 8.55275 1.83065 8.4341 2.33761C8.33702 2.75827 8.54196 3.18433 8.93027 3.35692C9.2269 3.48635 9.52352 3.47017 9.80936 3.32456C10.2354 3.10344 10.4673 2.75827 10.4943 2.29446Z",fill:"#00ACD7"})]}),(0,jsx_runtime_1.jsx)("defs",{children:(0,jsx_runtime_1.jsx)("clipPath",{id:"clip0_6351_16646",children:(0,jsx_runtime_1.jsx)("rect",{width:"11.0769",height:"4.5",fill:"white",transform:"translate(0.5)"})})})]});exports.Icon=Icon,exports.GOIcon=(0,styled_components_1.default)(exports.Icon).attrs((()=>({"data-component-name":"icons/GOIcon"})))``;
|
|
2
2
|
//# sourceMappingURL=GOIcon.js.map
|
package/lib/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type {
|
|
1
|
+
export type { Options } from './services/config-options/types';
|
|
2
2
|
export type { IMenuItem } from './services/types';
|
|
3
3
|
export type { OperationModel, SchemaModel, ContentItemModel } from './models/types';
|
|
4
4
|
export type { CodeSampleOptions } from './models/code-sample-options';
|
package/lib/models/operation.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.mergeInMockServer=exports.getOperation=exports.isPayloadSample=void 0;const theme_1=require("@redocly/theme"),utils_1=require("../utils"),callback_1=require("./callback"),field_1=require("./field"),request_1=require("./request"),security_1=require("./security"),response_1=require("./response"),operation_1=require("../services/menu/operation");function isPayloadSample(e){return"Payload"===e.lang&&"requestBodyContent"in e}exports.isPayloadSample=isPayloadSample;let isCodeSamplesWarningPrinted=!1;function getOperation(e,r,t,s,i,o){var a,n;const l=r.isWebhook,p={operationDefinition:r,parent:t,pointer:r.pointer,description:(0,utils_1.getValueFromMdParsedExtension)(r,"description"),externalDocs:r.externalDocs,deprecated:!!r.deprecated,httpVerb:r.httpVerb,operationId:r.operationId,path:r.pathName,isWebhook:l,isCallback:Boolean(null==o?void 0:o.isCallback),isEvent:(null==o?void 0:o.isCallback)||l,name:(0,utils_1.getOperationName)(r),defaultExampleName:r.defaultSampleName,type:"operation",callbackId:null==o?void 0:o.id,href:i,get callbacks(){return Object.keys(r.callbacks||[]).map((o=>{var a;return(0,callback_1.getCallback)(e,o,null===(a=r.callbacks)||void 0===a?void 0:a[o],p.pointer,s,i,t)}))},get responses(){let t=!1;return Object.keys(r.responses||[]).filter((e=>"default"===e||("success"===(0,utils_1.getStatusCodeType)(e)&&(t=!0),(0,utils_1.isStatusCode)(e)))).map((i=>(0,response_1.getResponse)({parser:e,code:i,defaultAsError:t,infoOrRef:r.responses[i],options:s,isEvent:p.isEvent,operation:p})))},get parameters(){let t=(0,utils_1.mergeParams)(e,r.pathParameters,r.parameters,{pathPointer:utils_1.JsonPointer.dirName(p.pointer),operationPointer:p.pointer}).map((({paramOrRef:r,pointer:t})=>(0,field_1.getField)(e,r,t,s,{operation:p,type:"request"})));return s.sortRequiredPropsFirst&&(t=(0,utils_1.sortByRequired)(t)),t}};(null==o?void 0:o.isCallback)?(p.security=(r.security||[]).map((r=>(0,security_1.getSecurityRequirement)({requirement:r,parser:e}))),p.servers=(0,utils_1.normalizeServers)("",r.servers||r.pathServers||[]),p.id=(0,theme_1.removeLeadingSlash)(i)):(p.id=(0,utils_1.getOperationId)(r,t),p.href=p.href||(0,operation_1.getHref)(p),p.security=(r.security||e.definition.security||[]).map((r=>(0,security_1.getSecurityRequirement)({requirement:r,parser:e}))),p.servers=(0,utils_1.normalizeServers)(e.definitionUrl,mergeInMockServer(r.servers||r.pathServers||e.definition.servers||[],s.mockServer))),s.showExtensions&&(p.extensions=(0,utils_1.extractExtensions)(r,s.showExtensions)),p.requestBody=r.requestBody&&(0,request_1.getRequestBody)({parser:e,infoOrRef:r.requestBody,options:s,operation:p,isEvent:p.isEvent});const u=null===(a=p.requestBody)||void 0===a?void 0:a.content;return p.payload={lang:"Payload",source:"",requestBodyContent:(null==u?void 0:u.hasSample)?u:void 0},p.definitionSamples=r["x-codeSamples"]||r["x-code-samples"]||[],p.badges=(null===(n=r["x-badges"])||void 0===n?void 0:n.map((({name:e,color:r,position:t})=>({name:e,color:r||"var(--color-info-base)",position:t||"after"}))))||[],r["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),p.hasSamples=(null==u?void 0:u.hasSample)||p.definitionSamples.length>0,p.hideReplay=!0===r["x-hideReplay"],p}function mergeInMockServer(e,r){if(!r)return e;const t={url:r.url,description:r.description};switch(r.position){case"first":return[t,...e];case"last":return[...e,t];case"replace":return[t];default:return e}}exports.getOperation=getOperation,exports.mergeInMockServer=mergeInMockServer;
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.mergeInMockServer=exports.getOperation=exports.isPayloadSample=void 0;const theme_1=require("@redocly/theme"),utils_1=require("../utils"),callback_1=require("./callback"),field_1=require("./field"),request_1=require("./request"),security_1=require("./security"),response_1=require("./response"),operation_1=require("../services/menu/operation");function isPayloadSample(e){return"Payload"===e.lang&&"requestBodyContent"in e}exports.isPayloadSample=isPayloadSample;let isCodeSamplesWarningPrinted=!1;function getOperation(e,r,t,s,i,o){var a,n;const l=r.isWebhook,p={operationDefinition:r,parent:t,pointer:r.pointer,description:(0,utils_1.getValueFromMdParsedExtension)(r,"description"),externalDocs:r.externalDocs,deprecated:!!r.deprecated,httpVerb:r.httpVerb,operationId:r.operationId,path:r.pathName,isWebhook:l,isCallback:Boolean(null==o?void 0:o.isCallback),isEvent:(null==o?void 0:o.isCallback)||l,name:(0,utils_1.getOperationName)(r),defaultExampleName:r.defaultSampleName,type:"operation",callbackId:null==o?void 0:o.id,href:i,get callbacks(){return Object.keys(r.callbacks||[]).map((o=>{var a;return(0,callback_1.getCallback)(e,o,null===(a=r.callbacks)||void 0===a?void 0:a[o],p.pointer,s,i,t)}))},get responses(){let t=!1;return Object.keys(r.responses||[]).filter((e=>"default"===e||("success"===(0,utils_1.getStatusCodeType)(e)&&(t=!0),(0,utils_1.isStatusCode)(e)))).map((i=>(0,response_1.getResponse)({parser:e,code:i,defaultAsError:t,infoOrRef:r.responses[i],options:s,isEvent:p.isEvent,operation:p})))},get parameters(){let t=(0,utils_1.mergeParams)(e,r.pathParameters,r.parameters,{pathPointer:utils_1.JsonPointer.dirName(p.pointer),operationPointer:p.pointer}).map((({paramOrRef:r,pointer:t})=>(0,field_1.getField)(e,r,t,s,{operation:p,type:"request"})));return s.sortRequiredPropsFirst&&(t=(0,utils_1.sortByRequired)(t)),(0,utils_1.sortByDeprecated)(t)}};(null==o?void 0:o.isCallback)?(p.security=(r.security||[]).map((r=>(0,security_1.getSecurityRequirement)({requirement:r,parser:e}))),p.servers=(0,utils_1.normalizeServers)("",r.servers||r.pathServers||[]),p.id=(0,theme_1.removeLeadingSlash)(i)):(p.id=(0,utils_1.getOperationId)(r,t),p.href=p.href||(0,operation_1.getHref)(p),p.security=(r.security||e.definition.security||[]).map((r=>(0,security_1.getSecurityRequirement)({requirement:r,parser:e}))),p.servers=(0,utils_1.normalizeServers)(e.definitionUrl,mergeInMockServer(r.servers||r.pathServers||e.definition.servers||[],s.mockServer))),s.showExtensions&&(p.extensions=(0,utils_1.extractExtensions)(r,s.showExtensions)),p.requestBody=r.requestBody&&(0,request_1.getRequestBody)({parser:e,infoOrRef:r.requestBody,options:s,operation:p,isEvent:p.isEvent});const u=null===(a=p.requestBody)||void 0===a?void 0:a.content;return p.payload={lang:"Payload",source:"",requestBodyContent:(null==u?void 0:u.hasSample)?u:void 0},p.definitionSamples=r["x-codeSamples"]||r["x-code-samples"]||[],p.badges=(null===(n=r["x-badges"])||void 0===n?void 0:n.map((({name:e,color:r,position:t})=>({name:e,color:r||"var(--color-info-base)",position:t||"after"}))))||[],r["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),p.hasSamples=(null==u?void 0:u.hasSample)||p.definitionSamples.length>0,p.hideReplay=!0===r["x-hideReplay"],p}function mergeInMockServer(e,r){if(!r)return e;const t={url:r.url,description:r.description};switch(r.position){case"first":return[t,...e];case"last":return[...e,t];case"replace":return[t];default:return e}}exports.getOperation=getOperation,exports.mergeInMockServer=mergeInMockServer;
|
|
2
2
|
//# sourceMappingURL=operation.js.map
|
package/lib/models/schema.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __rest=this&&this.__rest||function(e,t){var i={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&t.indexOf(r)<0&&(i[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var n=0;for(r=Object.getOwnPropertySymbols(e);n<r.length;n++)t.indexOf(r[n])<0&&Object.prototype.propertyIsEnumerable.call(e,r[n])&&(i[r[n]]=e[r[n]])}return i};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getSchema=void 0;const theme_1=require("@redocly/theme"),OpenAPIParser_1=require("../services/OpenAPIParser"),utils_1=require("../utils"),field_1=require("./field");function getSchema({parser:e,schemaOrRef:t,pointer:i,options:r,isChild:n=!1,baseRefsStack:s=[],deps:o,absolutePointer:a}){var l,p,d,f,
|
|
1
|
+
"use strict";var __rest=this&&this.__rest||function(e,t){var i={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&t.indexOf(r)<0&&(i[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var n=0;for(r=Object.getOwnPropertySymbols(e);n<r.length;n++)t.indexOf(r[n])<0&&Object.prototype.propertyIsEnumerable.call(e,r[n])&&(i[r[n]]=e[r[n]])}return i};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getSchema=void 0;const theme_1=require("@redocly/theme"),OpenAPIParser_1=require("../services/OpenAPIParser"),utils_1=require("../utils"),field_1=require("./field");function getSchema({parser:e,schemaOrRef:t,pointer:i,options:r,isChild:n=!1,baseRefsStack:s=[],deps:o,absolutePointer:a}){var l,p,d,c,f,m,u,y,O;const{resolved:h,refsStack:v}=e.deref(t,s,!0),b=t.$ref||i||a||"",P=(0,OpenAPIParser_1.pushRef)(v,b),g=e.mergeAllOf(h,b,P,t.$ref||a),x=g.type||(0,utils_1.detectType)(g),_={operationPointer:(null===(l=o.operation)||void 0===l?void 0:l.pointer)||a||"",schemaOrRef:t,isChild:n,typePrefix:"",pointer:b,absolutePointer:a,refsStack:P,rawSchema:h,type:x,isCircular:!!g["x-circular-ref"],title:g.title||(0,utils_1.isNamedDefinition)(b)&&utils_1.JsonPointer.baseName(b)||"",description:(0,utils_1.getValueFromMdParsedExtension)(g,"description")||"",format:g.format,enum:g.enum||[],example:g.example,deprecated:!!g.deprecated,pattern:g.pattern,externalDocs:g.externalDocs,displayFormat:g.format,isPrimitive:(0,utils_1.isPrimitiveType)(g,x),constraints:(0,utils_1.humanizeConstraints)(g),default:g.default,readOnly:!!g.readOnly,writeOnly:!!g.writeOnly,const:g.const||"",contentEncoding:g.contentEncoding,contentMediaType:g.contentMediaType,minItems:g.minItems,maxItems:g.maxItems,nullable:g.nullable||g["x-nullable"],schema:g,displayType:"",items:void 0,extensions:void 0,oneOfType:"",discriminatorProp:void 0,oneOf:void 0,"x-enumDescriptions":(0,utils_1.getValueFromMdParsedExtension)(g,"x-enumDescriptions"),get fields(){if(hasType(_,"object")||hasType(_,"array")&&(Array.isArray(g.items)||Array.isArray(g.prefixItems)))return buildFields(e,g,b,r,P,o)}};if((g.nullable||g["x-nullable"])&&(Array.isArray(_.type)&&!_.type.some((e=>null===e||"null"===e))?_.type=[..._.type,"null"]:Array.isArray(_.type)||null===_.type&&"null"===_.type||(_.type=[_.type,"null"])),_.displayType=Array.isArray(_.type)?_.type.map((e=>null===e?"null":e)).join(" or "):_.type,_.isCircular)return _;if(g.if&&g.then||g.if&&g.else){const{oneOf:t,oneOfType:i}=initConditionalOperators({schema:g,parser:e,pointer:b,options:r,deps:o,refsStack:P});return _.oneOf=t,_.oneOfType=i,_}if(!n&&void 0!==getDiscriminator(g)){const{oneOf:t,discriminatorProp:i}=initDiscriminator({schema:g,parser:e,deps:o,mergedSchema:g,options:r,pointer:b,refsStack:P});return _.oneOf=t,_.discriminatorProp=i,_}if(n&&Array.isArray(g.oneOf)&&g.oneOf.find((e=>e.$ref===b))&&delete g.oneOf,void 0!==g.oneOf){const{oneOf:t,displayType:i}=initOneOf({schemaOneOf:g.oneOf,parser:e,deps:o,options:r,pointer:b,refsStack:P,schema:g});return _.oneOfType="One of",t&&(_.oneOf=t),_.displayType=i,void 0!==g.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${b}`),_}if(void 0!==g.anyOf){const{oneOf:t,displayType:i}=initOneOf({schemaOneOf:g.anyOf,parser:e,deps:o,options:r,pointer:b,refsStack:P,schema:g});return t&&(_.oneOf=t),_.displayType=i,_.oneOfType="Any of",_}if(hasType(_,"array")&&(g.items&&(_.items=getSchema({parser:e,schemaOrRef:g.items,pointer:b+"/items",options:r,baseRefsStack:P,deps:o,absolutePointer:utils_1.JsonPointer.join(g.absolutePointer||"",["items"])})),_.displayType=g.prefixItems||Array.isArray(g.items)?"items":(0,utils_1.pluralizeType)((null===(p=_.items)||void 0===p?void 0:p.displayType)||_.displayType),_.displayFormat=(null===(d=_.items)||void 0===d?void 0:d.format)||"",_.typePrefix=(null===(c=_.items)||void 0===c?void 0:c.typePrefix)||"Array of ",_.title=_.title||(null===(f=_.items)||void 0===f?void 0:f.title)||"",_.isPrimitive=void 0!==(null===(m=_.items)||void 0===m?void 0:m.isPrimitive)?null===(u=_.items)||void 0===u?void 0:u.isPrimitive:_.isPrimitive,void 0===_.example&&void 0!==(null===(y=_.items)||void 0===y?void 0:y.example)&&(_.example=[_.items.example]),(null===(O=_.items)||void 0===O?void 0:O.isPrimitive)&&(_.enum=_.items.enum,_["x-enumDescriptions"]=(0,utils_1.getValueFromMdParsedExtension)(_.items,"x-enumDescriptions")),Array.isArray(_.type))){const e=_.type.filter((e=>"array"!==e));e.length&&(_.displayType+=` or ${e.join(" or ")}`)}return r.showExtensions&&(_.extensions=(0,utils_1.extractExtensions)(g,r.showExtensions)),_}function initDiscriminator({schema:e,parser:t,pointer:i,options:r,refsStack:n,deps:s,mergedSchema:o}){const a=getDiscriminator(e),l=null==a?void 0:a.propertyName,p=t.findDerived([...o["x-parentRefs"]||[],i]);if(e.oneOf)for(const t of e.oneOf){if(void 0===t.$ref)continue;const e=utils_1.JsonPointer.baseName(t.$ref);p[t.$ref]=e}const d=(null==a?void 0:a.mapping)||{};let c=(null==a?void 0:a["x-explicitMappingOnly"])||!1;0===Object.keys(d).length&&(c=!1);const f={};for(const e in d){const t=d[e];Array.isArray(f[t])?f[t].push(e):f[t]=[e]}const m=c?Object.assign({},f):Object.assign(Object.assign({},p),f);let u=[];for(const e of Object.keys(m)){const t=m[e];if(Array.isArray(t))for(const i of t)u.push({$ref:e,name:i});else u.push({$ref:e,name:t})}const y=Object.keys(d);0!==y.length&&(u=u.sort(((e,t)=>{const i=y.indexOf(e.name),r=y.indexOf(t.name);return i<0&&r<0?e.name.localeCompare(t.name):i<0?1:r<0?-1:i-r})));return{oneOf:u.map((({$ref:e,name:i},a)=>{const l=getSchema({parser:t,schemaOrRef:{$ref:e},pointer:e,options:r,isChild:!0,baseRefsStack:n.slice(0,-1),deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"&d="+a:"&d="+a.toString()}),absolutePointer:o.absolutePointer});return l.title=i,l})),discriminatorProp:l}}function initOneOf({schemaOneOf:e,parser:t,refsStack:i,pointer:r,schema:n,options:s,deps:o}){const a=e.map(((e,a)=>{const{resolved:l,refsStack:p}=t.deref(e,i,!0),d=t.mergeAllOf(l,r+"/oneOf/"+a,p),c=(0,utils_1.isNamedDefinition)(e.$ref)&&!d.title?utils_1.JsonPointer.baseName(e.$ref):`${d.title||""}${d.const&&JSON.stringify(d.const)||""}`;return getSchema({parser:t,schemaOrRef:Object.assign(Object.assign({},d),{title:c,allOf:[Object.assign(Object.assign({},n),{oneOf:void 0,anyOf:void 0})],discriminator:l.allOf?void 0:d.discriminator}),pointer:e.$ref||r+"/oneOf/"+a,options:s,baseRefsStack:p,deps:Object.assign(Object.assign({},o),{parentFieldFullPath:o.parentFieldFullPath?o.parentFieldFullPath+"&oneOf="+a:"&oneOf="+a.toString()})})})),l=a.map((e=>{let t=e.typePrefix+(e.title?`${e.title} (${e.displayType})`:e.displayType);return t.indexOf(" or ")>-1&&(t=`(${t})`),t})).join(" or ");return{oneOf:a,displayType:l}}function initConditionalOperators({schema:e,parser:t,pointer:i,options:r,refsStack:n,deps:s}){const{if:o,else:a={},then:l={}}=e,p=__rest(e,["if","else","then"]);return{oneOf:[{allOf:[p,l,o],title:o&&o["x-displayName"]||(null==o?void 0:o.title)||"case 1"},{allOf:[p,a],title:a&&a["x-displayName"]||(null==a?void 0:a.title)||"case 2"}].map(((e,o)=>getSchema({parser:t,schemaOrRef:Object.assign({},e),pointer:i+"/oneOf/"+o,options:r,baseRefsStack:n,deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"&oneOf="+o:"&oneOf="+o.toString()})}))),oneOfType:"One of"}}function normalizeField(e,t,i){return e||(console.warn(`Field "${t}" is invalid, skipping.\n Field must be an object but got ${typeof e} at "${i}"`),{})}function buildFields(e,t,i,r,n,s){let o=t.properties||(hasType(t,"array")?t.prefixItems||t.items:void 0)||{};const a=t.patternProperties||{},l=t.additionalProperties||t.unevaluatedProperties,p=t.prefixItems?t.items:t.additionalItems,d=t.default||{};let c=Object.keys(o).map((a=>{var l;const p=normalizeField(o[a],a,i),c=void 0!==t.required&&t.required.indexOf(a)>-1;return(0,field_1.getField)(e,{name:t.properties?a:`[${a}]`,required:c,schema:Object.assign(Object.assign({},p),{example:(null===(l=t.example)||void 0===l?void 0:l[a])||p.example,default:void 0===p.default&&d?d[a]:p.default})},i+"/properties/"+a,r,s,n,utils_1.JsonPointer.join(t.absolutePointer||"",["properties",a]))}));return r.sortRequiredPropsFirst&&(c=(0,utils_1.sortByRequired)(c,t.required)),c.push(...Object.keys(a).map((t=>{const o=normalizeField(a[t],t,i);return(0,field_1.getField)(e,{name:t,required:!1,schema:o,kind:"patternProperties"},`${i}/patternProperties/${t}`,r,s,n)}))),((0,theme_1.isObject)(l)||!0===l)&&c.push((0,field_1.getField)(e,{name:((0,theme_1.isObject)(l)&&l["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===l?{}:l,kind:"additionalProperties"},i+"/additionalProperties",r,s,n,utils_1.JsonPointer.join(t.absolutePointer||"",["additionalProperties"]))),c.push(...buildAdditionalItems({parser:e,schema:p,fieldsCount:c.length,$ref:i,options:r,refsStack:n,deps:s})),(0,utils_1.sortByDeprecated)(c)}function buildAdditionalItems({parser:e,schema:t=!1,fieldsCount:i,$ref:r,options:n,refsStack:s,deps:o}){return"boolean"==typeof t?t?[(0,field_1.getField)(e,{name:`[${i}...]`,schema:{},kind:"additionalItems"},`${r}/additionalItems`,n,o,s)]:[]:Array.isArray(t)?[...t.map(((t,a)=>(0,field_1.getField)(e,{name:`[${i+a}]`,schema:t,kind:"additionalItems"},`${r}/additionalItems/${a}`,n,o,s)))]:(0,theme_1.isObject)(t)?[(0,field_1.getField)(e,{name:`[${i}...]`,schema:t,kind:"additionalItems"},`${r}/additionalItems`,n,o,s)]:[]}function getDiscriminator(e){return e.discriminator||e["x-discriminator"]}function hasType(e,t){return e.type===t||Array.isArray(e.type)&&e.type.includes(t)}exports.getSchema=getSchema;
|
|
2
2
|
//# sourceMappingURL=schema.js.map
|
package/lib/models/types.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
export declare function normalizeShowExtensions(value:
|
|
3
|
-
export declare function normalizeScrollYOffset(value:
|
|
1
|
+
import type { RedocConfig } from '@redocly/config';
|
|
2
|
+
export declare function normalizeShowExtensions(value: RedocConfig['showExtensions']): string[] | boolean;
|
|
3
|
+
export declare function normalizeScrollYOffset(value: RedocConfig['scrollYOffset']): () => number;
|
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
import type { Options
|
|
2
|
-
|
|
1
|
+
import type { Options } from './types';
|
|
2
|
+
import type { RedocConfig } from '@redocly/config';
|
|
3
|
+
export declare function normalizeOptions(raw?: RedocConfig, defaultOptions?: RedocConfig): Options;
|
|
@@ -6,54 +6,6 @@ import type { Events } from '../../events';
|
|
|
6
6
|
import type { LayoutVariant } from '@redocly/theme';
|
|
7
7
|
import type { OperationModel } from '../../models/types';
|
|
8
8
|
import type { DownloadUrlsConfig } from '../../components/Download/types';
|
|
9
|
-
export interface RawOptions {
|
|
10
|
-
licenseKey?: string;
|
|
11
|
-
scrollYOffset?: number | string | (() => number);
|
|
12
|
-
hideLoading?: boolean | string;
|
|
13
|
-
markdocOptions?: {
|
|
14
|
-
tags: Record<string, Schema>;
|
|
15
|
-
nodes: Record<string, Schema>;
|
|
16
|
-
components: Record<string, ComponentType>;
|
|
17
|
-
variables?: Record<string, any>;
|
|
18
|
-
partials?: Record<string, any>;
|
|
19
|
-
functions?: Record<string, ConfigFunction>;
|
|
20
|
-
};
|
|
21
|
-
disableRouter?: boolean;
|
|
22
|
-
hideSidebar?: boolean;
|
|
23
|
-
feedback?: Record<string, any>;
|
|
24
|
-
unstable_hooks?: HooksConfig;
|
|
25
|
-
hideReplay?: boolean | string;
|
|
26
|
-
oAuth2RedirectURI?: string | null;
|
|
27
|
-
corsProxyUrl?: string;
|
|
28
|
-
requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
|
|
29
|
-
sortRequiredPropsFirst?: boolean | string;
|
|
30
|
-
sanitize?: boolean | string;
|
|
31
|
-
hideDownloadButtons?: boolean | string;
|
|
32
|
-
downloadUrls?: DownloadUrlsConfig;
|
|
33
|
-
onlyRequiredInSamples?: boolean | string;
|
|
34
|
-
generatedSamplesMaxDepth?: number | string;
|
|
35
|
-
showExtensions?: boolean | string | string[];
|
|
36
|
-
hideSchemaTitles?: boolean | string;
|
|
37
|
-
jsonSamplesExpandLevel?: number | string | 'all';
|
|
38
|
-
schemasExpansionLevel?: number | string | 'all';
|
|
39
|
-
mockServer?: {
|
|
40
|
-
url?: string;
|
|
41
|
-
position?: 'first' | 'last' | 'replace' | 'off';
|
|
42
|
-
description?: string;
|
|
43
|
-
};
|
|
44
|
-
maxDisplayedEnumValues?: number;
|
|
45
|
-
unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
|
|
46
|
-
schemaDefinitionsTagName?: string;
|
|
47
|
-
layout?: LayoutVariant;
|
|
48
|
-
hideInfoMetadata?: boolean;
|
|
49
|
-
events?: Events;
|
|
50
|
-
onDeepLinkClick?: ((link: string) => void) | undefined | null;
|
|
51
|
-
skipBundle?: boolean;
|
|
52
|
-
routingBasePath?: string;
|
|
53
|
-
codeSamples?: CodeSamplesConfig;
|
|
54
|
-
ignoreNamedSchemas?: string[] | string;
|
|
55
|
-
hidePropertiesPrefix?: boolean | string;
|
|
56
|
-
}
|
|
57
9
|
export interface Options {
|
|
58
10
|
scrollYOffset: () => number;
|
|
59
11
|
hideLoading: boolean;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getHref=exports.getOperationsItems=void 0;const utils_1=require("../../utils");function getOperationsItems(e,t,
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getHref=exports.getOperationsItems=void 0;const utils_1=require("../../utils");function getOperationsItems(e,t,r){if(0===t.operations.length)return[];const o=[],s=[];for(const i of t.operations){const t=(0,utils_1.getOperationId)(i,e),p={id:t,type:"operation",parent:e,operationDefinition:i,depth:r,name:(0,utils_1.getOperationName)(i),httpVerb:i.httpVerb,path:i.pathName,items:[],isWebhook:i.isWebhook,operationId:i.operationId,badges:i["x-badges"]||[],href:getHref({id:t}),deprecated:!!i.deprecated};i.isWebhook?s.push(p):o.push(p)}return[...o.sort(((e,t)=>Number(e.deprecated)-Number(t.deprecated))),...s.sort(((e,t)=>Number(e.deprecated)-Number(t.deprecated)))]}function getHref({id:e}){return(0,utils_1.encodeBackSlashes)(`/${e}`.toLowerCase())}exports.getOperationsItems=getOperationsItems,exports.getHref=getHref;
|
|
2
2
|
//# sourceMappingURL=operation.js.map
|
package/lib/standalone.d.ts
CHANGED
|
@@ -13,12 +13,12 @@ import 'core-js/es/string/starts-with';
|
|
|
13
13
|
import 'core-js/es/symbol';
|
|
14
14
|
import 'unfetch/polyfill/index';
|
|
15
15
|
import 'url-polyfill';
|
|
16
|
+
import type { RedocConfig } from '@redocly/config';
|
|
16
17
|
import type { OpenAPIDefinition } from './types';
|
|
17
|
-
import type { RawOptions } from './services';
|
|
18
18
|
import type { StoreProviderProps } from './components';
|
|
19
19
|
export { setSecurityDetails, setParameterValue, setSecurityDetailsVariants } from './utils';
|
|
20
20
|
export declare function hydrate(store: StoreProviderProps, element?: Element | null): void;
|
|
21
|
-
export declare function init(definitionOrDefinitionUrl: string | OpenAPIDefinition, options?:
|
|
21
|
+
export declare function init(definitionOrDefinitionUrl: string | OpenAPIDefinition, options?: RedocConfig, element?: Element | null): void;
|
|
22
22
|
export declare function setPublicPath(path: string): void;
|
|
23
23
|
export declare const version: string;
|
|
24
24
|
export declare const revision: string;
|
package/lib/utils/openapi.d.ts
CHANGED
|
@@ -24,6 +24,7 @@ export declare function getDefinitionName(pointer?: string): string | undefined;
|
|
|
24
24
|
export declare function humanizeNumberRange(schema: OpenAPISchema): string | undefined;
|
|
25
25
|
export declare function humanizeConstraints(schema: OpenAPISchema): string[];
|
|
26
26
|
export declare function sortByRequired(fields: FieldModel[], order?: string[]): Array<FieldModel>;
|
|
27
|
+
export declare function sortByDeprecated(fields: FieldModel[]): Array<FieldModel>;
|
|
27
28
|
export declare function mergeParams(parser: OpenAPIParser, pathParams: Referenced<OpenAPIParameter>[] | undefined, operationParams: Referenced<OpenAPIParameter>[] | undefined, { pathPointer, operationPointer }: {
|
|
28
29
|
pathPointer: any;
|
|
29
30
|
operationPointer: any;
|
package/lib/utils/openapi.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getContentWithLegacyExamples=exports.pluralizeType=exports.extractExtensions=exports.isRedocExtension=exports.shortenHTTPVerb=exports.normalizeServers=exports.mergeParams=exports.sortByRequired=exports.humanizeConstraints=exports.humanizeNumberRange=exports.getDefinitionName=exports.isNamedDefinition=exports.langFromMime=exports.serializeParameterValue=exports.serializeParameterValueWithMime=exports.serializeQueryParameter=exports.urlFormEncodePayload=exports.isMultipartFormData=exports.isFormUrlEncoded=exports.isJsonLike=exports.isPrimitiveType=exports.detectType=exports.getOperationId=exports.getOperationName=exports.isOperationName=exports.getStatusCodeType=exports.isStatusCode=void 0;const path_1=require("path"),url_template_1=__importDefault(require("url-template")),theme_1=require("@redocly/theme"),helpers_1=require("./helpers"),constants_1=require("../constants"),JsonPointer_1=require("./JsonPointer"),services_1=require("../services");function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}function isStatusCode(e){return"default"===e||(0,helpers_1.isNumeric)(e)||isWildcardStatusCode(e)}function getStatusCodeType(e,r=!1){if("default"===e)return r?"error":"success";let t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}exports.isStatusCode=isStatusCode,exports.getStatusCodeType=getStatusCodeType;const operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};function isOperationName(e){return e in operationNames}function getOperationName(e){const{operationId:r,pathName:t}=e,i=(0,helpers_1.normalizeText)((0,helpers_1.getValueFromMdParsedExtension)(e,"description"));return(0,helpers_1.normalizeText)((0,helpers_1.getValueFromMdParsedExtension)(e,"summary"))||r||i&&i.substring(0,50)||t||"<no summary>"}function getOperationId(e,r){var t;return(null==r?void 0:r.id)?(0,services_1.joinWithSeparator)(r.id,(0,helpers_1.sanitizeItemId)(e.operationId?e.operationId:pointerToId(e.pointer))).toLowerCase():(null===(t=e.tags)||void 0===t?void 0:t.length)?(0,helpers_1.sanitizeItemId)(e.operationId?e.operationId:pointerToId(e.pointer)):(0,helpers_1.sanitizeItemId)(e.operationId?(0,services_1.joinWithSeparator)(constants_1.DEFAULT_TAG_SLUG,e.operationId):pointerToId(e.pointer))}function pointerToId(e){return(null==e?void 0:e.startsWith("/"))?e.slice(1,e.length):e}exports.isOperationName=isOperationName,exports.getOperationName=getOperationName,exports.getOperationId=getOperationId;const 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",patternProperties:"object",properties:"object"};function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;const r=Object.keys(schemaKeywordTypes);for(const t of r){const r=schemaKeywordTypes[t];if(void 0!==e[t])return r}return"any"}function isPrimitiveType(e,r=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let t=!0;const 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.patternProperties),!Array.isArray(e.items)&&!Array.isArray(e.prefixItems)&&(void 0!==e.items&&"boolean"!=typeof e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t)}function isJsonLike(e){return-1!==e.search(/json/i)}function isFormUrlEncoded(e){return e===constants_1.MediaTypes.URL_ENCODED}function isMultipartFormData(e){return e===constants_1.MediaTypes.MULTIPART}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((e=>e.toString())).join(t):"object"==typeof e?Object.keys(e).map((r=>`${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((t=>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){const i="__redoc_param_name__",n=r?"*":"";return url_template_1.default.parse(`{?${i}${n}}`).expand({[i]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function serializeSimpleValue(e,r){const t=e?"*":"",i="__redoc_param_name__",n=url_template_1.default.parse(`{${i}${t}}`);return decodeURIComponent(n.expand({[i]:r}))}function urlFormEncodePayload(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((t=>{const i=e[t],{style:n="form",explode:o=!0}=r[t]||{};switch(n){case"form":return serializeFormValue(t,o,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: "+n),""}})).join("&")}function serializePathParameter(e,r,t,i){const n=t?"*":"";let o="";"label"===r?o=".":"matrix"===r&&(o=";");const a="__redoc_param_name__";return url_template_1.default.parse(`{${o}${a}${n}}`).expand({[a]:i}).replace(/__redoc_param_name__/g,e)}function serializeQueryParameter(e,r,t,i){const n=n=>{switch(r){case"form":return serializeFormValue(e,t,n);case"spaceDelimited":return Array.isArray(n)||"object"==typeof n?t?serializeFormValue(e,t,n):delimitedEncodeField(i,e,"%20"):(console.warn("The style spaceDelimited is applicable to arrays or objects"),"");case"pipeDelimited":return Array.isArray(n)||"object"==typeof n?t?serializeFormValue(e,t,n):delimitedEncodeField(i,e,"|"):(console.warn("The style pipeDelimited is applicable to arrays or objects"),"");case"deepObject":return!t||Array.isArray(n)||"object"!=typeof n?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(n,e);case"simple":return serializeSimpleValue(t,i);default:return console.warn("Unexpected style for query: "+r),""}};return(0,helpers_1.isArrayOfObjects)(i)&&(i=(0,helpers_1.deleteEmptyArrayItem)(i).map((e=>n(e)))),n(i)}function serializeHeaderParameter(e,r,t){return"simple"===e?serializeSimpleValue(r,t):(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),"")}function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}function serializeParameterValue(e,r){const{name:t,style:i,explode:n=!1,serializationMime:o}=e;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,n,r);case"query":return serializeQueryParameter(t,i,n,r);case"header":return serializeHeaderParameter(i,n,r);case"cookie":return serializeCookieParameter(t,i,n,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}exports.detectType=detectType,exports.isPrimitiveType=isPrimitiveType,exports.isJsonLike=isJsonLike,exports.isFormUrlEncoded=isFormUrlEncoded,exports.isMultipartFormData=isMultipartFormData,exports.urlFormEncodePayload=urlFormEncodePayload,exports.serializeQueryParameter=serializeQueryParameter,exports.serializeParameterValueWithMime=serializeParameterValueWithMime,exports.serializeParameterValue=serializeParameterValue,exports.langFromMime=langFromMime;const DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}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)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function humanizeRangeConstraint(e,r,t){let 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}function humanizeNumberRange(e){var r,t;const 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,o="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,a="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?`${o?"( ":"[ "}${i} .. ${n}${a?" )":" ]"}`:void 0!==n?`${a?"< ":"<= "}${n}`:void 0!==i?`${o?"> ":">= "}${i}`:void 0}function humanizeConstraints(e){const r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);const i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);const n=humanizeRangeConstraint(1===e.minProperties&&1===e.maxProperties?"property":"properties",e.minProperties,e.maxProperties);void 0!==n&&r.push(n);const o=humanizeMultipleOfConstraint(e.multipleOf);void 0!==o&&r.push(o);const a=humanizeNumberRange(e);return void 0!==a&&r.push(a),e.uniqueItems&&r.push("unique"),r}function sortByRequired(e,r=[]){const t=[],i=[],n=[];return e.forEach((e=>{e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort(((e,t)=>r.indexOf(e.name)-r.indexOf(t.name))),[...i,...n,...t]}function mergeParams(e,r=[],t=[],{pathPointer:i,operationPointer:n}){const o={};t.forEach((r=>{({resolved:r}=e.deref(r)),o[r.name+"_"+r.in]=!0}));return[...r.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(i,["parameters",String(r)])}))).filter((({paramOrRef:r})=>(({resolved:r}=e.deref(r)),!o[r.name+"_"+r.in]))),...t.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(n,["parameters",String(r)])})))]}function normalizeServers(e,r){const t=void 0===e?(0,helpers_1.removeQueryStringAndHash)((()=>{if(!theme_1.IS_BROWSER)return globalThis.SSR_HOSTNAME||"";const e=window.location.href;return e.endsWith(".html")?(0,path_1.dirname)(e):e})()):(0,path_1.dirname)(e);return 0===r.length&&(r=[{url:"/"}]),r.map((e=>{return Object.assign(Object.assign({},e),{url:(r=e.url,(0,helpers_1.resolveUrl)(t,r)),description:e.description||""});var r}))}exports.isNamedDefinition=isNamedDefinition,exports.getDefinitionName=getDefinitionName,exports.humanizeNumberRange=humanizeNumberRange,exports.humanizeConstraints=humanizeConstraints,exports.sortByRequired=sortByRequired,exports.mergeParams=mergeParams,exports.normalizeServers=normalizeServers;const shortenHTTPVerb=e=>({delete:"del",options:"opts"}[e]||e);function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!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-hideReplay":!0,"x-tokenEndpointAuthMethod":!0,"x-feedback":!0,"x-badges":!0}||e.startsWith("x-parsed-md-")}function extractExtensions(e,r){return Object.keys(e).filter((e=>!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1)).reduce(((r,t)=>(r[t]=e[t],r)),{})}function pluralizeType(e){return e.split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or ")}function getContentWithLegacyExamples(e){let r=e.content;const t=e["x-examples"],i=e["x-example"];if(t){r=Object.assign({},r);for(const e of Object.keys(t)){const i=t[e];r[e]=Object.assign(Object.assign({},r[e]),{examples:i})}}else if(i){r=Object.assign({},r);for(const e of Object.keys(i)){const t=i[e];r[e]=Object.assign(Object.assign({},r[e]),{example:t})}}return r}exports.shortenHTTPVerb=shortenHTTPVerb,exports.isRedocExtension=isRedocExtension,exports.extractExtensions=extractExtensions,exports.pluralizeType=pluralizeType,exports.getContentWithLegacyExamples=getContentWithLegacyExamples;
|
|
1
|
+
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getContentWithLegacyExamples=exports.pluralizeType=exports.extractExtensions=exports.isRedocExtension=exports.shortenHTTPVerb=exports.normalizeServers=exports.mergeParams=exports.sortByDeprecated=exports.sortByRequired=exports.humanizeConstraints=exports.humanizeNumberRange=exports.getDefinitionName=exports.isNamedDefinition=exports.langFromMime=exports.serializeParameterValue=exports.serializeParameterValueWithMime=exports.serializeQueryParameter=exports.urlFormEncodePayload=exports.isMultipartFormData=exports.isFormUrlEncoded=exports.isJsonLike=exports.isPrimitiveType=exports.detectType=exports.getOperationId=exports.getOperationName=exports.isOperationName=exports.getStatusCodeType=exports.isStatusCode=void 0;const path_1=require("path"),url_template_1=__importDefault(require("url-template")),theme_1=require("@redocly/theme"),helpers_1=require("./helpers"),constants_1=require("../constants"),JsonPointer_1=require("./JsonPointer"),services_1=require("../services");function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}function isStatusCode(e){return"default"===e||(0,helpers_1.isNumeric)(e)||isWildcardStatusCode(e)}function getStatusCodeType(e,r=!1){if("default"===e)return r?"error":"success";let t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}exports.isStatusCode=isStatusCode,exports.getStatusCodeType=getStatusCodeType;const operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};function isOperationName(e){return e in operationNames}function getOperationName(e){const{operationId:r,pathName:t}=e,i=(0,helpers_1.normalizeText)((0,helpers_1.getValueFromMdParsedExtension)(e,"description"));return(0,helpers_1.normalizeText)((0,helpers_1.getValueFromMdParsedExtension)(e,"summary"))||r||i&&i.substring(0,50)||t||"<no summary>"}function getOperationId(e,r){var t;return(null==r?void 0:r.id)?(0,services_1.joinWithSeparator)(r.id,(0,helpers_1.sanitizeItemId)(e.operationId?e.operationId:pointerToId(e.pointer))).toLowerCase():(null===(t=e.tags)||void 0===t?void 0:t.length)?(0,helpers_1.sanitizeItemId)(e.operationId?e.operationId:pointerToId(e.pointer)):(0,helpers_1.sanitizeItemId)(e.operationId?(0,services_1.joinWithSeparator)(constants_1.DEFAULT_TAG_SLUG,e.operationId):pointerToId(e.pointer))}function pointerToId(e){return(null==e?void 0:e.startsWith("/"))?e.slice(1,e.length):e}exports.isOperationName=isOperationName,exports.getOperationName=getOperationName,exports.getOperationId=getOperationId;const 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",patternProperties:"object",properties:"object"};function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;const r=Object.keys(schemaKeywordTypes);for(const t of r){const r=schemaKeywordTypes[t];if(void 0!==e[t])return r}return"any"}function isPrimitiveType(e,r=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let t=!0;const 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.patternProperties),!Array.isArray(e.items)&&!Array.isArray(e.prefixItems)&&(void 0!==e.items&&"boolean"!=typeof e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t)}function isJsonLike(e){return-1!==e.search(/json/i)}function isFormUrlEncoded(e){return e===constants_1.MediaTypes.URL_ENCODED}function isMultipartFormData(e){return e===constants_1.MediaTypes.MULTIPART}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((e=>e.toString())).join(t):"object"==typeof e?Object.keys(e).map((r=>`${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((t=>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){const i="__redoc_param_name__",n=r?"*":"";return url_template_1.default.parse(`{?${i}${n}}`).expand({[i]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function serializeSimpleValue(e,r){const t=e?"*":"",i="__redoc_param_name__",n=url_template_1.default.parse(`{${i}${t}}`);return decodeURIComponent(n.expand({[i]:r}))}function urlFormEncodePayload(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((t=>{const i=e[t],{style:n="form",explode:o=!0}=r[t]||{};switch(n){case"form":return serializeFormValue(t,o,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: "+n),""}})).join("&")}function serializePathParameter(e,r,t,i){const n=t?"*":"";let o="";"label"===r?o=".":"matrix"===r&&(o=";");const a="__redoc_param_name__";return url_template_1.default.parse(`{${o}${a}${n}}`).expand({[a]:i}).replace(/__redoc_param_name__/g,e)}function serializeQueryParameter(e,r,t,i){const n=n=>{switch(r){case"form":return serializeFormValue(e,t,n);case"spaceDelimited":return Array.isArray(n)||"object"==typeof n?t?serializeFormValue(e,t,n):delimitedEncodeField(i,e,"%20"):(console.warn("The style spaceDelimited is applicable to arrays or objects"),"");case"pipeDelimited":return Array.isArray(n)||"object"==typeof n?t?serializeFormValue(e,t,n):delimitedEncodeField(i,e,"|"):(console.warn("The style pipeDelimited is applicable to arrays or objects"),"");case"deepObject":return!t||Array.isArray(n)||"object"!=typeof n?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(n,e);case"simple":return serializeSimpleValue(t,i);default:return console.warn("Unexpected style for query: "+r),""}};return(0,helpers_1.isArrayOfObjects)(i)&&(i=(0,helpers_1.deleteEmptyArrayItem)(i).map((e=>n(e)))),n(i)}function serializeHeaderParameter(e,r,t){return"simple"===e?serializeSimpleValue(r,t):(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),"")}function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}function serializeParameterValue(e,r){const{name:t,style:i,explode:n=!1,serializationMime:o}=e;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,n,r);case"query":return serializeQueryParameter(t,i,n,r);case"header":return serializeHeaderParameter(i,n,r);case"cookie":return serializeCookieParameter(t,i,n,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}exports.detectType=detectType,exports.isPrimitiveType=isPrimitiveType,exports.isJsonLike=isJsonLike,exports.isFormUrlEncoded=isFormUrlEncoded,exports.isMultipartFormData=isMultipartFormData,exports.urlFormEncodePayload=urlFormEncodePayload,exports.serializeQueryParameter=serializeQueryParameter,exports.serializeParameterValueWithMime=serializeParameterValueWithMime,exports.serializeParameterValue=serializeParameterValue,exports.langFromMime=langFromMime;const DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}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)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function humanizeRangeConstraint(e,r,t){let 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}function humanizeNumberRange(e){var r,t;const 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,o="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,a="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?`${o?"( ":"[ "}${i} .. ${n}${a?" )":" ]"}`:void 0!==n?`${a?"< ":"<= "}${n}`:void 0!==i?`${o?"> ":">= "}${i}`:void 0}function humanizeConstraints(e){const r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);const i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);const n=humanizeRangeConstraint(1===e.minProperties&&1===e.maxProperties?"property":"properties",e.minProperties,e.maxProperties);void 0!==n&&r.push(n);const o=humanizeMultipleOfConstraint(e.multipleOf);void 0!==o&&r.push(o);const a=humanizeNumberRange(e);return void 0!==a&&r.push(a),e.uniqueItems&&r.push("unique"),r}function sortByRequired(e,r=[]){const t=[],i=[],n=[];return e.forEach((e=>{e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort(((e,t)=>r.indexOf(e.name)-r.indexOf(t.name))),[...i,...n,...t]}function sortByDeprecated(e){return e.sort(((e,r)=>Number(e.deprecated)-Number(r.deprecated)))}function mergeParams(e,r=[],t=[],{pathPointer:i,operationPointer:n}){const o={};t.forEach((r=>{({resolved:r}=e.deref(r)),o[r.name+"_"+r.in]=!0}));return[...r.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(i,["parameters",String(r)])}))).filter((({paramOrRef:r})=>(({resolved:r}=e.deref(r)),!o[r.name+"_"+r.in]))),...t.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(n,["parameters",String(r)])})))]}function normalizeServers(e,r){const t=void 0===e?(0,helpers_1.removeQueryStringAndHash)((()=>{if(!theme_1.IS_BROWSER)return globalThis.SSR_HOSTNAME||"";const e=window.location.href;return e.endsWith(".html")?(0,path_1.dirname)(e):e})()):(0,path_1.dirname)(e);return 0===r.length&&(r=[{url:"/"}]),r.map((e=>{return Object.assign(Object.assign({},e),{url:(r=e.url,(0,helpers_1.resolveUrl)(t,r)),description:e.description||""});var r}))}exports.isNamedDefinition=isNamedDefinition,exports.getDefinitionName=getDefinitionName,exports.humanizeNumberRange=humanizeNumberRange,exports.humanizeConstraints=humanizeConstraints,exports.sortByRequired=sortByRequired,exports.sortByDeprecated=sortByDeprecated,exports.mergeParams=mergeParams,exports.normalizeServers=normalizeServers;const shortenHTTPVerb=e=>({delete:"del",options:"opts"}[e]||e);function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!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-hideReplay":!0,"x-tokenEndpointAuthMethod":!0,"x-feedback":!0,"x-badges":!0}||e.startsWith("x-parsed-md-")}function extractExtensions(e,r){return Object.keys(e).filter((e=>!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1)).reduce(((r,t)=>(r[t]=e[t],r)),{})}function pluralizeType(e){return e.split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or ")}function getContentWithLegacyExamples(e){let r=e.content;const t=e["x-examples"],i=e["x-example"];if(t){r=Object.assign({},r);for(const e of Object.keys(t)){const i=t[e];r[e]=Object.assign(Object.assign({},r[e]),{examples:i})}}else if(i){r=Object.assign({},r);for(const e of Object.keys(i)){const t=i[e];r[e]=Object.assign(Object.assign({},r[e]),{example:t})}}return r}exports.shortenHTTPVerb=shortenHTTPVerb,exports.isRedocExtension=isRedocExtension,exports.extractExtensions=extractExtensions,exports.pluralizeType=pluralizeType,exports.getContentWithLegacyExamples=getContentWithLegacyExamples;
|
|
2
2
|
//# sourceMappingURL=openapi.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{jsx as _jsx,jsxs as _jsxs,Fragment as _Fragment}from"react/jsx-runtime";import{useRef,memo}from"react";import{SidebarLogo,GlobalStyle as ThemeCommonStyle,useMount,LayoutVariant,ThreePanelLayout}from"@redocly/theme";import{UnsupportedFeatureScreen}from"../UnsupportedFeatureScreen";import{AppProvider,StoreProvider}from"./Providers";import{Overlay}from"../Overlay";import{
|
|
1
|
+
import{jsx as _jsx,jsxs as _jsxs,Fragment as _Fragment}from"react/jsx-runtime";import{useRef,memo}from"react";import{SidebarLogo,GlobalStyle as ThemeCommonStyle,useMount,LayoutVariant,ThreePanelLayout}from"@redocly/theme";import{UnsupportedFeatureScreen}from"../UnsupportedFeatureScreen";import{AppProvider,StoreProvider}from"./Providers";import{Overlay}from"../Overlay";import{RedocWrap,CssFixes}from"./styled";import{StickyResponsiveSidebar}from"../StickySidebar";import{SideMenu}from"../SideMenu";import{Content}from"../Content";import{useContentItems,useUppercase2LowercaseRedirect}from"../../hooks";import{withRouter}from"../../hoc/withRouter";import{withStore}from"../../hoc/withStore";import{compose}from"../../utils";import{useLicense}from"../../hooks/useLicense";const RedoclyOpenAPIDocsComponent=compose(withRouter,withStore,memo)((({licenseKey:e,onLoaded:o,children:t,options:i,layout:n,collapsedSidebar:r,parser:s,withCommonStyles:a})=>{var l,d,c,m,u;const p=useRef(null),{isValid:v,licenseInfo:f}=useLicense(e);useUppercase2LowercaseRedirect(),useMount((()=>{null==o||o()}));const{hideSidebar:h,scrollYOffset:S}=i||{},{contentItems:y}=useContentItems({parser:s,options:i}),x=null===(d=null===(l=s.definition)||void 0===l?void 0:l.info)||void 0===d?void 0:d["x-logo"];return _jsxs(_Fragment,{children:[a&&_jsx(ThemeCommonStyle,{}),_jsxs(RedocWrap,{className:"redoc-wrap",ref:p,children:[_jsx(UnsupportedFeatureScreen,{}),!v&&_jsx(Overlay,{licenseInfo:f}),_jsx(CssFixes,{layout:n}),!h&&_jsxs(StickyResponsiveSidebar,{scrollYOffset:S,className:"menu-content",collapsedSidebar:!r,children:[_jsx(SidebarLogo,{imageUrl:null==x?void 0:x.url,href:(null==x?void 0:x.href)||(null===(u=null===(m=null===(c=s.definition)||void 0===c?void 0:c.info)||void 0===m?void 0:m.contact)||void 0===u?void 0:u.url),altText:null==x?void 0:x.altText,backgroundColor:null==x?void 0:x.backgroundColor}),_jsx(SideMenu,{items:v?y:[]})]}),_jsxs(ThreePanelLayout,{className:"api-content",id:"api-content",layout:n===LayoutVariant.THREE_PANEL?LayoutVariant.THREE_PANEL:LayoutVariant.STACKED,collapsedSidebar:r,children:[_jsx(Content,{items:v?y:[],routingBasePath:i.routingBasePath}),t]})]})]})}));export function RedoclyOpenAPIDocs({onLoaded:e,children:o,store:t,withCommonStyles:i}){var n,r,s;return(null==t?void 0:t.definition)?_jsx(StoreProvider,Object.assign({},t,{children:_jsx(RedoclyOpenAPIDocsComponent,{onLoaded:e,basePath:null===(n=t.options)||void 0===n?void 0:n.routingBasePath,licenseKey:null===(r=t.options)||void 0===r?void 0:r.licenseKey,disableRouter:null===(s=t.options)||void 0===s?void 0:s.disableRouter,withCommonStyles:i,children:o})})):null}export function RedoclyOpenAPIDocsStandalone({definition:e,definitionUrl:o,options:t={},activeItemId:i,activeSampleLanguage:n,activeDeepLink:r}){return _jsx(AppProvider,{definition:e,definitionUrl:o,options:t,activeItemId:i,activeSampleLanguage:n,activeDeepLink:r,children:_jsx(RedoclyOpenAPIDocs,{withCommonStyles:!0})})}
|
|
2
2
|
//# sourceMappingURL=RedoclyOpenAPIDocs.js.map
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
import type { FlattenSimpleInterpolation } from 'styled-components';
|
|
2
2
|
import type { CssFixesProps } from './types';
|
|
3
3
|
export declare const RedocWrap: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
4
|
-
export declare const BackgroundStub: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
5
|
-
export declare const RedocWrapStyled: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
6
4
|
export declare const getMarginFixesByName: (variableName: string) => FlattenSimpleInterpolation;
|
|
7
5
|
export declare const CssFixes: import("styled-components").GlobalStyleComponent<CssFixesProps, import("styled-components").DefaultTheme>;
|