@redocly/openapi-docs 0.0.0-beta-20240423152253 → 0.0.0-cache-perf-20240625144418
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 +2304 -2111
- package/lib/components/ExpandAllButton/ExpandAllButton.js +1 -1
- package/lib/components/PropertyDetails/PropertyDetails.js +1 -1
- package/lib/components/PropertyDetails/styled.d.ts +5 -0
- package/lib/components/PropertyDetails/types.d.ts +1 -0
- 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/Replay/utils.js +1 -1
- package/lib/components/Request/RequestDetails.js +3 -1
- package/lib/components/RequestSamples/RequestSamples.js +1 -1
- package/lib/components/Schema/ObjectSchema.js +1 -1
- package/lib/components/Schema/OneOfSchema.js +1 -1
- package/lib/components/Schema/Schema.js +1 -1
- package/lib/components/Schema/types.d.ts +2 -0
- package/lib/components/Schema/useOneOfLocationIdx.d.ts +2 -0
- package/lib/components/Schema/useOneOfLocationIdx.js +2 -0
- package/lib/components/SectionContent/SectionContent.js +2 -11
- package/lib/components/ServerListDropdown/styled.d.ts +1 -11
- package/lib/components/SideMenu/hooks/useMenuItems.js +1 -1
- package/lib/components/common/panels.js +3 -3
- package/lib/components/common/schema.d.ts +2 -5
- 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 +2 -1
- package/lib/services/code-samples/generator.js +1 -1
- package/lib/services/code-samples/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/normalizeOptions.js +1 -1
- package/lib/services/config-options/types.d.ts +1 -47
- package/lib/services/menu/operation.js +1 -1
- package/lib/standalone.d.ts +2 -2
- package/lib/types/open-api.d.ts +1 -1
- package/lib/utils/openapi.d.ts +1 -0
- package/lib/utils/openapi.js +1 -1
- package/lib/utils/security-details.js +1 -1
- package/lib-esm/components/ExpandAllButton/ExpandAllButton.js +1 -1
- package/lib-esm/components/PropertyDetails/PropertyDetails.js +1 -1
- package/lib-esm/components/PropertyDetails/styled.d.ts +5 -0
- package/lib-esm/components/PropertyDetails/types.d.ts +1 -0
- 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/Replay/utils.js +1 -1
- package/lib-esm/components/Request/RequestDetails.js +3 -1
- package/lib-esm/components/RequestSamples/RequestSamples.js +1 -1
- package/lib-esm/components/Schema/ObjectSchema.js +1 -1
- package/lib-esm/components/Schema/OneOfSchema.js +1 -1
- package/lib-esm/components/Schema/Schema.js +1 -1
- package/lib-esm/components/Schema/types.d.ts +2 -0
- package/lib-esm/components/Schema/useOneOfLocationIdx.d.ts +2 -0
- package/lib-esm/components/Schema/useOneOfLocationIdx.js +2 -0
- package/lib-esm/components/SectionContent/SectionContent.js +2 -11
- package/lib-esm/components/ServerListDropdown/styled.d.ts +1 -11
- package/lib-esm/components/SideMenu/hooks/useMenuItems.js +1 -1
- package/lib-esm/components/common/panels.js +3 -3
- package/lib-esm/components/common/schema.d.ts +2 -5
- 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 +2 -1
- package/lib-esm/services/code-samples/generator.js +1 -1
- package/lib-esm/services/code-samples/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/normalizeOptions.js +1 -1
- package/lib-esm/services/config-options/types.d.ts +1 -47
- package/lib-esm/services/menu/operation.js +1 -1
- package/lib-esm/standalone.d.ts +2 -2
- package/lib-esm/types/open-api.d.ts +1 -1
- package/lib-esm/utils/openapi.d.ts +1 -0
- package/lib-esm/utils/openapi.js +1 -1
- package/lib-esm/utils/security-details.js +1 -1
- package/package.json +14 -13
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{jsx as _jsx,Fragment as _Fragment,jsxs as _jsxs}from"react/jsx-runtime";import{memo}from"react";import{useAtomValue}from"jotai";import{PropertiesTableCaption}from"../common";import{Discriminator}from"../Discriminator";import{globalOptionsAtom}from"../../jotai/store";import{PropertyDetails}from"../PropertyDetails";import{SubSchema}from"./SubSchema";import{getExpandByDefault}from"./helpers";function ObjectSchemaComponent({schema:e,showTitle:i,discriminator:t,level:r,skipWriteOnly:a,skipReadOnly:o,fieldParentsName:n,expandable:m,deepLink:s,required:l,disableDeepLinks:p}){const{fields:
|
|
1
|
+
import{jsx as _jsx,Fragment as _Fragment,jsxs as _jsxs}from"react/jsx-runtime";import{memo}from"react";import{useAtomValue}from"jotai";import{PropertiesTableCaption}from"../common";import{Discriminator}from"../Discriminator";import{globalOptionsAtom}from"../../jotai/store";import{PropertyDetails}from"../PropertyDetails";import{SubSchema}from"./SubSchema";import{getExpandByDefault}from"./helpers";function ObjectSchemaComponent({schema:e,showTitle:i,discriminator:t,level:r,skipWriteOnly:a,skipReadOnly:o,fieldParentsName:n,expandable:m,deepLink:s,required:l,disableDeepLinks:p,oneOfLevel:c}){const{fields:d=[],title:h}=e,{schemasExpansionLevel:f}=useAtomValue(globalOptionsAtom),x=o||a?d.filter((e=>!(o&&e.schema.readOnly||a&&e.schema.writeOnly))):d,u=getExpandByDefault({required:l,level:r,schemasExpansionLevel:f});return _jsx(SubSchema,{expandable:m,expandByDefault:u,level:r,propertyLength:x.length,deepLink:s,operationPointer:e.operationPointer,children:_jsxs(_Fragment,{children:[i&&_jsx(PropertiesTableCaption,{children:h}),x.map(((e,m)=>_jsx(PropertyDetails,{isFirst:0===m,field:e,fieldParentsName:Number(r)>1?n:[],renderDiscriminatorSwitch:(null==t?void 0:t.fieldName)===e.name&&(null==t?void 0:t.parentSchema)?()=>_jsx(Discriminator,{parent:t.parentSchema,onChange:null==t?void 0:t.onChange,activeOneOfIdx:t.activeOneOfIdx}):void 0,skipReadOnly:o,skipWriteOnly:a,showTitle:i,level:r,disableDeepLinks:p,oneOfLevel:c},e.name)))]})})}export const ObjectSchema=memo(ObjectSchemaComponent);
|
|
2
2
|
//# sourceMappingURL=ObjectSchema.js.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
var __rest=this&&this.__rest||function(e,t){var o={};for(var
|
|
1
|
+
var __rest=this&&this.__rest||function(e,t){var o={};for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var r=0;for(n=Object.getOwnPropertySymbols(e);r<n.length;r++)t.indexOf(n[r])<0&&Object.prototype.propertyIsEnumerable.call(e,n[r])&&(o[n[r]]=e[n[r]])}return o};import{jsxs as _jsxs,jsx as _jsx}from"react/jsx-runtime";import{memo}from"react";import{useAtom}from"jotai";import styled from"styled-components";import{BadgeStyle,SelectionTitle}from"../common";import{Markdown}from"../Markdown";import{ConstraintsView}from"../common/ConstraintsView";import{Schema}from"./Schema";import{operationStore}from"../../jotai/operation";import{SchemaSelection}from"../common/SchemaSelection";import{useOneOfLocationIdx}from"./useOneOfLocationIdx";function OneOfSchemaComponent(e){var{schema:{oneOf:t},schema:o,oneOfLevel:n=1}=e,r=__rest(e,["schema","schema","oneOfLevel"]);const[i]=useAtom(operationStore(o.operationPointer)),s=useOneOfLocationIdx(t,n),a=-1===s?0:s,c=t[void 0!==i.activeOneOf[o.pointer]?i.activeOneOf[o.pointer]:a];if(!c)return null;const m=t.map(((e,t)=>({label:e.title||e.typePrefix+e.displayType,value:t})));return _jsxs(Wrapper,{children:[_jsxs(SelectionTitle,{children:[o.oneOfType,":"]}),_jsx(SchemaSelection,{options:m,pointer:o.operationPointer,schema:o,defaultOneOfIdx:a}),c.deprecated&&_jsx(BadgeStyle,{deprecated:!0,children:"Deprecated"}),c.description&&_jsx(StyledDescription,{source:c.description}),_jsx(ConstraintsView,{constraints:c.constraints}),_jsx(Schema,Object.assign({},r,{schema:c,oneOfLevel:n+1}))]})}export const OneOfSchema=memo(OneOfSchemaComponent);const StyledDescription=styled(Markdown)`
|
|
2
2
|
margin-top: var(--spacing-xs);
|
|
3
3
|
font-size: var(--font-size-base);
|
|
4
4
|
line-height: var(--line-height-base);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
var __rest=this&&this.__rest||function(e,r){var t={};for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&r.indexOf(o)<0&&(t[o]=e[o]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var i=0;for(o=Object.getOwnPropertySymbols(e);i<o.length;i++)r.indexOf(o[i])<0&&Object.prototype.propertyIsEnumerable.call(e,o[i])&&(t[o[i]]=e[o[i]])}return t};import{jsx as _jsx}from"react/jsx-runtime";import{memo}from"react";import{useAtomValue}from"jotai";import{useLocation}from"react-router-dom";import styled from"styled-components";import{ArraySchema}from"./ArraySchema";import{ObjectSchema}from"./ObjectSchema";import{OneOfSchema}from"./OneOfSchema";import{RecursiveSchema}from"./RecursiveSchema";import{operationStore}from"../../jotai/operation";import{FieldDetails}from"../PropertyDetails";import{pathIncludesLink}from"../../utils";function SchemaComponent(e){var r,{schema:t,onDiscriminatorChange:o}=e,i=__rest(e,["schema","onDiscriminatorChange"]);const{activeOneOf:n}=useAtomValue(operationStore(null==t?void 0:t.operationPointer)),a=useLocation();if(!t)return null;const{type:s,oneOf:c,discriminatorProp:m,isCircular:l}=t;if(l)return _jsx(RecursiveSchema,{schema:t});if(void 0!==m){if(!c||!c.length)return console.warn(`Looks like you are using discriminator wrong: you don't have any definition inherited from the ${t.title}`),null;const e=c.findIndex(((e,r)=>pathIncludesLink(a,`d=${r}`))),r=-1===e?0:e,s=c[void 0!==n[t.pointer]?n[t.pointer]:r];return(null==s?void 0:s.isCircular)?_jsx(RecursiveSchema,{schema:s}):_jsx(ObjectSchema,Object.assign({},i,{schema:s,discriminator:{fieldName:m,parentSchema:t,activeOneOfIdx:r,onChange:o}}))}if(void 0!==c)return _jsx(OneOfSchema,Object.assign({},i,{schema:t}));const p=Array.isArray(s)?s:[s];if(p.includes("object")){if(null===(r=t.fields)||void 0===r?void 0:r.length)return _jsx(ObjectSchema,Object.assign({},i,{schema:t}))}else if(p.includes("array"))return _jsx(ArraySchema,Object.assign({},i,{schema:t}));
|
|
1
|
+
var __rest=this&&this.__rest||function(e,r){var t={};for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&r.indexOf(o)<0&&(t[o]=e[o]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var i=0;for(o=Object.getOwnPropertySymbols(e);i<o.length;i++)r.indexOf(o[i])<0&&Object.prototype.propertyIsEnumerable.call(e,o[i])&&(t[o[i]]=e[o[i]])}return t};import{jsx as _jsx}from"react/jsx-runtime";import{memo}from"react";import{useAtomValue}from"jotai";import{useLocation}from"react-router-dom";import styled from"styled-components";import{ArraySchema}from"./ArraySchema";import{ObjectSchema}from"./ObjectSchema";import{OneOfSchema}from"./OneOfSchema";import{RecursiveSchema}from"./RecursiveSchema";import{operationStore}from"../../jotai/operation";import{FieldDetails}from"../PropertyDetails";import{pathIncludesLink}from"../../utils";function SchemaComponent(e){var r,{schema:t,onDiscriminatorChange:o}=e,i=__rest(e,["schema","onDiscriminatorChange"]);const{activeOneOf:n}=useAtomValue(operationStore(null==t?void 0:t.operationPointer)),a=useLocation();if(!t)return null;const{type:s,oneOf:c,discriminatorProp:m,isCircular:l}=t;if(l)return _jsx(RecursiveSchema,{schema:t});if(void 0!==m){if(!c||!c.length)return console.warn(`Looks like you are using discriminator wrong: you don't have any definition inherited from the ${t.title}`),null;const e=c.findIndex(((e,r)=>pathIncludesLink(a,`d=${r}`))),r=-1===e?0:e,s=c[void 0!==n[t.pointer]?n[t.pointer]:r];return(null==s?void 0:s.isCircular)?_jsx(RecursiveSchema,{schema:s}):_jsx(ObjectSchema,Object.assign({},i,{schema:s,discriminator:{fieldName:m,parentSchema:t,activeOneOfIdx:r,onChange:o}}))}if(void 0!==c)return _jsx(OneOfSchema,Object.assign({},i,{schema:t}));const p=Array.isArray(s)?s:[s];if(p.includes("object")){if(null===(r=t.fields)||void 0===r?void 0:r.length)return _jsx(ObjectSchema,Object.assign({},i,{schema:t}))}else if(p.includes("array"))return _jsx(ArraySchema,Object.assign({},i,{schema:t}));const d={schema:t,name:"",description:t.description,required:!1,deprecated:!1};return _jsx(Wrapper,{children:_jsx(FieldDetails,{field:d,fieldParentsName:i.fieldParentsName})})}export const Schema=memo(SchemaComponent);const Wrapper=styled.div`
|
|
2
2
|
padding: var(--spacing-xxs) 0;
|
|
3
3
|
border-bottom: 1px solid var(--border-color-primary);
|
|
4
4
|
`;
|
|
@@ -17,6 +17,7 @@ export interface SchemaProps extends SchemaOptions {
|
|
|
17
17
|
deepLink?: string;
|
|
18
18
|
required?: boolean;
|
|
19
19
|
disableDeepLinks?: boolean;
|
|
20
|
+
oneOfLevel?: number;
|
|
20
21
|
}
|
|
21
22
|
export interface ObjectSchemaProps extends Omit<SchemaProps, 'onDiscriminatorChange'> {
|
|
22
23
|
discriminator?: {
|
|
@@ -28,4 +29,5 @@ export interface ObjectSchemaProps extends Omit<SchemaProps, 'onDiscriminatorCha
|
|
|
28
29
|
fieldParentsName?: string[];
|
|
29
30
|
expandable?: boolean;
|
|
30
31
|
required?: boolean;
|
|
32
|
+
oneOfLevel?: number;
|
|
31
33
|
}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{useLocation}from"react-router-dom";import{useMemo}from"react";const OneOfLocationRegex=/(?=oneof=)/g;export function useOneOfLocationIdx(o,e){const n=useLocation();return useMemo((()=>o.findIndex(((o,t)=>{var r;return null===(r=n.hash.split(OneOfLocationRegex)[e])||void 0===r?void 0:r.includes(`oneof=${t}`)}))),[e,n.hash,o])}
|
|
2
|
+
//# sourceMappingURL=useOneOfLocationIdx.js.map
|
|
@@ -1,25 +1,16 @@
|
|
|
1
|
-
import{jsx as _jsx,jsxs as _jsxs,Fragment as _Fragment}from"react/jsx-runtime";import{useMemo}from"react";import{breakpoints,LayoutVariant,OpenApiHeader}from"@redocly/theme";import{useAtomValue}from"jotai";import styled from"styled-components";import{ContentItem}from"../ContentItem";import{PageFooter}from"../PageFooter";import{globalOptionsAtom}from"../../jotai/store";import{RenderHook}from"../RenderHook";import{RightPanel}from"../RightPanel";import{layoutAtom}from"../../jotai/app";import{SamplesMiddlePanel,SamplesPanel}from"../common";export function SectionContent({items:e,hideFooterAndHeader:t}){const{unstable_hooks:{MiddlePanelHeader:a},routingBasePath:o}=useAtomValue(globalOptionsAtom),n=useAtomValue(layoutAtom),
|
|
2
|
-
display: flex;
|
|
3
|
-
width: 100%;
|
|
4
|
-
margin-bottom: var(--spacing-xxl);
|
|
5
|
-
`,MiddlePanelWrapper=styled(SamplesMiddlePanel)`
|
|
1
|
+
import{jsx as _jsx,jsxs as _jsxs,Fragment as _Fragment}from"react/jsx-runtime";import{useMemo}from"react";import{breakpoints,LayoutVariant,OpenApiHeader}from"@redocly/theme";import{useAtomValue}from"jotai";import styled from"styled-components";import{ContentItem}from"../ContentItem";import{PageFooter}from"../PageFooter";import{globalOptionsAtom}from"../../jotai/store";import{RenderHook}from"../RenderHook";import{RightPanel}from"../RightPanel";import{layoutAtom}from"../../jotai/app";import{Row,SamplesMiddlePanel,SamplesPanel}from"../common";export function SectionContent({items:e,hideFooterAndHeader:t}){const{unstable_hooks:{MiddlePanelHeader:a},routingBasePath:o}=useAtomValue(globalOptionsAtom),n=useAtomValue(layoutAtom),r=n===LayoutVariant.STACKED,i=useMemo((()=>t?null:_jsx(MiddlePanelWrapper,{isStacked:r,children:_jsx(PageFooter,{})})),[t,r]),l=useMemo((()=>t||!OpenApiHeader&&!a?null:_jsx(MiddlePanelWrapper,{isStacked:r,children:a?_jsx(RenderHook,{Hook:a,props:void 0}):_jsx(OpenApiHeader,{})})),[a,t,r]);return 0===e.length?null:_jsxs(_Fragment,{children:[l,_jsxs(Row,{layout:n,children:[_jsx(SectionContainer,{layout:n,children:e.filter((({type:e})=>"section"===e)).map((e=>_jsx(ContentItem,{item:e,routingBasePath:o},e.id)))}),_jsx(RightPanelContainer,{isStacked:r,tabIndex:0,children:_jsx(RightPanel,{item:e[0]})})]}),e.filter((({type:e})=>"section"!==e)).map((e=>_jsx(ContentItem,{item:e,routingBasePath:o},e.id))),i]})}const MiddlePanelWrapper=styled(SamplesMiddlePanel)`
|
|
6
2
|
align-self: flex-start;
|
|
7
3
|
padding-top: var(--panel-gap-vertical);
|
|
8
4
|
padding-bottom: var(--panel-gap-vertical);
|
|
9
5
|
`,SectionContainer=styled.div`
|
|
10
6
|
width: 100%;
|
|
11
7
|
|
|
12
|
-
@media screen and (min-width: ${breakpoints.
|
|
8
|
+
@media screen and (min-width: ${breakpoints.large}) {
|
|
13
9
|
width: ${({layout:e})=>e===LayoutVariant.STACKED?"100%":"calc(100% - var(--panel-samples-width))"};
|
|
14
10
|
}
|
|
15
11
|
`,RightPanelContainer=styled(SamplesPanel)`
|
|
16
12
|
margin: var(--spacing-base) 0 var(--spacing-xs);
|
|
17
|
-
display: none;
|
|
18
13
|
overflow-y: auto;
|
|
19
14
|
max-height: calc(100vh - var(--navbar-height) - var(--panel-gap-vertical) * 2);
|
|
20
|
-
|
|
21
|
-
@media screen and (min-width: ${breakpoints.medium}) {
|
|
22
|
-
display: ${({isStacked:e})=>e?"none":"block"};
|
|
23
|
-
}
|
|
24
15
|
`;
|
|
25
16
|
//# sourceMappingURL=SectionContent.js.map
|
|
@@ -3,14 +3,4 @@ import { DropdownMenuItem } from '@redocly/theme';
|
|
|
3
3
|
export declare const PathWrapper: import("styled-components").StyledComponent<import("react").FC<import("@redocly/theme").ButtonProps>, any, import("@redocly/theme").ButtonProps, never>;
|
|
4
4
|
export declare const Path: import("styled-components").StyledComponent<"span", any, {}, never>;
|
|
5
5
|
export declare const StyledDropdownMenuItem: import("styled-components").StyledComponent<typeof DropdownMenuItem, any, {}, never>;
|
|
6
|
-
export declare const StyledCopyButton: import("styled-components").StyledComponent<import("react").NamedExoticComponent<{
|
|
7
|
-
data: unknown;
|
|
8
|
-
type?: import("@redocly/theme").ControlItemType | undefined;
|
|
9
|
-
toasterPlacement?: "left" | "right" | "top" | "bottom" | undefined;
|
|
10
|
-
toasterText?: string | undefined;
|
|
11
|
-
toasterDuration?: number | undefined;
|
|
12
|
-
buttonText?: string | undefined;
|
|
13
|
-
onCopyClick?: ((e: import("react").MouseEvent<HTMLElement, MouseEvent>) => void) | undefined;
|
|
14
|
-
dataTestId?: string | undefined;
|
|
15
|
-
className?: string | undefined;
|
|
16
|
-
}>, any, {}, never>;
|
|
6
|
+
export declare const StyledCopyButton: import("styled-components").StyledComponent<import("react").NamedExoticComponent<import("@redocly/theme").CopyButtonProps>, any, {}, never>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{useActiveSectionId}from"@redocly/theme";import{useMemo}from"react";import{useLocation}from"react-router-dom";import{pathMatchedLink}from"../../../utils";export function useMenuItems({items:e}){const t=useLocation(),i=useActiveSectionId(t,!1,!1);return useMemo((()=>mapAndSetActiveItems(e,i,t)),[i,e,t])}function mapAndSetActiveItems(e,t="",i){const s=[];return convertOpenAPIDocs2Sidebar({contentItems:e,sidebarItems:s,activeItemId:t,location:i}),s}function isItemActive(e,t="",i){return!!e.href&&(t?e.id===t:pathMatchedLink(i,e.href))}function isSubItemActive(e,t="",i){return(e.items||[]).some((e=>isItemActive(e,t,i)||isSubItemActive(e,t,i)))}function convertOpenAPIDocs2Sidebar(e){const{contentItems:t,sidebarItems:i,activeItemId:s,location:c}=e;let o=!0;for(const n of t){const t=isItemActive(n,s,c),a=isSubItemActive(n,s,c);switch(n.type){case"group":i.push({type:"separator",label:n.name,active:t,hasActiveSubItem:a}),convertOpenAPIDocs2Sidebar(Object.assign(Object.assign({},e),{contentItems:n.items,sidebarItems:i}));break;case"tag":const m={type:"group",label:n.name,items:[],link:n.href,active:t,hasActiveSubItem:a,modified:!0};i.push(m),convertOpenAPIDocs2Sidebar({contentItems:n.items,sidebarItems:m.items||[],activeItemId:s,location:c});break;case"operation":case"schema":n.isWebhook&&o&&(i.push({type:"separator",label:"Webhooks",variant:"secondary"}),o=!1),i.push({type:"link",label:n.name,httpVerb:"schema"===n.type?"schema":n.httpVerb,link:n.href,badges:n.badges,active:t,hasActiveSubItem:a,modified:!0});break;case"section":if(-1===n.depth)continue;const r={type:n.items.length?"group":"link",label:n.name,link:n.href,items:[],active:t,hasActiveSubItem:a,modified:!0};i.push(r),n.items.length&&convertOpenAPIDocs2Sidebar({contentItems:n.items,sidebarItems:r.items,activeItemId:s,location:c})}}}
|
|
1
|
+
import{useActiveSectionId}from"@redocly/theme";import{useMemo}from"react";import{useLocation}from"react-router-dom";import{pathMatchedLink}from"../../../utils";export function useMenuItems({items:e}){const t=useLocation(),i=useActiveSectionId(t,!1,!1);return useMemo((()=>mapAndSetActiveItems(e,i,t)),[i,e,t])}function mapAndSetActiveItems(e,t="",i){const s=[];return convertOpenAPIDocs2Sidebar({contentItems:e,sidebarItems:s,activeItemId:t,location:i}),s}function isItemActive(e,t="",i){return!!e.href&&(t?e.id===t:pathMatchedLink(i,e.href))}function isSubItemActive(e,t="",i){return(e.items||[]).some((e=>isItemActive(e,t,i)||isSubItemActive(e,t,i)))}function convertOpenAPIDocs2Sidebar(e){const{contentItems:t,sidebarItems:i,activeItemId:s,location:c}=e;let o=!0;for(const n of t){const t=isItemActive(n,s,c),a=isSubItemActive(n,s,c);switch(n.type){case"group":i.push({type:"separator",label:n.name,active:t,hasActiveSubItem:a}),convertOpenAPIDocs2Sidebar(Object.assign(Object.assign({},e),{contentItems:n.items,sidebarItems:i}));break;case"tag":const m={type:"group",label:n.name,items:[],link:n.href,active:t,hasActiveSubItem:a,modified:!0};i.push(m),convertOpenAPIDocs2Sidebar({contentItems:n.items,sidebarItems:m.items||[],activeItemId:s,location:c});break;case"operation":case"schema":n.isWebhook&&o&&(i.push({type:"separator",label:"Webhooks",variant:"secondary"}),o=!1),i.push({type:"link",label:n.name,httpVerb:"schema"===n.type?"schema":n.httpVerb,link:n.href,badges:n.badges,active:t,hasActiveSubItem:a,modified:!0,deprecated:n.deprecated});break;case"section":if(-1===n.depth)continue;const r={type:n.items.length?"group":"link",label:n.name,link:n.href,items:[],active:t,hasActiveSubItem:a,modified:!0};i.push(r),n.items.length&&convertOpenAPIDocs2Sidebar({contentItems:n.items,sidebarItems:r.items,activeItemId:s,location:c})}}}
|
|
2
2
|
//# sourceMappingURL=useMenuItems.js.map
|
|
@@ -9,7 +9,7 @@ import{H2,LayoutVariant,breakpoints,Markdown}from"@redocly/theme";import styled,
|
|
|
9
9
|
display: none;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
|
-
@media screen and (min-width: ${breakpoints.
|
|
12
|
+
@media screen and (min-width: ${breakpoints.large}) {
|
|
13
13
|
width: ${t?"100%":"calc(100% - var(--panel-samples-width))"};
|
|
14
14
|
padding-left: ${i?"var(--panel-gap-horizontal)":"calc(var(--panel-gap-horizontal) * 2)"};
|
|
15
15
|
padding-right: ${i?"var(--panel-gap-vertical)":"var(--panel-gap-horizontal)"};
|
|
@@ -92,7 +92,7 @@ import{H2,LayoutVariant,breakpoints,Markdown}from"@redocly/theme";import styled,
|
|
|
92
92
|
display: none;
|
|
93
93
|
}
|
|
94
94
|
|
|
95
|
-
@media screen and (min-width: ${breakpoints.
|
|
95
|
+
@media screen and (min-width: ${breakpoints.large}) {
|
|
96
96
|
width: var(--panel-samples-width);
|
|
97
97
|
padding-top: 0;
|
|
98
98
|
padding-bottom: 0;
|
|
@@ -112,7 +112,7 @@ import{H2,LayoutVariant,breakpoints,Markdown}from"@redocly/theme";import styled,
|
|
|
112
112
|
width: 100%;
|
|
113
113
|
padding: 0;
|
|
114
114
|
|
|
115
|
-
@media screen and (min-width: ${breakpoints.
|
|
115
|
+
@media screen and (min-width: ${breakpoints.large}) {
|
|
116
116
|
flex-direction: ${({layout:a})=>a!==LayoutVariant.STACKED?"row":"column"};
|
|
117
117
|
}
|
|
118
118
|
|
|
@@ -1,12 +1,9 @@
|
|
|
1
|
+
import { Badge } from '@redocly/theme';
|
|
1
2
|
export declare const OneOfButton: import("styled-components").StyledComponent<"button", any, {
|
|
2
3
|
selected: boolean;
|
|
3
4
|
deprecated: boolean;
|
|
4
5
|
}, never>;
|
|
5
6
|
export declare const OneOfList: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
6
7
|
export declare const Wrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
7
|
-
export declare const BadgeStyle: import("styled-components").StyledComponent<
|
|
8
|
-
'data-component-name': string;
|
|
9
|
-
} & {
|
|
10
|
-
deprecated?: boolean | undefined;
|
|
11
|
-
}, "data-component-name">;
|
|
8
|
+
export declare const BadgeStyle: import("styled-components").StyledComponent<typeof Badge, any, {}, never>;
|
|
12
9
|
export declare const SelectionTitle: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export*from"./RedoclyOpenAPIDocs";export*from"./pluggable";export
|
|
1
|
+
export*from"./RedoclyOpenAPIDocs";export*from"./pluggable";export*from"./common";export*from"./ApiInfo";export{SectionItem}from"./SectionItem";export{ContentItem}from"./ContentItem";export{ContentItems}from"./ContentItems";export{Discriminator}from"./Discriminator";export*from"./Schema/";export{OperationItem}from"./OperationItem";export*from"./Markdown";export*from"./Responses";export*from"./ResponseSamples/ResponseSamples";export{PayloadSamples,ExampleValue,Example,SelectWrapper}from"./PayloadSamples";export*from"./MediaTypeSwitch";export*from"./RequestParameters";export*from"./SelectOrLabel";export*from"./ErrorBoundary";export*from"./SideMenu/";export*from"./StickySidebar/StickyResponsiveSidebar";export*from"./SchemaDefinition/SchemaDefinition";export*from"./RequestSamples/RequestSamples";
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import styled from"styled-components";export const Icon=()=>_jsxs("svg",{width:"
|
|
1
|
+
import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import styled from"styled-components";export const Icon=()=>_jsxs("svg",{width:"14",height:"14",viewBox:"0 0 24 21",fill:"none",xmlns:"http://www.w3.org/2000/svg",children:[_jsxs("g",{clipPath:"url(#clip0_3789_6604)",children:[_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"}),_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"}),_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"}),_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"})]}),_jsx("defs",{children:_jsx("clipPath",{id:"clip0_3789_6604",children:_jsx("rect",{width:"24",height:"20.0531",fill:"white"})})})]});export const CurlIcon=styled(Icon).attrs((()=>({"data-component-name":"icons/CurlIcon"})))``;
|
|
2
2
|
//# sourceMappingURL=CurlIcon.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import styled from"styled-components";export const Icon=()=>_jsxs("svg",{xmlns:"http://www.w3.org/2000/svg",width:"
|
|
1
|
+
import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import styled from"styled-components";export const Icon=()=>_jsxs("svg",{xmlns:"http://www.w3.org/2000/svg",width:"21",height:"19",viewBox:"0 0 12 5",fill:"none",children:[_jsxs("g",{clipPath:"url(#clip0_6351_16646)",children:[_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"}),_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"}),_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"}),_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"}),_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"})]}),_jsx("defs",{children:_jsx("clipPath",{id:"clip0_6351_16646",children:_jsx("rect",{width:"11.0769",height:"4.5",fill:"white",transform:"translate(0.5)"})})})]});export const GOIcon=styled(Icon).attrs((()=>({"data-component-name":"icons/GOIcon"})))``;
|
|
2
2
|
//# sourceMappingURL=GOIcon.js.map
|
package/lib-esm/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';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{removeLeadingSlash}from"@redocly/theme";import{extractExtensions,getOperationId,getOperationName,getStatusCodeType,getValueFromMdParsedExtension,isStatusCode,JsonPointer,mergeParams,normalizeServers,sortByRequired}from"../utils";import{getCallback}from"./callback";import{getField}from"./field";import{getRequestBody}from"./request";import{getSecurityRequirement}from"./security";import{getResponse}from"./response";import{getHref}from"../services/menu/operation";export function isPayloadSample(e){return"Payload"===e.lang&&"requestBodyContent"in e}
|
|
1
|
+
import{removeLeadingSlash}from"@redocly/theme";import{extractExtensions,getOperationId,getOperationName,getStatusCodeType,getValueFromMdParsedExtension,isStatusCode,JsonPointer,mergeParams,normalizeServers,sortByDeprecated,sortByRequired}from"../utils";import{getCallback}from"./callback";import{getField}from"./field";import{getRequestBody}from"./request";import{getSecurityRequirement}from"./security";import{getResponse}from"./response";import{getHref}from"../services/menu/operation";export function isPayloadSample(e){return"Payload"===e.lang&&"requestBodyContent"in e}export function getOperation(e,r,t,o,i,s){var a,n;const p=r.isWebhook,l={operationDefinition:r,parent:t,pointer:r.pointer,description:getValueFromMdParsedExtension(r,"description"),externalDocs:r.externalDocs,deprecated:!!r.deprecated,httpVerb:r.httpVerb,operationId:r.operationId,path:r.pathName,isWebhook:p,isCallback:Boolean(null==s?void 0:s.isCallback),isEvent:(null==s?void 0:s.isCallback)||p,name:getOperationName(r),defaultExampleName:r.defaultSampleName,type:"operation",callbackId:null==s?void 0:s.id,href:i,get callbacks(){return Object.keys(r.callbacks||[]).map((s=>{var a;return getCallback(e,s,null===(a=r.callbacks)||void 0===a?void 0:a[s],l.pointer,o,i,t)}))},get responses(){let t=!1;return Object.keys(r.responses||[]).filter((e=>"default"===e||("success"===getStatusCodeType(e)&&(t=!0),isStatusCode(e)))).map((i=>getResponse({parser:e,code:i,defaultAsError:t,infoOrRef:r.responses[i],options:o,isEvent:l.isEvent,operation:l})))},get parameters(){let t=mergeParams(e,r.pathParameters,r.parameters,{pathPointer:JsonPointer.dirName(l.pointer),operationPointer:l.pointer}).map((({paramOrRef:r,pointer:t})=>getField(e,r,t,o,{operation:l,type:"request"})));return o.sortRequiredPropsFirst&&(t=sortByRequired(t)),sortByDeprecated(t)}};(null==s?void 0:s.isCallback)?(l.security=(r.security||[]).map((r=>getSecurityRequirement({requirement:r,parser:e}))),l.servers=normalizeServers("",r.servers||r.pathServers||[]),l.id=removeLeadingSlash(i)):(l.id=getOperationId(r,t),l.href=l.href||getHref(l),l.security=(r.security||e.definition.security||[]).map((r=>getSecurityRequirement({requirement:r,parser:e}))),l.servers=normalizeServers(e.definitionUrl,mergeInMockServer(r.servers||r.pathServers||e.definition.servers||[],o.mockServer))),o.showExtensions&&(l.extensions=extractExtensions(r,o.showExtensions)),l.requestBody=r.requestBody&&getRequestBody({parser:e,infoOrRef:r.requestBody,options:o,operation:l,isEvent:l.isEvent});const d=null===(a=l.requestBody)||void 0===a?void 0:a.content;return l.payload={lang:"Payload",source:"",requestBodyContent:(null==d?void 0:d.hasSample)?d:void 0},l.definitionSamples=r["x-codeSamples"]||[],l.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"}))))||[],l.hasSamples=(null==d?void 0:d.hasSample)||l.definitionSamples.length>0,l.hideReplay=!0===r["x-hideReplay"],l}export 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}}
|
|
2
2
|
//# sourceMappingURL=operation.js.map
|
package/lib-esm/models/schema.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var __rest=this&&this.__rest||function(e,
|
|
1
|
+
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};import{isObject}from"@redocly/theme";import{pushRef}from"../services/OpenAPIParser";import{detectType,extractExtensions,getValueFromMdParsedExtension,humanizeConstraints,isNamedDefinition,isPrimitiveType,JsonPointer,pluralizeType,sortByDeprecated,sortByRequired}from"../utils";import{getField}from"./field";export function getSchema({parser:e,schemaOrRef:t,pointer:i,options:r,isChild:n=!1,baseRefsStack:s=[],deps:o,absolutePointer:a}){var l,p,d,m,c,f,y,u,O;const{resolved:h,refsStack:v}=e.deref(t,s,!0),b=t.$ref||i||a||"",P=pushRef(v,b),g=e.mergeAllOf(h,b,P,t.$ref||a),x=g.type||detectType(g),F={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||isNamedDefinition(b)&&JsonPointer.baseName(b)||"",description: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:isPrimitiveType(g,x),constraints: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":getValueFromMdParsedExtension(g,"x-enumDescriptions"),get fields(){if(hasType(F,"object")||hasType(F,"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(F.type)&&!F.type.some((e=>null===e||"null"===e))?F.type=[...F.type,"null"]:Array.isArray(F.type)||null===F.type&&"null"===F.type||(F.type=[F.type,"null"])),F.displayType=Array.isArray(F.type)?F.type.map((e=>null===e?"null":e)).join(" or "):F.type,F.isCircular)return F;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 F.oneOf=t,F.oneOfType=i,F}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 F.oneOf=t,F.discriminatorProp=i,F}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 F.oneOfType="One of",t&&(F.oneOf=t),F.displayType=i,void 0!==g.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${b}`),F}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&&(F.oneOf=t),F.displayType=i,F.oneOfType="Any of",F}if(hasType(F,"array")&&(g.items&&(F.items=getSchema({parser:e,schemaOrRef:g.items,pointer:b+"/items",options:r,baseRefsStack:P,deps:o,absolutePointer:JsonPointer.join(g.absolutePointer||"",["items"])})),F.displayType=g.prefixItems||Array.isArray(g.items)?"items":pluralizeType((null===(p=F.items)||void 0===p?void 0:p.displayType)||F.displayType),F.displayFormat=(null===(d=F.items)||void 0===d?void 0:d.format)||"",F.typePrefix=(null===(m=F.items)||void 0===m?void 0:m.typePrefix)||"Array of ",F.title=F.title||(null===(c=F.items)||void 0===c?void 0:c.title)||"",F.isPrimitive=void 0!==(null===(f=F.items)||void 0===f?void 0:f.isPrimitive)?null===(y=F.items)||void 0===y?void 0:y.isPrimitive:F.isPrimitive,void 0===F.example&&void 0!==(null===(u=F.items)||void 0===u?void 0:u.example)&&(F.example=[F.items.example]),(null===(O=F.items)||void 0===O?void 0:O.isPrimitive)&&(F.enum=F.items.enum,F["x-enumDescriptions"]=getValueFromMdParsedExtension(F.items,"x-enumDescriptions")),Array.isArray(F.type))){const e=F.type.filter((e=>"array"!==e));e.length&&(F.displayType+=` or ${e.join(" or ")}`)}return r.showExtensions&&(F.extensions=extractExtensions(g,r.showExtensions)),F}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=JsonPointer.baseName(t.$ref);p[t.$ref]=e}const d=(null==a?void 0:a.mapping)||{};let m=(null==a?void 0:a["x-explicitMappingOnly"])||!1;0===Object.keys(d).length&&(m=!1);const c={};for(const e in d){const t=d[e];Array.isArray(c[t])?c[t].push(e):c[t]=[e]}const f=m?Object.assign({},c):Object.assign(Object.assign({},p),c);let y=[];for(const e of Object.keys(f)){const t=f[e];if(Array.isArray(t))for(const i of t)y.push({$ref:e,name:i});else y.push({$ref:e,name:t})}const u=Object.keys(d);0!==u.length&&(y=y.sort(((e,t)=>{const i=u.indexOf(e.name),r=u.indexOf(t.name);return i<0&&r<0?e.name.localeCompare(t.name):i<0?1:r<0?-1:i-r})));return{oneOf:y.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),m=isNamedDefinition(e.$ref)&&!d.title?JsonPointer.baseName(e.$ref):`${d.title||""}${d.const&&JSON.stringify(d.const)||""}`;return getSchema({parser:t,schemaOrRef:Object.assign(Object.assign({},d),{title:m,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 m=Object.keys(o).map((a=>{var l;const p=normalizeField(o[a],a,i),m=void 0!==t.required&&t.required.indexOf(a)>-1;return getField(e,{name:t.properties?a:`[${a}]`,required:m,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,JsonPointer.join(t.absolutePointer||"",["properties",a]))}));return r.sortRequiredPropsFirst&&(m=sortByRequired(m,t.required)),m.push(...Object.keys(a).map((t=>{const o=normalizeField(a[t],t,i);return getField(e,{name:t,required:!1,schema:o,kind:"patternProperties"},`${i}/patternProperties/${t}`,r,s,n)}))),(isObject(l)||!0===l)&&m.push(getField(e,{name:(isObject(l)&&l["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===l?{}:l,kind:"additionalProperties"},i+"/additionalProperties",r,s,n,JsonPointer.join(t.absolutePointer||"",["additionalProperties"]))),m.push(...buildAdditionalItems({parser:e,schema:p,fieldsCount:m.length,$ref:i,options:r,refsStack:n,deps:s})),sortByDeprecated(m)}function buildAdditionalItems({parser:e,schema:t=!1,fieldsCount:i,$ref:r,options:n,refsStack:s,deps:o}){return"boolean"==typeof t?t?[getField(e,{name:`[${i}...]`,schema:{},kind:"additionalItems"},`${r}/additionalItems`,n,o,s)]:[]:Array.isArray(t)?[...t.map(((t,a)=>getField(e,{name:`[${i+a}]`,schema:t,kind:"additionalItems"},`${r}/additionalItems/${a}`,n,o,s)))]:isObject(t)?[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)}
|
|
2
2
|
//# sourceMappingURL=schema.js.map
|
|
@@ -143,6 +143,7 @@ export type OperationModel = {
|
|
|
143
143
|
definitionSamples: OpenAPIXCodeSample[] | Unstable_ExternalCodeSample[];
|
|
144
144
|
badges: OpenAPIXBadges[];
|
|
145
145
|
hasSamples: boolean;
|
|
146
|
+
hideReplay: boolean;
|
|
146
147
|
parameters: FieldModel[];
|
|
147
148
|
responses: ResponseModel[];
|
|
148
149
|
callbacks: CallbackModel[];
|
|
@@ -170,7 +171,7 @@ export type OperationMenuItem = {
|
|
|
170
171
|
depth: number;
|
|
171
172
|
items: ContentItemModel[];
|
|
172
173
|
parent?: GroupModel;
|
|
173
|
-
deprecated
|
|
174
|
+
deprecated: boolean;
|
|
174
175
|
type: 'operation';
|
|
175
176
|
httpVerb: string;
|
|
176
177
|
path: string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{serializeParameterValue,getSecurityDetails,getParameterValue,queryString,isArrayOfObjects,deleteEmptyArrayItem}from"../../utils";import{normalizeMimeType,arrayMergeStrategy}from"../utils";import{MediaTypes}from"../../constants";import{HTTPSnippet}from"./httpsnippet";import{getActiveMediaType}from"../../models/mediaContent";function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:s,generatedPayloadSamplesMaxDepth:i=8,pathParams:n={},properties:o={}},{environment:l,requestValues:u}){var p,c,d;const m=l.server,h=e.servers.find((e=>e.url===m))||e.servers[0],{securityHeaders:f,securityCookies:y,securityQueries:g,securityOAuth2ExtraCalls:O,basicAuth:v}=getSecurityData(null===(p=e.security)||void 0===p?void 0:p[0],r,l),T=(null===(c=null==e?void 0:e.requestBody)||void 0===c?void 0:c.content)&&getActiveMediaType(e.requestBody.content),S={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:i},C=u;let b=!1;const E=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=C.header)||void 0===t?void 0:t[e.name])||getParameterValue("header",e.name)||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,S,s))}})).map((e=>((null==T?void 0:T.name)&&"content-type"===e.name.toLowerCase()&&(b=!0,e.value=T.name),e))).concat(f);!b&&(null==T?void 0:T.name)&&E.unshift({name:"Content-Type",value:null==T?void 0:T.name});const
|
|
1
|
+
import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{serializeParameterValue,getSecurityDetails,getParameterValue,queryString,isArrayOfObjects,deleteEmptyArrayItem}from"../../utils";import{normalizeMimeType,arrayMergeStrategy}from"../utils";import{MediaTypes}from"../../constants";import{HTTPSnippet}from"./httpsnippet";import{getActiveMediaType}from"../../models/mediaContent";function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:s,generatedPayloadSamplesMaxDepth:i=8,pathParams:n={},properties:o={}},{environment:l,requestValues:u}){var p,c,d;const m=l.server,h=e.servers.find((e=>e.url===m))||e.servers[0],{securityHeaders:f,securityCookies:y,securityQueries:g,securityOAuth2ExtraCalls:O,basicAuth:v}=getSecurityData(null===(p=e.security)||void 0===p?void 0:p[0],r,l),T=(null===(c=null==e?void 0:e.requestBody)||void 0===c?void 0:c.content)&&getActiveMediaType(e.requestBody.content),S={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:i},C=u;let b=!1;const E=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=C.header)||void 0===t?void 0:t[e.name])||getParameterValue("header",e.name)||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,S,s))}})).map((e=>((null==T?void 0:T.name)&&"content-type"===e.name.toLowerCase()&&(b=!0,e.value=T.name),e))).concat(f);!b&&(null==T?void 0:T.name)&&E.unshift({name:"Content-Type",value:null==T?void 0:T.name});const _=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>queryString.parse(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,S,s))))).reduce(((e,t)=>{var a;for(const[r,s]of Object.entries(t))e.push({name:r,value:String((null===(a=C.cookie)||void 0===a?void 0:a[r])||s)});return e}),[]).concat(y),A=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>queryString.parse(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,S,s))))).reduce(((e,t)=>{var a,r,s;for(const[i,n]of Object.entries(t))e.push({name:i,value:isArrayOfObjects(null===(a=C.query)||void 0===a?void 0:a[i])&&JSON.stringify(deleteEmptyArrayItem(null===(r=C.query)||void 0===r?void 0:r[i]))||String((null===(s=C.query)||void 0===s?void 0:s[i])||n)});return e}),[]).concat(g),P=`${null==h?void 0:h.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,j=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:s}=t;return e[s]=(null===(a=C.path)||void 0===a?void 0:a[s])||n[s]||getParameterValue(r,s),e}),{}),w=null===(d=null==T?void 0:T.examples)||void 0===d?void 0:d[t],R=(null==T?void 0:T.examples)||{},[k]=Object.values(R),D=(null==C?void 0:C.body)||(null==w?void 0:w.value)||(null==k?void 0:k.value)||(null==T?void 0:T.schema)&&Sampler.sample(null==T?void 0:T.schema.rawSchema,S,s),M=null==T?void 0:T.name.toLowerCase();let q="",H=[];switch(normalizeMimeType(M)){case MediaTypes.JSON:case MediaTypes.XML:q=JSON.stringify(getDataRequest(D,o));break;case MediaTypes.URL_ENCODED:case MediaTypes.MULTIPART:q=queryString.stringify(getDataRequest(D,o)),H=objectToHarParams(getDataRequest(D,o));break;default:q=String(D||"")}const N=q?{mimeType:(null==T?void 0:T.name)||MediaTypes.OCTET_STREAM,text:q,params:H}:void 0,x=e.responses.map((e=>e.code));return{method:e.httpVerb,url:P,httpVersion:"HTTP/1.1",cookies:_,headers:E,queryString:A,postData:N,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:O,basicAuth:v,pathParameters:j,serverVariables:l,allResponseCodes:x}}const defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:Object.assign(Object.assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:Object.assign(Object.assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:Object.assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:Object.assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:Object.assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#+Newtonsoft":{code:"csharpNewtonsoft",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:Object.assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:Object.assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:Object.assign({},defaultOptions)},R:{code:"r",defaultTarget:"httr",defaultOptions:Object.assign({},defaultOptions)}};export function getCodeSample({lang:e,operation:t,exampleName:a,pathParams:r,properties:s,options:i={},environment:n}){try{const{skipOptionalParameters:o,withOAuth2Call:l,spec:u,generatedPayloadSamplesMaxDepth:p,store:c}=i,d=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:s,skipOptionalParameters:o,withOAuth2Call:l,spec:u,generatedPayloadSamplesMaxDepth:p},{environment:n,requestValues:c.requestValues}),m=new HTTPSnippet(d);return langToSnippetConfig[e]?m.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),i)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,t,a){var r,s,i,n;const o={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0};for(const l of(null==e?void 0:e.schemes)||[]){const e=getSecurityDetails(l.id,a);switch(l.type){case"openIdConnect":null===(r=o.securityHeaders)||void 0===r||r.push({name:"Authorization",value:e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";l.flows.clientCredentials&&t?o.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(l.flows.clientCredentials,l.scopes,e)):l.flows.password&&t&&o.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(l.flows.password,l.scopes,e)),null===(s=o.securityHeaders)||void 0===s||s.push({name:"Authorization",value:a});break}case"apiKey":{const t=e.raw||"YOUR_API_KEY_HERE";"header"===l.in&&(null===(i=o.securityHeaders)||void 0===i||i.push({name:l.name,value:t})),"cookie"===l.in&&o.securityCookies.push({name:l.name,value:t}),"query"===l.in&&o.securityQueries.push({name:l.name,value:t});break}case"http":"basic"===l.scheme?o.basicAuth={username:String(e.username),password:String(e.password)}:null===(n=o.securityHeaders)||void 0===n||n.push({name:"Authorization",value:`${capitalizeFirst(l.scheme||"bearer")} <YOUR_${l.bearerFormat||"TOKEN"}_HERE>`})}}return o}function getOAuth2PasswordCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:a.username||"<username>"},{name:"password",value:a.password||"<password>"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getDataRequest(e,t){if(e){if("object"==typeof e)return merge(e,t,{arrayMerge:arrayMergeStrategy});try{return merge(JSON.parse(e),t,{arrayMerge:arrayMergeStrategy})}catch(e){return!1}}return!1}function objectToHarParams(e,t=""){const a=[];for(const[r,s]of Object.entries(e)){const e=t?`${t}[${r}]`:r;"object"==typeof s&&null!==s?a.push(...objectToHarParams(s,e)):a.push({name:e,value:String(s)})}return a}export function isDefined(e){return void 0!==e}export function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}
|
|
2
2
|
//# sourceMappingURL=generator.js.map
|
|
@@ -57,7 +57,7 @@ export interface PayloadCodeSampleConfig extends CodeSampleBasicConfig {
|
|
|
57
57
|
export type CodeSampleConfig = CurlCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | CSharpNewtonsoftCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
|
|
58
58
|
/**
|
|
59
59
|
* Code Samples Generator rules
|
|
60
|
-
* - Reference docs always displays all user custom x-
|
|
60
|
+
* - Reference docs always displays all user custom x-codeSamples
|
|
61
61
|
* - In addition code samples will be generated only for defined languages in array
|
|
62
62
|
*/
|
|
63
63
|
export interface CodeSamplesConfig {
|
|
@@ -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;
|
|
@@ -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,t,d,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===(d=null===(t=null==o?void 0:o.markdocOptions)||void 0===t?void 0:t.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 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),jsonSamplesExpandLevel:argValueToExpandLevel(e.jsonSamplesExpandLevel,2),generatedSamplesMaxDepth:argValueToInt(e.generatedSamplesMaxDepth,8),hideDownloadButtons:argValueToBoolean(e.hideDownloadButtons,!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)||"",schemasExpansionLevel:argValueToExpandLevel(e.schemasExpansionLevel),feedback:e.feedback||{hide:!1},sortRequiredPropsFirst:argValueToBoolean(e.sortRequiredPropsFirst,!1),scrollYOffset:normalizeScrollYOffset(e.scrollYOffset),showExtensions:normalizeShowExtensions(e.showExtensions),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,events:e.events||{},unstable_hooks:e.unstable_hooks||getWindowReferenceOptions(WindowReferenceOptions.HOOKS)||{},unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],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,t,d,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===(d=null===(t=null==o?void 0:o.markdocOptions)||void 0===t?void 0:t.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 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),jsonSamplesExpandLevel:argValueToExpandLevel(e.jsonSamplesExpandLevel,2),generatedSamplesMaxDepth:argValueToInt(e.generatedSamplesMaxDepth,8),hideDownloadButtons:argValueToBoolean(e.hideDownloadButtons,!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,hideReplay:argValueToBoolean(e.hideReplay,!1),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)||"",schemasExpansionLevel:argValueToExpandLevel(e.schemasExpansionLevel),feedback:e.feedback||{hide:!1},sortRequiredPropsFirst:argValueToBoolean(e.sortRequiredPropsFirst,!1),scrollYOffset:normalizeScrollYOffset(e.scrollYOffset),showExtensions:normalizeShowExtensions(e.showExtensions),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,events:e.events||{},unstable_hooks:e.unstable_hooks||getWindowReferenceOptions(WindowReferenceOptions.HOOKS)||{},unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],hidePropertiesPrefix:argValueToBoolean(null==e?void 0:e.hidePropertiesPrefix,!1)}}
|
|
2
2
|
//# sourceMappingURL=normalizeOptions.js.map
|
|
@@ -6,53 +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
|
-
oAuth2RedirectURI?: string | null;
|
|
26
|
-
corsProxyUrl?: string;
|
|
27
|
-
requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
|
|
28
|
-
sortRequiredPropsFirst?: boolean | string;
|
|
29
|
-
sanitize?: boolean | string;
|
|
30
|
-
hideDownloadButtons?: boolean | string;
|
|
31
|
-
downloadUrls?: DownloadUrlsConfig;
|
|
32
|
-
onlyRequiredInSamples?: boolean | string;
|
|
33
|
-
generatedSamplesMaxDepth?: number | string;
|
|
34
|
-
showExtensions?: boolean | string | string[];
|
|
35
|
-
hideSchemaTitles?: boolean | string;
|
|
36
|
-
jsonSamplesExpandLevel?: number | string | 'all';
|
|
37
|
-
schemasExpansionLevel?: number | string | 'all';
|
|
38
|
-
mockServer?: {
|
|
39
|
-
url?: string;
|
|
40
|
-
position?: 'first' | 'last' | 'replace' | 'off';
|
|
41
|
-
description?: string;
|
|
42
|
-
};
|
|
43
|
-
maxDisplayedEnumValues?: number;
|
|
44
|
-
unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
|
|
45
|
-
schemaDefinitionsTagName?: string;
|
|
46
|
-
layout?: LayoutVariant;
|
|
47
|
-
hideInfoMetadata?: boolean;
|
|
48
|
-
events?: Events;
|
|
49
|
-
onDeepLinkClick?: ((link: string) => void) | undefined | null;
|
|
50
|
-
skipBundle?: boolean;
|
|
51
|
-
routingBasePath?: string;
|
|
52
|
-
codeSamples?: CodeSamplesConfig;
|
|
53
|
-
ignoreNamedSchemas?: string[] | string;
|
|
54
|
-
hidePropertiesPrefix?: boolean;
|
|
55
|
-
}
|
|
56
9
|
export interface Options {
|
|
57
10
|
scrollYOffset: () => number;
|
|
58
11
|
hideLoading: boolean;
|
|
@@ -67,6 +20,7 @@ export interface Options {
|
|
|
67
20
|
hideSidebar: boolean;
|
|
68
21
|
feedback: Record<string, any>;
|
|
69
22
|
unstable_hooks: HooksConfig;
|
|
23
|
+
hideReplay: boolean;
|
|
70
24
|
oAuth2RedirectURI: string | null;
|
|
71
25
|
corsProxyUrl?: string;
|
|
72
26
|
requestInterceptor: ((req: Request, operation: OperationModel) => void) | undefined | null;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{encodeBackSlashes,getOperationId,getOperationName}from"../../utils";export function getOperationsItems(e,t,o){if(0===t.operations.length)return[];const r=[];for(const
|
|
1
|
+
import{encodeBackSlashes,getOperationId,getOperationName}from"../../utils";export function getOperationsItems(e,t,o){if(0===t.operations.length)return[];const r=[],a=[];for(const p of t.operations){const t=getOperationId(p,e),n={id:t,type:"operation",parent:e,operationDefinition:p,depth:o,name:getOperationName(p),httpVerb:p.httpVerb,path:p.pathName,items:[],isWebhook:p.isWebhook,operationId:p.operationId,badges:p["x-badges"]||[],href:getHref({id:t}),deprecated:!!p.deprecated};p.isWebhook?a.push(n):r.push(n)}return[...r.sort(((e,t)=>Number(e.deprecated)-Number(t.deprecated))),...a.sort(((e,t)=>Number(e.deprecated)-Number(t.deprecated)))]}export function getHref({id:e}){return encodeBackSlashes(`/${e}`.toLowerCase())}
|
|
2
2
|
//# sourceMappingURL=operation.js.map
|
package/lib-esm/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;
|
|
@@ -102,8 +102,8 @@ export interface OpenAPIOperation extends ParsedDescriptionWithSummary {
|
|
|
102
102
|
security?: OpenAPISecurityRequirement[];
|
|
103
103
|
servers?: OpenAPIServer[];
|
|
104
104
|
'x-codeSamples'?: OpenAPIXCodeSample[];
|
|
105
|
-
'x-code-samples'?: OpenAPIXCodeSample[];
|
|
106
105
|
'x-badges'?: OpenAPIXBadges[];
|
|
106
|
+
'x-hideReplay'?: boolean;
|
|
107
107
|
}
|
|
108
108
|
export interface OpenAPIParameter extends ParsedDescription {
|
|
109
109
|
name: string;
|
|
@@ -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;
|