@redocly/openapi-docs 0.0.0-beta-20240222165103 → 0.0.0-beta-20240223133421
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 +215 -189
- package/lib/components/RequestParameters/Body.d.ts +1 -1
- package/lib/components/RequestParameters/Body.js +1 -1
- package/lib/components/RequestParameters/ParametersGroup.d.ts +1 -1
- package/lib/components/RequestParameters/ParametersGroup.js +1 -1
- package/lib/components/RequestParameters/RequestParameters.js +1 -1
- package/lib/components/Responses/ResponseDetails.js +1 -1
- package/lib/components/Responses/ResponseHeaders.js +1 -1
- package/lib/components/Responses/styled.js +1 -0
- package/lib/components/Responses/types.d.ts +1 -0
- package/lib/components/Samples/ExampleSwitch.js +1 -1
- package/lib/components/Security/OAuthFlow.js +1 -1
- package/lib/components/common/BodyContent/BodyContent.d.ts +1 -1
- package/lib/components/common/BodyContent/BodyContent.js +1 -1
- package/lib/components/common/LinkToField.js +1 -1
- package/lib/components/pluggable/RedocRequestBody.js +1 -1
- package/lib/services/history/helpers.js +1 -1
- package/lib/services/search/SearchStore.js +78 -53
- package/lib-esm/components/RequestParameters/Body.d.ts +1 -1
- package/lib-esm/components/RequestParameters/Body.js +1 -1
- package/lib-esm/components/RequestParameters/ParametersGroup.d.ts +1 -1
- package/lib-esm/components/RequestParameters/ParametersGroup.js +1 -1
- package/lib-esm/components/RequestParameters/RequestParameters.js +1 -1
- package/lib-esm/components/Responses/ResponseDetails.js +1 -1
- package/lib-esm/components/Responses/ResponseHeaders.js +1 -1
- package/lib-esm/components/Responses/styled.js +1 -0
- package/lib-esm/components/Responses/types.d.ts +1 -0
- package/lib-esm/components/Samples/ExampleSwitch.js +1 -1
- package/lib-esm/components/Security/OAuthFlow.js +1 -1
- package/lib-esm/components/common/BodyContent/BodyContent.d.ts +1 -1
- package/lib-esm/components/common/BodyContent/BodyContent.js +1 -1
- package/lib-esm/components/common/LinkToField.js +1 -1
- package/lib-esm/components/pluggable/RedocRequestBody.js +1 -1
- package/lib-esm/services/history/helpers.js +1 -1
- package/lib-esm/services/search/SearchStore.js +78 -53
- package/package.json +4 -4
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React,{memo}from"react";import{BodyContent}from"../common/BodyContent";function BodyComponent({content:e,description:o,required:t,
|
|
1
|
+
import React,{memo}from"react";import{BodyContent}from"../common/BodyContent";function BodyComponent({content:e,description:o,required:t,deepLink:n}){return React.createElement(BodyContent,{content:e,required:t,description:o,skipReadOnly:e.isRequestType,skipWriteOnly:!e.isRequestType,deepLink:n})}export const Body=memo(BodyComponent);
|
|
2
2
|
//# sourceMappingURL=Body.js.map
|
|
@@ -3,7 +3,7 @@ import type { FieldModel } from '../../models';
|
|
|
3
3
|
interface ParametersGroupProps {
|
|
4
4
|
title: string;
|
|
5
5
|
parameters: FieldModel[];
|
|
6
|
-
|
|
6
|
+
deepLink: string;
|
|
7
7
|
}
|
|
8
8
|
export declare const ParametersGroup: React.NamedExoticComponent<ParametersGroupProps>;
|
|
9
9
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import React,{memo}from"react";import styled from"styled-components";import{LinkIcon}from"@redocly/theme";import{PropertyDetails}from"../PropertyDetails";import{LinkToField}from"../common/LinkToField";
|
|
1
|
+
import React,{memo}from"react";import styled from"styled-components";import{LinkIcon}from"@redocly/theme";import{PropertyDetails}from"../PropertyDetails";import{LinkToField}from"../common/LinkToField";function ParametersGroupComponent({title:e,parameters:t,deepLink:r}){return t&&t.length?React.createElement(Wrapper,null,React.createElement(Title,null,React.createElement(LinkToField,{to:r}),e),t.map(((e,t)=>React.createElement(PropertyDetails,{key:e.name,isFirst:0===t,field:e,showExamples:!0})))):null}export const ParametersGroup=memo(ParametersGroupComponent);const Title=styled.span`
|
|
2
2
|
position: relative;
|
|
3
3
|
display: flex;
|
|
4
4
|
align-items: center;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React from"react";import{ParametersGroup}from"./ParametersGroup";import{Body}from"./Body";const PARAM_PLACES=["path","query","cookie","header"],PARAM_NAMES_MAP={[PARAM_PLACES[0]]:"Path",[PARAM_PLACES[1]]:"Query",[PARAM_PLACES[2]]:"Cookies",[PARAM_PLACES[3]]:"Headers"};export function RequestParameters({body:e,parameters:r=[],operationId:t}){if(!e&&!r.length)return null;const
|
|
1
|
+
import React from"react";import{ParametersGroup}from"./ParametersGroup";import{Body}from"./Body";import{makeDeepLink}from"../../services";const PARAM_PLACES=["path","query","cookie","header"],PARAM_NAMES_MAP={[PARAM_PLACES[0]]:"Path",[PARAM_PLACES[1]]:"Query",[PARAM_PLACES[2]]:"Cookies",[PARAM_PLACES[3]]:"Headers"};export function RequestParameters({body:e,parameters:r=[],operationId:t}){if(!e&&!r.length)return null;const a=(e=>{const r={};return e.forEach((e=>{safePush(r,e.in,e)})),r})(r),o=r.length>0?PARAM_PLACES:[],{content:n,description:A,required:i}=e||{};return React.createElement(React.Fragment,null,o.map((e=>React.createElement(ParametersGroup,{key:e,title:PARAM_NAMES_MAP[e],parameters:a[e],deepLink:makeDeepLink(t,`request/${e}`)}))),n&&React.createElement(Body,{content:n,description:A,required:i,deepLink:makeDeepLink(t,"request/body")}))}function safePush(e,r="",t){e[r]||(e[r]=[]),e[r].push(t)}
|
|
2
2
|
//# sourceMappingURL=RequestParameters.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React,{memo}from"react";import{ResponseHeaders}from"./ResponseHeaders";import{StyledDescription}from"./styled";import{BodyContent}from"../common/BodyContent";function ResponseDetailsComponent({response:e,operationId:t}){const{description:o,headers:n,content:
|
|
1
|
+
import React,{memo}from"react";import{ResponseHeaders}from"./ResponseHeaders";import{StyledDescription}from"./styled";import{BodyContent}from"../common/BodyContent";import{makeDeepLink}from"../../services";function ResponseDetailsComponent({response:e,operationId:t}){const{description:o,headers:n,content:s,summary:r}=e;return React.createElement(React.Fragment,null,React.createElement(StyledDescription,{className:"redoc-markdown",source:r}),React.createElement(StyledDescription,{className:"redoc-markdown",source:o}),React.createElement(ResponseHeaders,{headers:n,deepLink:makeDeepLink(t,"response/headers")}),React.createElement(BodyContent,{content:s,skipWriteOnly:!0,deepLink:makeDeepLink(t,"response/body")}))}export const ResponseDetails=memo(ResponseDetailsComponent);
|
|
2
2
|
//# sourceMappingURL=ResponseDetails.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React,{memo}from"react";import{HeadersCaption,StyledHeadersProperties}from"./styled";import{PropertyDetails}from"../PropertyDetails";function ResponseHeadersComponent({headers:e}){return void 0===e||0===e.length?null:React.createElement(StyledHeadersProperties,null,React.createElement(HeadersCaption,null,"Headers"),e.map(((e,t)=>React.createElement(PropertyDetails,{key:e.name,isFirst:0===t,field:e,showExamples:!0}))))}export const ResponseHeaders=memo(ResponseHeadersComponent);
|
|
1
|
+
import React,{memo}from"react";import{HeadersCaption,StyledHeadersProperties}from"./styled";import{PropertyDetails}from"../PropertyDetails";import{LinkToField}from"../common/LinkToField";function ResponseHeadersComponent({headers:e,deepLink:t}){return void 0===e||0===e.length?null:React.createElement(StyledHeadersProperties,null,React.createElement(HeadersCaption,null,React.createElement(LinkToField,{to:t}),"Headers"),e.map(((e,t)=>React.createElement(PropertyDetails,{key:e.name,isFirst:0===t,field:e,showExamples:!0}))))}export const ResponseHeaders=memo(ResponseHeadersComponent);
|
|
2
2
|
//# sourceMappingURL=ResponseHeaders.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React,{useState,useEffect}from"react";import{WarnMessage}from"../shared";import{FormControl,Dropdown}from"../common";export const ExampleSwitch=({exampleKey:e,examples:
|
|
1
|
+
import React,{useState,useEffect}from"react";import{WarnMessage,MimeLabel}from"../shared";import{FormControl,Dropdown}from"../common";import{DropdownOrLabel}from"../DropdownOrLabel/DropdownOrLabel";export const ExampleSwitch=({exampleKey:e,examples:a,onChange:o})=>{var t,r;const n=Object.keys(a),l=e?n.indexOf(e):0,[m,d]=useState(l>-1?l:0);useEffect((()=>d(l>-1?l:0)),[e,l]);const c=n.map(((e,o)=>({value:a[e].summary||e,idx:o})));return React.createElement(React.Fragment,null,"default"!==(null===(t=c[m])||void 0===t?void 0:t.value)&&React.createElement(FormControl,{"data-cy":"example-switch"},React.createElement(DropdownOrLabel,{Dropdown:Dropdown,Label:MimeLabel,variant:"dark",fullWidth:!0,options:c,value:null===(r=c[m])||void 0===r?void 0:r.value,onChange:({idx:e})=>{d(e),o(n[e])}})),e&&-1===l&&React.createElement(WarnMessage,null,"Provided sample not found"))};
|
|
2
2
|
//# sourceMappingURL=ExampleSwitch.js.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import React,{memo}from"react";import styled from"styled-components";import{Markdown}from"../Markdown";import{SecuritySchemeItem}from"./SecuritySchemeItem";import{StyledLink,Tag}from"./styled";function OAuthFlowComponent({flow:e}){const t=Object.keys((null==e?void 0:e.scopes)||{});return React.createElement(React.Fragment,null,React.createElement(SecuritySchemeItem,{label:"Authorization URL:",value:(null==e?void 0:e.authorizationUrl)&&React.createElement(StyledLink,{target:"_blank",rel:"noopener noreferrer",href:null==e?void 0:e.authorizationUrl},null==e?void 0:e.authorizationUrl)}),React.createElement(SecuritySchemeItem,{label:"Token URL:",value:null==e?void 0:e.tokenUrl}),React.createElement(SecuritySchemeItem,{label:"Refresh URL:",value:null==e?void 0:e.refreshUrl}),t.length&&React.createElement(React.Fragment,null,React.createElement(SecuritySchemeItem,{label:"Scopes",value:" "}),t.map((t=>React.createElement(SecuritySchemeItem,{key:t,label:React.createElement(StyledTag,{className:"tag-grey"},t),value:React.createElement(Markdown,{source:(null==e?void 0:e.scopes[t])||""})})))))}const StyledTag=styled(Tag)`
|
|
1
|
+
import React,{memo}from"react";import styled from"styled-components";import{Markdown}from"../Markdown";import{SecuritySchemeItem}from"./SecuritySchemeItem";import{StyledLink,Tag}from"./styled";function OAuthFlowComponent({flow:e}){const t=Object.keys((null==e?void 0:e.scopes)||{});return React.createElement(React.Fragment,null,React.createElement(SecuritySchemeItem,{label:"Authorization URL:",value:(null==e?void 0:e.authorizationUrl)&&React.createElement(StyledLink,{target:"_blank",rel:"noopener noreferrer",href:null==e?void 0:e.authorizationUrl},null==e?void 0:e.authorizationUrl)}),React.createElement(SecuritySchemeItem,{label:"Token URL:",value:null==e?void 0:e.tokenUrl}),React.createElement(SecuritySchemeItem,{label:"Refresh URL:",value:null==e?void 0:e.refreshUrl}),t.length&&React.createElement(React.Fragment,null,React.createElement(SecuritySchemeItem,{label:"Scopes",value:" "}),t.map((t=>React.createElement(SecuritySchemeItem,{key:t,label:React.createElement(StyledTag,{className:"tag-grey"},t),value:React.createElement(Markdown,{source:(null==e?void 0:e.scopes[t])||""})}))))||null)}const StyledTag=styled(Tag)`
|
|
2
2
|
margin-left: var(--spacing-xs);
|
|
3
3
|
`;export const OAuthFlow=memo(OAuthFlowComponent);
|
|
4
4
|
//# sourceMappingURL=OAuthFlow.js.map
|
|
@@ -6,7 +6,7 @@ interface BodyContentProps {
|
|
|
6
6
|
required?: boolean;
|
|
7
7
|
description?: string | GenericObject;
|
|
8
8
|
content?: MediaContentModel;
|
|
9
|
-
|
|
9
|
+
deepLink: string;
|
|
10
10
|
}
|
|
11
11
|
export declare const BodyContent: React.NamedExoticComponent<BodyContentProps>;
|
|
12
12
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import React,{memo}from"react";import styled from"styled-components";import{useAtom}from"jotai";import{LinkIcon}from"@redocly/theme";import{Dropdown}from"../DropdownTheme";import{RequiredLabel}from"../Fields";import{ConstraintsView}from"../ConstraintsView";import{Schema}from"../../Schema";import{getActiveMediaType}from"../../../models";import{Markdown}from"../../Markdown";import{activeMimeNameAtom}from"../../../jotai/app";import{LinkToField}from"../LinkToField";
|
|
1
|
+
import React,{memo}from"react";import styled from"styled-components";import{useAtom}from"jotai";import{LinkIcon}from"@redocly/theme";import{Dropdown}from"../DropdownTheme";import{RequiredLabel}from"../Fields";import{ConstraintsView}from"../ConstraintsView";import{Schema}from"../../Schema";import{getActiveMediaType}from"../../../models";import{Markdown}from"../../Markdown";import{activeMimeNameAtom}from"../../../jotai/app";import{LinkToField}from"../LinkToField";function BodyContentComponent({required:e,skipReadOnly:t,skipWriteOnly:o,description:n,content:i,deepLink:r}){const[a,m]=useAtom(activeMimeNameAtom);if(!i)return null;const{schema:l,examples:c,operation:s,name:p}=getActiveMediaType(i,a);return React.createElement(React.Fragment,null,React.createElement(Title,null,React.createElement(LinkToField,{to:r}),"Body",React.createElement(Dropdown,{options:i.mediaTypes.map((({name:e})=>({label:e,value:e}))),value:p,onChange:({value:e})=>m(e)})),e&&React.createElement(RequiredLabel,null,"required"),React.createElement(StyledMarkdown,{source:n}),"object"===(null==l?void 0:l.type)&&(null==l?void 0:l.constraints)&&React.createElement(ConstraintsView,{constraints:(null==l?void 0:l.constraints)||[]}),React.createElement(Schema,{skipReadOnly:t,skipWriteOnly:o,key:"schema",schema:l,examples:c,operation:s}))}export const BodyContent=memo(BodyContentComponent);const StyledMarkdown=styled(Markdown)`
|
|
2
2
|
margin: var(--spacing-xxs) 0 0;
|
|
3
3
|
`,Title=styled.span`
|
|
4
4
|
position: relative;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import styled,{css}from"styled-components";import React from"react";import{useLocation}from"react-router-dom";import{LinkIcon}from"@redocly/theme";import{joinWithSeparator}from"../../services";import{constructFieldDeepFragment}from"../../services/history/helpers";import{
|
|
1
|
+
import styled,{css}from"styled-components";import React from"react";import{useLocation}from"react-router-dom";import{LinkIcon}from"@redocly/theme";import{joinWithSeparator}from"../../services";import{constructFieldDeepFragment}from"../../services/history/helpers";import{ShareLink}from"./linkify";export function generateDeepLink(i){const e=i.deps.operation,o=constructFieldDeepFragment(i);return(null==e?void 0:e.id)||e.isCallback?joinWithSeparator(e.href,joinWithSeparator(e.id,o),"#"):"#"+o}export const LinkToField=({to:i,className:e})=>{const o=i,t=useLocation(),r=null==o?void 0:o.split("#")[1],n=!!t&&t.hash===`#${r}`;return React.createElement(ShareLinkToField,{ariaLabel:`link to ${o}`,className:e,isActive:n,to:o,id:r})};export const ShareLinkToField=styled(ShareLink)`
|
|
2
2
|
display: flex;
|
|
3
3
|
${LinkIcon} {
|
|
4
4
|
visibility: hidden;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React from"react";import{useAtomValue}from"jotai";import{getRequestBody,getOperation}from"../../models";import{Row,SamplesMiddlePanel,SamplesPanel}from"../common";import{SamplesWrap,FullWidthPanel}from"./styled.components";import{PayloadSamples}from"../PayloadSamples";import{globalStoreAtom}from"../../jotai/store";import{layoutAtom}from"../../jotai/app";import{Body}from"../RequestParameters";export const RedocRequestBody=({pointer:e,hideSamples:t})=>{const{options:o,parser:a}=useAtomValue(globalStoreAtom),r=useAtomValue(layoutAtom),
|
|
1
|
+
import React from"react";import{useAtomValue}from"jotai";import{getRequestBody,getOperation}from"../../models";import{Row,SamplesMiddlePanel,SamplesPanel}from"../common";import{SamplesWrap,FullWidthPanel}from"./styled.components";import{PayloadSamples}from"../PayloadSamples";import{globalStoreAtom}from"../../jotai/store";import{layoutAtom}from"../../jotai/app";import{Body}from"../RequestParameters";import{makeDeepLink}from"../../services";export const RedocRequestBody=({pointer:e,hideSamples:t})=>{const{options:o,parser:a}=useAtomValue(globalStoreAtom),r=useAtomValue(layoutAtom),m=getOperation(a,{pointer:e,pathName:"",httpVerb:"",pathParameters:[],pathServers:[],isWebhook:!1,responses:{}},void 0,o,""),{content:l,description:p,required:n}=getRequestBody({parser:a,infoOrRef:{$ref:e},options:o,operation:m})||{},s=t?FullWidthPanel:SamplesMiddlePanel;return React.createElement(Row,{layout:r},React.createElement(s,null,l&&React.createElement(Body,{content:l,description:p,required:n,deepLink:makeDeepLink(m.id,"request/body")})),!t&&React.createElement(SamplesPanel,null,React.createElement(SamplesWrap,null,l&&React.createElement(PayloadSamples,{content:l})))||React.createElement("span",null))};
|
|
2
2
|
//# sourceMappingURL=RedocRequestBody.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{queryString}from"../../utils";import{getActiveMediaType}from"../../models/mediaContent";export function isSameHash(e,o){return e===o||"#"+e===o||e==="#"+o}function getContentTypeName(e){var o,t,n,i,d,r,s,p,l,v,a,u,c;if(!e.in)return"request"===e.deps.type&&(null===(n=null===(t=null===(o=e.deps.operation)||void 0===o?void 0:o.requestBody)||void 0===t?void 0:t.content)||void 0===n?void 0:n.mediaTypes)?(null===(r=null===(d=null===(i=e.deps.operation)||void 0===i?void 0:i.requestBody)||void 0===d?void 0:d.content)||void 0===r?void 0:r.mediaTypes.length)>1?(null===(p=null===(s=e.deps.operation)||void 0===s?void 0:s.requestBody)||void 0===p?void 0:p.content)&&getActiveMediaType(e.deps.operation.requestBody.content).name:void 0:"response"===e.deps.type&&(null===(v=null===(l=e.deps.response)||void 0===l?void 0:l.content)||void 0===v?void 0:v.mediaTypes)&&(null===(u=null===(a=e.deps.response)||void 0===a?void 0:a.content)||void 0===u?void 0:u.mediaTypes.length)>1?(null===(c=e.deps.response)||void 0===c?void 0:c.content)&&getActiveMediaType(e.deps.response.content).name:void 0}export function constructFieldDeepFragment(e){var o,t;if(!e)return"";const n={t:e.deps.type,in:e.in||e.deps.in,c:"response"===e.deps.type?null===(o=e.deps.response)||void 0===o?void 0:o.code:void 0,cb:(null===(t=e.deps.operation)||void 0===t?void 0:t.isCallback)?e.deps.operation.callbackId:void 0,ct:getContentTypeName(e),path:e.fieldFullPath};return queryString.stringify(n,{encode:!1,sort:!1})}export function joinWithSeparator(e="",o="",t="/"){return e.endsWith(t)&&(e=e.slice(0,-t.length)),o.startsWith(t)&&(o=o.slice(t.length)),e&&o?e+t+o:e+o}export function makeDeepLink(e,o){return(e
|
|
1
|
+
import{queryString}from"../../utils";import{getActiveMediaType}from"../../models/mediaContent";export function isSameHash(e,o){return e===o||"#"+e===o||e==="#"+o}function getContentTypeName(e){var o,t,n,i,d,r,s,p,l,v,a,u,c;if(!e.in)return"request"===e.deps.type&&(null===(n=null===(t=null===(o=e.deps.operation)||void 0===o?void 0:o.requestBody)||void 0===t?void 0:t.content)||void 0===n?void 0:n.mediaTypes)?(null===(r=null===(d=null===(i=e.deps.operation)||void 0===i?void 0:i.requestBody)||void 0===d?void 0:d.content)||void 0===r?void 0:r.mediaTypes.length)>1?(null===(p=null===(s=e.deps.operation)||void 0===s?void 0:s.requestBody)||void 0===p?void 0:p.content)&&getActiveMediaType(e.deps.operation.requestBody.content).name:void 0:"response"===e.deps.type&&(null===(v=null===(l=e.deps.response)||void 0===l?void 0:l.content)||void 0===v?void 0:v.mediaTypes)&&(null===(u=null===(a=e.deps.response)||void 0===a?void 0:a.content)||void 0===u?void 0:u.mediaTypes.length)>1?(null===(c=e.deps.response)||void 0===c?void 0:c.content)&&getActiveMediaType(e.deps.response.content).name:void 0}export function constructFieldDeepFragment(e){var o,t;if(!e)return"";const n={t:e.deps.type,in:e.in||e.deps.in,c:"response"===e.deps.type?null===(o=e.deps.response)||void 0===o?void 0:o.code:void 0,cb:(null===(t=e.deps.operation)||void 0===t?void 0:t.isCallback)?e.deps.operation.callbackId:void 0,ct:getContentTypeName(e),path:e.fieldFullPath};return queryString.stringify(n,{encode:!1,sort:!1})}export function joinWithSeparator(e="",o="",t="/"){return e.endsWith(t)&&(e=e.slice(0,-t.length)),o.startsWith(t)&&(o=o.slice(t.length)),e&&o?e+t+o:e+o}export function makeDeepLink(e,o){return(`/${e}#`+joinWithSeparator(e,o)).toLowerCase()}
|
|
2
2
|
//# sourceMappingURL=helpers.js.map
|