@redocly/openapi-docs 0.0.0-beta-20240409160536 → 0.0.0-beta-20240410152801

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.
@@ -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.ApiInfo=void 0;const jsx_runtime_1=require("react/jsx-runtime"),jotai_1=require("jotai"),theme_1=require("@redocly/theme"),styled_components_1=__importDefault(require("styled-components")),app_1=require("../../jotai/app"),common_1=require("../common"),ExternalDocumentation_1=require("../ExternalDocumentation"),Markdown_1=require("../Markdown"),styled_1=require("./styled"),store_1=require("../../jotai/store"),saveTextBeforeHeading_1=require("../../utils/saveTextBeforeHeading"),helpers_1=require("../../utils/helpers"),RenderHook_1=require("../RenderHook"),Metadata_1=require("./Metadata"),RightPanel_1=require("../RightPanel/RightPanel");function ApiInfo({item:e}){const{options:{unstable_hooks:t,hideInfoSection:o,hideInfoDescription:i,hideInfoMetadata:n},parser:{definition:r}}=(0,jotai_1.useAtomValue)(store_1.globalStoreAtom),a=(0,jotai_1.useAtomValue)(app_1.layoutAtom),s=e.infoDefinition;if(!s||o)return null;const l=i?null:(0,saveTextBeforeHeading_1.saveTextBeforeHeading)((0,helpers_1.getValueFromMdParsedExtension)(s,"description")||""),_=(0,helpers_1.getValueFromMdParsedExtension)(s,"summary")||void 0,u=null==r?void 0:r.externalDocs,d=s.version&&(0,jsx_runtime_1.jsxs)("span",{children:["(",s.version,")"]})||null,m=a===theme_1.LayoutVariant.STACKED;return(0,jsx_runtime_1.jsxs)(common_1.Row,{layout:a,children:[(0,jsx_runtime_1.jsxs)(common_1.SamplesMiddlePanel,{fullWidth:!0,className:"api-info",isStacked:m,children:[(0,jsx_runtime_1.jsxs)(styled_1.ApiHeader,{children:[s.title," ",d]}),(0,jsx_runtime_1.jsx)(RenderHook_1.RenderHook,{Hook:theme_1.AfterOpenApiTitle||(null==t?void 0:t.AfterApiTitle),props:{info:s}}),_&&(0,jsx_runtime_1.jsx)(Markdown_1.Markdown,{source:_,"data-role":"redoc-summary"}),l&&(0,jsx_runtime_1.jsx)(Markdown_1.Markdown,{source:l,"data-role":"redoc-description"}),u&&(0,jsx_runtime_1.jsx)(ExternalDocumentation_1.ExternalDocumentation,{externalDocs:u}),!n&&(0,jsx_runtime_1.jsx)(Metadata_1.Metadata,{metadata:s["x-metadata"]})]}),(0,jsx_runtime_1.jsx)(RightPanelContainer,{isStacked:m,children:(0,jsx_runtime_1.jsx)(RightPanel_1.RightPanel,{item:e})})]})}exports.ApiInfo=ApiInfo;const RightPanelContainer=(0,styled_components_1.default)(common_1.SamplesPanel)`
1
+ "use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ApiInfo=void 0;const jsx_runtime_1=require("react/jsx-runtime"),jotai_1=require("jotai"),theme_1=require("@redocly/theme"),styled_components_1=__importDefault(require("styled-components")),app_1=require("../../jotai/app"),common_1=require("../common"),ExternalDocumentation_1=require("../ExternalDocumentation"),Markdown_1=require("../Markdown"),styled_1=require("./styled"),store_1=require("../../jotai/store"),saveTextBeforeHeading_1=require("../../utils/saveTextBeforeHeading"),helpers_1=require("../../utils/helpers"),RenderHook_1=require("../RenderHook"),Metadata_1=require("./Metadata"),RightPanel_1=require("../RightPanel/RightPanel");function ApiInfo({item:e}){const{options:{unstable_hooks:t,hideInfoDescription:o,hideInfoMetadata:i},parser:{definition:r}}=(0,jotai_1.useAtomValue)(store_1.globalStoreAtom),n=(0,jotai_1.useAtomValue)(app_1.layoutAtom),a=e.infoDefinition;if(!a)return null;const s=o?null:(0,saveTextBeforeHeading_1.saveTextBeforeHeading)((0,helpers_1.getValueFromMdParsedExtension)(a,"description")||""),l=(0,helpers_1.getValueFromMdParsedExtension)(a,"summary")||void 0,_=null==r?void 0:r.externalDocs,u=a.version&&(0,jsx_runtime_1.jsxs)("span",{children:["(",a.version,")"]})||null,d=n===theme_1.LayoutVariant.STACKED;return(0,jsx_runtime_1.jsxs)(common_1.Row,{layout:n,children:[(0,jsx_runtime_1.jsxs)(common_1.SamplesMiddlePanel,{fullWidth:!0,className:"api-info",isStacked:d,children:[(0,jsx_runtime_1.jsxs)(styled_1.ApiHeader,{children:[a.title," ",u]}),(0,jsx_runtime_1.jsx)(RenderHook_1.RenderHook,{Hook:theme_1.AfterOpenApiTitle||(null==t?void 0:t.AfterApiTitle),props:{info:a}}),l&&(0,jsx_runtime_1.jsx)(Markdown_1.Markdown,{source:l,"data-role":"redoc-summary"}),s&&(0,jsx_runtime_1.jsx)(Markdown_1.Markdown,{source:s,"data-role":"redoc-description"}),_&&(0,jsx_runtime_1.jsx)(ExternalDocumentation_1.ExternalDocumentation,{externalDocs:_}),!i&&(0,jsx_runtime_1.jsx)(Metadata_1.Metadata,{metadata:a["x-metadata"]})]}),(0,jsx_runtime_1.jsx)(RightPanelContainer,{isStacked:d,children:(0,jsx_runtime_1.jsx)(RightPanel_1.RightPanel,{item:e})})]})}exports.ApiInfo=ApiInfo;const RightPanelContainer=(0,styled_components_1.default)(common_1.SamplesPanel)`
2
2
  position: static;
3
3
  @media screen and (min-width: ${theme_1.breakpoints.medium}) {
4
4
  display: ${({isStacked:e})=>e?"block":"none"};
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeOptions=void 0;const theme_1=require("@redocly/theme"),constants_1=require("../../constants"),utils_1=require("../../utils"),helpers_1=require("./helpers"),constants_2=require("../code-samples/constants");function normalizeOptions(e,o){var n,i,s,a,l,t,r,d,u,c,p;e=Object.assign(Object.assign(Object.assign({},o),e),{markdocOptions:Object.assign(Object.assign({},null==e?void 0:e.markdocOptions),{components:Object.assign(Object.assign({},null===(n=null==o?void 0:o.markdocOptions)||void 0===n?void 0:n.components),null===(i=null==e?void 0:e.markdocOptions)||void 0===i?void 0:i.components),tags:Object.assign(Object.assign({},null===(s=null==o?void 0:o.markdocOptions)||void 0===s?void 0:s.tags),null===(a=null==e?void 0:e.markdocOptions)||void 0===a?void 0:a.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(l=null==o?void 0:o.markdocOptions)||void 0===l?void 0:l.nodes),null===(t=null==e?void 0:e.markdocOptions)||void 0===t?void 0:t.nodes),{heading:(null===(d=null===(r=null==o?void 0:o.markdocOptions)||void 0===r?void 0:r.nodes)||void 0===d?void 0:d.heading)||(null===(u=null==e?void 0:e.markdocOptions)||void 0===u?void 0:u.nodes.heading)})})});const m=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(c=e.ignoreNamedSchemas)||void 0===c?void 0:c.split(",").map((e=>e.trim()));return{downloadUrls:e.downloadUrls,schemaDefinitionsTagName:e.schemaDefinitionsTagName,corsProxyUrl:e.corsProxyUrl&&(0,theme_1.addTrailingSlash)(e.corsProxyUrl),hideSidebar:(0,utils_1.argValueToBoolean)(e.hideSidebar,!1),jsonSampleExpandLevel:(0,utils_1.argValueToExpandLevel)(e.jsonSampleExpandLevel,2),generatedPayloadSamplesMaxDepth:(0,utils_1.argValueToInt)(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButtons:(0,utils_1.argValueToBoolean)(e.hideDownloadButtons,!1),hideInfoDescription:(0,utils_1.argValueToBoolean)(e.hideInfoDescription),hideInfoSection:(0,utils_1.argValueToBoolean)(e.hideInfoSection,!1),hideInfoMetadata:(0,utils_1.argValueToBoolean)(e.hideInfoMetadata,!1),hideLoading:(0,utils_1.argValueToBoolean)(e.hideLoading,!1),hideSchemaTitles:(0,utils_1.argValueToBoolean)(e.hideSchemaTitles,!1),maxDisplayedEnumValues:(0,utils_1.argValueToNumber)(e.maxDisplayedEnumValues),mockServer:(null===(p=e.mockServer)||void 0===p?void 0:p.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:(0,utils_1.argValueToBoolean)(e.onlyRequiredInSamples,!1),onDeepLinkClick:e.onDeepLinkClick||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:(0,theme_1.isUndefined)(e.disableRouter)?"":e.routingBasePath&&(0,utils_1.normalizePath)(e.routingBasePath)||"",schemaExpansionLevel:(0,utils_1.argValueToExpandLevel)(e.schemaExpansionLevel),feedback:e.feedback||{hide:!1},sortRequiredPropsFirst:(0,utils_1.argValueToBoolean)(e.sortRequiredPropsFirst,!1),scrollYOffset:(0,helpers_1.normalizeScrollYOffset)(e.scrollYOffset),showVendorExtensions:(0,helpers_1.normalizeShowExtensions)(e.showVendorExtensions),sanitize:(0,utils_1.argValueToBoolean)(e.sanitize,!1),skipBundle:(0,utils_1.argValueToBoolean)(e.skipBundle,!1),ignoreNamedSchemas:new Set(m),markdocOptions:null==e?void 0:e.markdocOptions,codeSamples:e.codeSamples||{languages:Object.values(constants_2.Languages).map((e=>({lang:e})))},layout:e.layout||theme_1.LayoutVariant.THREE_PANEL,sidebarLinks:e.sidebarLinks||{},events:e.events||{},unstable_hooks:e.unstable_hooks||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.HOOKS)||{},unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],infoLabel:null==e?void 0:e.infoLabel,hidePropertiesPrefix:(0,utils_1.argValueToBoolean)(null==e?void 0:e.hidePropertiesPrefix,!1)}}exports.normalizeOptions=normalizeOptions;
1
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeOptions=void 0;const theme_1=require("@redocly/theme"),constants_1=require("../../constants"),utils_1=require("../../utils"),helpers_1=require("./helpers"),constants_2=require("../code-samples/constants");function normalizeOptions(e,o){var n,i,s,a,l,t,r,d,u,c,p;e=Object.assign(Object.assign(Object.assign({},o),e),{markdocOptions:Object.assign(Object.assign({},null==e?void 0:e.markdocOptions),{components:Object.assign(Object.assign({},null===(n=null==o?void 0:o.markdocOptions)||void 0===n?void 0:n.components),null===(i=null==e?void 0:e.markdocOptions)||void 0===i?void 0:i.components),tags:Object.assign(Object.assign({},null===(s=null==o?void 0:o.markdocOptions)||void 0===s?void 0:s.tags),null===(a=null==e?void 0:e.markdocOptions)||void 0===a?void 0:a.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(l=null==o?void 0:o.markdocOptions)||void 0===l?void 0:l.nodes),null===(t=null==e?void 0:e.markdocOptions)||void 0===t?void 0:t.nodes),{heading:(null===(d=null===(r=null==o?void 0:o.markdocOptions)||void 0===r?void 0:r.nodes)||void 0===d?void 0:d.heading)||(null===(u=null==e?void 0:e.markdocOptions)||void 0===u?void 0:u.nodes.heading)})})});const m=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(c=e.ignoreNamedSchemas)||void 0===c?void 0:c.split(",").map((e=>e.trim()));return{downloadUrls:e.downloadUrls,schemaDefinitionsTagName:e.schemaDefinitionsTagName,corsProxyUrl:e.corsProxyUrl&&(0,theme_1.addTrailingSlash)(e.corsProxyUrl),hideSidebar:(0,utils_1.argValueToBoolean)(e.hideSidebar,!1),jsonSampleExpandLevel:(0,utils_1.argValueToExpandLevel)(e.jsonSampleExpandLevel,2),generatedPayloadSamplesMaxDepth:(0,utils_1.argValueToInt)(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButtons:(0,utils_1.argValueToBoolean)(e.hideDownloadButtons,!1),hideInfoDescription:(0,utils_1.argValueToBoolean)(e.hideInfoDescription),hideInfoMetadata:(0,utils_1.argValueToBoolean)(e.hideInfoMetadata,!1),hideLoading:(0,utils_1.argValueToBoolean)(e.hideLoading,!1),hideSchemaTitles:(0,utils_1.argValueToBoolean)(e.hideSchemaTitles,!1),maxDisplayedEnumValues:(0,utils_1.argValueToNumber)(e.maxDisplayedEnumValues),mockServer:(null===(p=e.mockServer)||void 0===p?void 0:p.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:(0,utils_1.argValueToBoolean)(e.onlyRequiredInSamples,!1),onDeepLinkClick:e.onDeepLinkClick||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:(0,theme_1.isUndefined)(e.disableRouter)?"":e.routingBasePath&&(0,utils_1.normalizePath)(e.routingBasePath)||"",schemaExpansionLevel:(0,utils_1.argValueToExpandLevel)(e.schemaExpansionLevel),feedback:e.feedback||{hide:!1},sortRequiredPropsFirst:(0,utils_1.argValueToBoolean)(e.sortRequiredPropsFirst,!1),scrollYOffset:(0,helpers_1.normalizeScrollYOffset)(e.scrollYOffset),showVendorExtensions:(0,helpers_1.normalizeShowExtensions)(e.showVendorExtensions),sanitize:(0,utils_1.argValueToBoolean)(e.sanitize,!1),skipBundle:(0,utils_1.argValueToBoolean)(e.skipBundle,!1),ignoreNamedSchemas:new Set(m),markdocOptions:null==e?void 0:e.markdocOptions,codeSamples:e.codeSamples||{languages:Object.values(constants_2.Languages).map((e=>({lang:e})))},layout:e.layout||theme_1.LayoutVariant.THREE_PANEL,sidebarLinks:e.sidebarLinks||{},events:e.events||{},unstable_hooks:e.unstable_hooks||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.HOOKS)||{},unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],infoLabel:null==e?void 0:e.infoLabel,hidePropertiesPrefix:(0,utils_1.argValueToBoolean)(null==e?void 0:e.hidePropertiesPrefix,!1)}}exports.normalizeOptions=normalizeOptions;
2
2
  //# sourceMappingURL=normalizeOptions.js.map
@@ -47,7 +47,6 @@ export interface RawOptions {
47
47
  unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
48
48
  schemaDefinitionsTagName?: string;
49
49
  layout?: LayoutVariant;
50
- hideInfoSection?: boolean;
51
50
  hideInfoMetadata?: boolean;
52
51
  events?: Events;
53
52
  onDeepLinkClick?: ((link: string) => void) | undefined | null;
@@ -103,7 +102,6 @@ export interface Options {
103
102
  unstable_externalCodeSamples: Unstable_ExternalCodeSample[];
104
103
  schemaDefinitionsTagName?: string;
105
104
  layout: LayoutVariant;
106
- hideInfoSection: boolean;
107
105
  hideInfoMetadata: boolean;
108
106
  events: Events;
109
107
  onDeepLinkClick: ((link: string) => void) | undefined | null;
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.buildContentItems=exports.buildMenuStructure=void 0;const tags_1=require("./tags"),markdown_1=require("./markdown"),utils_1=require("../../utils");function buildMenuStructure(t,e){var i,n,o;const{definition:u}=t,{hideInfoSection:s,hideInfoDescription:r,schemaDefinitionsTagName:d,infoLabel:l}=e,a=[{id:"",name:(null===(n=null===(i=null==u?void 0:u.info)||void 0===i?void 0:i["x-seo"])||void 0===n?void 0:n.title)||l||(null===(o=null==u?void 0:u.info)||void 0===o?void 0:o.title)||"Overview",href:"/",depth:s?-1:1,level:1,type:"section",infoDefinition:u.info,items:[]}],m=[...u.tags||[]];!m.find((t=>(null==t?void 0:t.name)===d))&&d&&m.push({name:d});const c=(0,tags_1.getTagsWithOperations)(t,m),v=u["x-tagGroups"];return s||r||a.push(...(0,markdown_1.addMarkdownItems)((0,utils_1.getValueFromMdParsedExtension)(u.info,"description")||"",void 0,1)),v&&v.length>0?a.push(...(0,tags_1.getTagGroupsItems)(t,void 0,v,c,e)):a.push(...(0,tags_1.getTagsItems)(t,c,void 0,void 0,e)),a}function buildContentItems(t,e){const i=buildMenuStructure(t,e);return{contentItems:i,flatItems:(0,utils_1.flattenByProp)(i||[],"items")}}exports.buildMenuStructure=buildMenuStructure,exports.buildContentItems=buildContentItems;
1
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.buildContentItems=exports.buildMenuStructure=void 0;const tags_1=require("./tags"),markdown_1=require("./markdown"),utils_1=require("../../utils");function buildMenuStructure(t,e){var i,n,o;const{definition:u}=t,{hideInfoDescription:s,schemaDefinitionsTagName:r,infoLabel:d}=e,l=[{id:"",name:(null===(n=null===(i=null==u?void 0:u.info)||void 0===i?void 0:i["x-seo"])||void 0===n?void 0:n.title)||d||(null===(o=null==u?void 0:u.info)||void 0===o?void 0:o.title)||"Overview",href:"/",depth:1,level:1,type:"section",infoDefinition:u.info,items:[]}],a=[...u.tags||[]];!a.find((t=>(null==t?void 0:t.name)===r))&&r&&a.push({name:r});const m=(0,tags_1.getTagsWithOperations)(t,a),v=u["x-tagGroups"];return s||l.push(...(0,markdown_1.addMarkdownItems)((0,utils_1.getValueFromMdParsedExtension)(u.info,"description")||"",void 0,1)),v&&v.length>0?l.push(...(0,tags_1.getTagGroupsItems)(t,void 0,v,m,e)):l.push(...(0,tags_1.getTagsItems)(t,m,void 0,void 0,e)),l}function buildContentItems(t,e){const i=buildMenuStructure(t,e);return{contentItems:i,flatItems:(0,utils_1.flattenByProp)(i||[],"items")}}exports.buildMenuStructure=buildMenuStructure,exports.buildContentItems=buildContentItems;
2
2
  //# sourceMappingURL=builder.js.map
@@ -1,4 +1,4 @@
1
- import{jsxs as _jsxs,jsx as _jsx}from"react/jsx-runtime";import{useAtomValue}from"jotai";import{AfterOpenApiTitle,breakpoints,LayoutVariant}from"@redocly/theme";import styled from"styled-components";import{layoutAtom}from"../../jotai/app";import{SamplesMiddlePanel,Row,SamplesPanel}from"../common";import{ExternalDocumentation}from"../ExternalDocumentation";import{Markdown}from"../Markdown";import{ApiHeader}from"./styled";import{globalStoreAtom}from"../../jotai/store";import{saveTextBeforeHeading}from"../../utils/saveTextBeforeHeading";import{getValueFromMdParsedExtension}from"../../utils/helpers";import{RenderHook}from"../RenderHook";import{Metadata}from"./Metadata";import{RightPanel}from"../RightPanel/RightPanel";export function ApiInfo({item:e}){const{options:{unstable_hooks:o,hideInfoSection:t,hideInfoDescription:a,hideInfoMetadata:i},parser:{definition:r}}=useAtomValue(globalStoreAtom),n=useAtomValue(layoutAtom),s=e.infoDefinition;if(!s||t)return null;const l=a?null:saveTextBeforeHeading(getValueFromMdParsedExtension(s,"description")||""),m=getValueFromMdParsedExtension(s,"summary")||void 0,d=null==r?void 0:r.externalDocs,p=s.version&&_jsxs("span",{children:["(",s.version,")"]})||null,u=n===LayoutVariant.STACKED;return _jsxs(Row,{layout:n,children:[_jsxs(SamplesMiddlePanel,{fullWidth:!0,className:"api-info",isStacked:u,children:[_jsxs(ApiHeader,{children:[s.title," ",p]}),_jsx(RenderHook,{Hook:AfterOpenApiTitle||(null==o?void 0:o.AfterApiTitle),props:{info:s}}),m&&_jsx(Markdown,{source:m,"data-role":"redoc-summary"}),l&&_jsx(Markdown,{source:l,"data-role":"redoc-description"}),d&&_jsx(ExternalDocumentation,{externalDocs:d}),!i&&_jsx(Metadata,{metadata:s["x-metadata"]})]}),_jsx(RightPanelContainer,{isStacked:u,children:_jsx(RightPanel,{item:e})})]})}const RightPanelContainer=styled(SamplesPanel)`
1
+ import{jsxs as _jsxs,jsx as _jsx}from"react/jsx-runtime";import{useAtomValue}from"jotai";import{AfterOpenApiTitle,breakpoints,LayoutVariant}from"@redocly/theme";import styled from"styled-components";import{layoutAtom}from"../../jotai/app";import{SamplesMiddlePanel,Row,SamplesPanel}from"../common";import{ExternalDocumentation}from"../ExternalDocumentation";import{Markdown}from"../Markdown";import{ApiHeader}from"./styled";import{globalStoreAtom}from"../../jotai/store";import{saveTextBeforeHeading}from"../../utils/saveTextBeforeHeading";import{getValueFromMdParsedExtension}from"../../utils/helpers";import{RenderHook}from"../RenderHook";import{Metadata}from"./Metadata";import{RightPanel}from"../RightPanel/RightPanel";export function ApiInfo({item:e}){const{options:{unstable_hooks:o,hideInfoDescription:t,hideInfoMetadata:a},parser:{definition:i}}=useAtomValue(globalStoreAtom),r=useAtomValue(layoutAtom),n=e.infoDefinition;if(!n)return null;const s=t?null:saveTextBeforeHeading(getValueFromMdParsedExtension(n,"description")||""),l=getValueFromMdParsedExtension(n,"summary")||void 0,m=null==i?void 0:i.externalDocs,d=n.version&&_jsxs("span",{children:["(",n.version,")"]})||null,p=r===LayoutVariant.STACKED;return _jsxs(Row,{layout:r,children:[_jsxs(SamplesMiddlePanel,{fullWidth:!0,className:"api-info",isStacked:p,children:[_jsxs(ApiHeader,{children:[n.title," ",d]}),_jsx(RenderHook,{Hook:AfterOpenApiTitle||(null==o?void 0:o.AfterApiTitle),props:{info:n}}),l&&_jsx(Markdown,{source:l,"data-role":"redoc-summary"}),s&&_jsx(Markdown,{source:s,"data-role":"redoc-description"}),m&&_jsx(ExternalDocumentation,{externalDocs:m}),!a&&_jsx(Metadata,{metadata:n["x-metadata"]})]}),_jsx(RightPanelContainer,{isStacked:p,children:_jsx(RightPanel,{item:e})})]})}const RightPanelContainer=styled(SamplesPanel)`
2
2
  position: static;
3
3
  @media screen and (min-width: ${breakpoints.medium}) {
4
4
  display: ${({isStacked:e})=>e?"block":"none"};
@@ -1,2 +1,2 @@
1
- import{LayoutVariant,isUndefined,addTrailingSlash}from"@redocly/theme";import{WindowReferenceOptions}from"../../constants";import{argValueToBoolean,argValueToExpandLevel,argValueToInt,argValueToNumber,getWindowReferenceOptions,normalizePath}from"../../utils";import{normalizeShowExtensions,normalizeScrollYOffset}from"./helpers";import{Languages}from"../code-samples/constants";export function normalizeOptions(e,o){var n,a,i,s,l,r,d,t,u,c,m;e=Object.assign(Object.assign(Object.assign({},o),e),{markdocOptions:Object.assign(Object.assign({},null==e?void 0:e.markdocOptions),{components:Object.assign(Object.assign({},null===(n=null==o?void 0:o.markdocOptions)||void 0===n?void 0:n.components),null===(a=null==e?void 0:e.markdocOptions)||void 0===a?void 0:a.components),tags:Object.assign(Object.assign({},null===(i=null==o?void 0:o.markdocOptions)||void 0===i?void 0:i.tags),null===(s=null==e?void 0:e.markdocOptions)||void 0===s?void 0:s.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(l=null==o?void 0:o.markdocOptions)||void 0===l?void 0:l.nodes),null===(r=null==e?void 0:e.markdocOptions)||void 0===r?void 0:r.nodes),{heading:(null===(t=null===(d=null==o?void 0:o.markdocOptions)||void 0===d?void 0:d.nodes)||void 0===t?void 0:t.heading)||(null===(u=null==e?void 0:e.markdocOptions)||void 0===u?void 0:u.nodes.heading)})})});const p=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(c=e.ignoreNamedSchemas)||void 0===c?void 0:c.split(",").map((e=>e.trim()));return{downloadUrls:e.downloadUrls,schemaDefinitionsTagName:e.schemaDefinitionsTagName,corsProxyUrl:e.corsProxyUrl&&addTrailingSlash(e.corsProxyUrl),hideSidebar:argValueToBoolean(e.hideSidebar,!1),jsonSampleExpandLevel:argValueToExpandLevel(e.jsonSampleExpandLevel,2),generatedPayloadSamplesMaxDepth:argValueToInt(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButtons:argValueToBoolean(e.hideDownloadButtons,!1),hideInfoDescription:argValueToBoolean(e.hideInfoDescription),hideInfoSection:argValueToBoolean(e.hideInfoSection,!1),hideInfoMetadata:argValueToBoolean(e.hideInfoMetadata,!1),hideLoading:argValueToBoolean(e.hideLoading,!1),hideSchemaTitles:argValueToBoolean(e.hideSchemaTitles,!1),maxDisplayedEnumValues:argValueToNumber(e.maxDisplayedEnumValues),mockServer:(null===(m=e.mockServer)||void 0===m?void 0:m.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:argValueToBoolean(e.onlyRequiredInSamples,!1),onDeepLinkClick:e.onDeepLinkClick||getWindowReferenceOptions(WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||getWindowReferenceOptions(WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:isUndefined(e.disableRouter)?"":e.routingBasePath&&normalizePath(e.routingBasePath)||"",schemaExpansionLevel:argValueToExpandLevel(e.schemaExpansionLevel),feedback:e.feedback||{hide:!1},sortRequiredPropsFirst:argValueToBoolean(e.sortRequiredPropsFirst,!1),scrollYOffset:normalizeScrollYOffset(e.scrollYOffset),showVendorExtensions:normalizeShowExtensions(e.showVendorExtensions),sanitize:argValueToBoolean(e.sanitize,!1),skipBundle:argValueToBoolean(e.skipBundle,!1),ignoreNamedSchemas:new Set(p),markdocOptions:null==e?void 0:e.markdocOptions,codeSamples:e.codeSamples||{languages:Object.values(Languages).map((e=>({lang:e})))},layout:e.layout||LayoutVariant.THREE_PANEL,sidebarLinks:e.sidebarLinks||{},events:e.events||{},unstable_hooks:e.unstable_hooks||getWindowReferenceOptions(WindowReferenceOptions.HOOKS)||{},unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],infoLabel:null==e?void 0:e.infoLabel,hidePropertiesPrefix:argValueToBoolean(null==e?void 0:e.hidePropertiesPrefix,!1)}}
1
+ import{LayoutVariant,isUndefined,addTrailingSlash}from"@redocly/theme";import{WindowReferenceOptions}from"../../constants";import{argValueToBoolean,argValueToExpandLevel,argValueToInt,argValueToNumber,getWindowReferenceOptions,normalizePath}from"../../utils";import{normalizeShowExtensions,normalizeScrollYOffset}from"./helpers";import{Languages}from"../code-samples/constants";export function normalizeOptions(e,o){var n,a,i,s,l,r,d,t,u,c,m;e=Object.assign(Object.assign(Object.assign({},o),e),{markdocOptions:Object.assign(Object.assign({},null==e?void 0:e.markdocOptions),{components:Object.assign(Object.assign({},null===(n=null==o?void 0:o.markdocOptions)||void 0===n?void 0:n.components),null===(a=null==e?void 0:e.markdocOptions)||void 0===a?void 0:a.components),tags:Object.assign(Object.assign({},null===(i=null==o?void 0:o.markdocOptions)||void 0===i?void 0:i.tags),null===(s=null==e?void 0:e.markdocOptions)||void 0===s?void 0:s.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(l=null==o?void 0:o.markdocOptions)||void 0===l?void 0:l.nodes),null===(r=null==e?void 0:e.markdocOptions)||void 0===r?void 0:r.nodes),{heading:(null===(t=null===(d=null==o?void 0:o.markdocOptions)||void 0===d?void 0:d.nodes)||void 0===t?void 0:t.heading)||(null===(u=null==e?void 0:e.markdocOptions)||void 0===u?void 0:u.nodes.heading)})})});const p=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(c=e.ignoreNamedSchemas)||void 0===c?void 0:c.split(",").map((e=>e.trim()));return{downloadUrls:e.downloadUrls,schemaDefinitionsTagName:e.schemaDefinitionsTagName,corsProxyUrl:e.corsProxyUrl&&addTrailingSlash(e.corsProxyUrl),hideSidebar:argValueToBoolean(e.hideSidebar,!1),jsonSampleExpandLevel:argValueToExpandLevel(e.jsonSampleExpandLevel,2),generatedPayloadSamplesMaxDepth:argValueToInt(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButtons:argValueToBoolean(e.hideDownloadButtons,!1),hideInfoDescription:argValueToBoolean(e.hideInfoDescription),hideInfoMetadata:argValueToBoolean(e.hideInfoMetadata,!1),hideLoading:argValueToBoolean(e.hideLoading,!1),hideSchemaTitles:argValueToBoolean(e.hideSchemaTitles,!1),maxDisplayedEnumValues:argValueToNumber(e.maxDisplayedEnumValues),mockServer:(null===(m=e.mockServer)||void 0===m?void 0:m.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:argValueToBoolean(e.onlyRequiredInSamples,!1),onDeepLinkClick:e.onDeepLinkClick||getWindowReferenceOptions(WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||getWindowReferenceOptions(WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:isUndefined(e.disableRouter)?"":e.routingBasePath&&normalizePath(e.routingBasePath)||"",schemaExpansionLevel:argValueToExpandLevel(e.schemaExpansionLevel),feedback:e.feedback||{hide:!1},sortRequiredPropsFirst:argValueToBoolean(e.sortRequiredPropsFirst,!1),scrollYOffset:normalizeScrollYOffset(e.scrollYOffset),showVendorExtensions:normalizeShowExtensions(e.showVendorExtensions),sanitize:argValueToBoolean(e.sanitize,!1),skipBundle:argValueToBoolean(e.skipBundle,!1),ignoreNamedSchemas:new Set(p),markdocOptions:null==e?void 0:e.markdocOptions,codeSamples:e.codeSamples||{languages:Object.values(Languages).map((e=>({lang:e})))},layout:e.layout||LayoutVariant.THREE_PANEL,sidebarLinks:e.sidebarLinks||{},events:e.events||{},unstable_hooks:e.unstable_hooks||getWindowReferenceOptions(WindowReferenceOptions.HOOKS)||{},unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],infoLabel:null==e?void 0:e.infoLabel,hidePropertiesPrefix:argValueToBoolean(null==e?void 0:e.hidePropertiesPrefix,!1)}}
2
2
  //# sourceMappingURL=normalizeOptions.js.map
@@ -47,7 +47,6 @@ export interface RawOptions {
47
47
  unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
48
48
  schemaDefinitionsTagName?: string;
49
49
  layout?: LayoutVariant;
50
- hideInfoSection?: boolean;
51
50
  hideInfoMetadata?: boolean;
52
51
  events?: Events;
53
52
  onDeepLinkClick?: ((link: string) => void) | undefined | null;
@@ -103,7 +102,6 @@ export interface Options {
103
102
  unstable_externalCodeSamples: Unstable_ExternalCodeSample[];
104
103
  schemaDefinitionsTagName?: string;
105
104
  layout: LayoutVariant;
106
- hideInfoSection: boolean;
107
105
  hideInfoMetadata: boolean;
108
106
  events: Events;
109
107
  onDeepLinkClick: ((link: string) => void) | undefined | null;
@@ -1,2 +1,2 @@
1
- import{getTagGroupsItems,getTagsItems,getTagsWithOperations}from"./tags";import{addMarkdownItems}from"./markdown";import{flattenByProp,getValueFromMdParsedExtension}from"../../utils";export function buildMenuStructure(t,e){var i,o,n;const{definition:s}=t,{hideInfoSection:r,hideInfoDescription:d,schemaDefinitionsTagName:a,infoLabel:u}=e,l=[{id:"",name:(null===(o=null===(i=null==s?void 0:s.info)||void 0===i?void 0:i["x-seo"])||void 0===o?void 0:o.title)||u||(null===(n=null==s?void 0:s.info)||void 0===n?void 0:n.title)||"Overview",href:"/",depth:r?-1:1,level:1,type:"section",infoDefinition:s.info,items:[]}],m=[...s.tags||[]];!m.find((t=>(null==t?void 0:t.name)===a))&&a&&m.push({name:a});const f=getTagsWithOperations(t,m),p=s["x-tagGroups"];return r||d||l.push(...addMarkdownItems(getValueFromMdParsedExtension(s.info,"description")||"",void 0,1)),p&&p.length>0?l.push(...getTagGroupsItems(t,void 0,p,f,e)):l.push(...getTagsItems(t,f,void 0,void 0,e)),l}export function buildContentItems(t,e){const i=buildMenuStructure(t,e);return{contentItems:i,flatItems:flattenByProp(i||[],"items")}}
1
+ import{getTagGroupsItems,getTagsItems,getTagsWithOperations}from"./tags";import{addMarkdownItems}from"./markdown";import{flattenByProp,getValueFromMdParsedExtension}from"../../utils";export function buildMenuStructure(t,e){var i,o,n;const{definition:s}=t,{hideInfoDescription:r,schemaDefinitionsTagName:d,infoLabel:a}=e,u=[{id:"",name:(null===(o=null===(i=null==s?void 0:s.info)||void 0===i?void 0:i["x-seo"])||void 0===o?void 0:o.title)||a||(null===(n=null==s?void 0:s.info)||void 0===n?void 0:n.title)||"Overview",href:"/",depth:1,level:1,type:"section",infoDefinition:s.info,items:[]}],l=[...s.tags||[]];!l.find((t=>(null==t?void 0:t.name)===d))&&d&&l.push({name:d});const m=getTagsWithOperations(t,l),f=s["x-tagGroups"];return r||u.push(...addMarkdownItems(getValueFromMdParsedExtension(s.info,"description")||"",void 0,1)),f&&f.length>0?u.push(...getTagGroupsItems(t,void 0,f,m,e)):u.push(...getTagsItems(t,m,void 0,void 0,e)),u}export function buildContentItems(t,e){const i=buildMenuStructure(t,e);return{contentItems:i,flatItems:flattenByProp(i||[],"items")}}
2
2
  //# sourceMappingURL=builder.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/openapi-docs",
3
- "version": "0.0.0-beta-20240409160536",
3
+ "version": "0.0.0-beta-20240410152801",
4
4
  "description": "Redocly OpenAPI Docs",
5
5
  "main": "lib/index.js",
6
6
  "module": "lib-esm/index.js",
@@ -16,7 +16,7 @@
16
16
  "openapi-docs": "bin.js"
17
17
  },
18
18
  "peerDependencies": {
19
- "@redocly/theme": "0.0.0-beta-20240409160536",
19
+ "@redocly/theme": "0.0.0-beta-20240410152801",
20
20
  "core-js": "^3.1.4",
21
21
  "react": "^18.0.0",
22
22
  "react-dom": "^18.0.0",
@@ -24,7 +24,7 @@
24
24
  },
25
25
  "dependencies": {
26
26
  "@markdoc/markdoc": "0.4.0",
27
- "@redocly/openapi-core": "1.10.4",
27
+ "@redocly/openapi-core": "1.11.0",
28
28
  "deepmerge": "^4.2.2",
29
29
  "dompurify": "^2.0.12",
30
30
  "fast-deep-equal": "^3.1.3",
@@ -45,7 +45,7 @@
45
45
  "url-template": "^2.0.8",
46
46
  "util": "~0.12.5",
47
47
  "js-yaml": "4.1.0",
48
- "@redocly/replay": "0.0.0-beta-20240409160536"
48
+ "@redocly/replay": "0.0.0-beta-20240410152801"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@cfaester/enzyme-adapter-react-18": "0.7.1",
@@ -94,7 +94,7 @@
94
94
  "webpack": "5.88.2",
95
95
  "webpack-cli": "5.1.4",
96
96
  "webpack-dev-server": "4.15.1",
97
- "@redocly/theme": "0.0.0-beta-20240409160536"
97
+ "@redocly/theme": "0.0.0-beta-20240410152801"
98
98
  },
99
99
  "scripts": {
100
100
  "start": "webpack serve --mode=development --hot",