@redocly/openapi-docs 3.5.14 → 3.5.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useCodeSamples=useCodeSamples;const jotai_1=require("jotai"),services_1=require("../../services"),store_1=require("../../jotai/store"),operation_1=require("../../jotai/operation"),app_1=require("../../jotai/app"),hooks_1=require("../../hooks");function useCodeSamples({payload:e,isWebhook:a,definitionSamples:t,pointer:o}){var s;const{parser:r,options:{codeSamples:n,generatedSamplesMaxDepth:l}}=(0,jotai_1.useAtomValue)(store_1.globalStoreAtom),i=(0,jotai_1.useAtomValue)((0,operation_1.operationStore)(o)),{languages:p}=(0,jotai_1.useAtomValue)(app_1.languageAtom),[g]=(0,jotai_1.useAtomValue)(app_1.environmentAtom),u=(0,hooks_1.useTranslate)(),m=new Map(null==p?void 0:p.map((({key:e,order:a})=>[e,a]))),d=t.filter((e=>m.has((0,app_1.getLangKey)(e)))),c=new Set(d.map(app_1.getLangKey));let _=[];if(!a){_=createCodeSamples((null===(s=n.languages)||void 0===s?void 0:s.filter((({lang:e,label:a})=>"Payload"!==e&&!c.has((0,app_1.getLangKey)({lang:e,label:a})))))||[],n,r.definition,l,i,g,u)}const j=[...d,..._];e&&m.has(e.lang.toLowerCase())&&j.push(Object.assign(Object.assign({},e),{order:m.get(e.lang.toLowerCase())}));const b=j.map((e=>{var a;const t=null!==(a=e.label)&&void 0!==a?a:e.lang;return Object.assign({key:(0,app_1.getLangKey)(e),title:t,order:"number"==typeof m.get(t.toLowerCase())?m.get(t.toLowerCase()):9999},e)})).sort(((e,a)=>e.order-a.order));return{samples:b}}function createCodeSamples(e,{skipOptionalParameters:a,withOAuth2Call:t},o,s,r,n,l){return e.map((({lang:e,label:i,options:p})=>({lang:e,label:i,get:i=>(0,services_1.getCodeSample)(Object.assign(Object.assign({},i),{lang:e,options:Object.assign(Object.assign({},p),{skipOptionalParameters:a,withOAuth2Call:t,spec:o,generatedPayloadSamplesMaxDepth:s,store:r}),environment:n,translate:l}))})))}
1
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useCodeSamples=useCodeSamples;const jotai_1=require("jotai"),services_1=require("../../services"),store_1=require("../../jotai/store"),operation_1=require("../../jotai/operation"),app_1=require("../../jotai/app"),hooks_1=require("../../hooks");function useCodeSamples({payload:e,isWebhook:a,definitionSamples:t,pointer:o}){var s,l;const{parser:n,options:{codeSamples:r,generatedSamplesMaxDepth:i}}=(0,jotai_1.useAtomValue)(store_1.globalStoreAtom),p=(0,jotai_1.useAtomValue)((0,operation_1.operationStore)(o)),{languages:g}=(0,jotai_1.useAtomValue)(app_1.languageAtom),[u]=(0,jotai_1.useAtomValue)(app_1.environmentAtom),d=(0,hooks_1.useTranslate)(),m=new Map(null==g?void 0:g.map((({key:e,order:a})=>[e,a]))),c=t.filter((e=>m.has((0,app_1.getLangKey)(e)))),_=new Set(c.map(app_1.getLangKey));let b=[];if(!a){b=createCodeSamples((null===(s=r.languages)||void 0===s?void 0:s.filter((({lang:e,label:a})=>"Payload"!==e&&!_.has((0,app_1.getLangKey)({lang:e,label:a})))))||[],r,n.definition,i,p,u,d)}const j=[...c,...b],v=null===(l=null==g?void 0:g.find((({lang:a})=>a===(null==e?void 0:e.lang))))||void 0===l?void 0:l.title,h=e&&(0,app_1.getLangKey)({label:v,lang:e.lang});e&&h&&m.has(h)&&j.push(Object.assign(Object.assign({},e),{label:v,order:m.get(h)}));const S=j.map((e=>{var a;const t=null!==(a=e.label)&&void 0!==a?a:e.lang;return Object.assign({key:(0,app_1.getLangKey)(e),title:t,order:"number"==typeof m.get(t.toLowerCase())?m.get(t.toLowerCase()):9999},e)})).sort(((e,a)=>e.order-a.order));return{samples:S}}function createCodeSamples(e,{skipOptionalParameters:a,withOAuth2Call:t},o,s,l,n,r){return e.map((({lang:e,label:i,options:p})=>({lang:e,label:i,get:i=>(0,services_1.getCodeSample)(Object.assign(Object.assign({},i),{lang:e,options:Object.assign(Object.assign({},p),{skipOptionalParameters:a,withOAuth2Call:t,spec:o,generatedPayloadSamplesMaxDepth:s,store:l}),environment:n,translate:r}))})))}
2
2
  //# sourceMappingURL=useCodeSamples.js.map
@@ -10,6 +10,7 @@
10
10
  margin-top: var(--spacing-md);
11
11
  `,Row=styled_components_1.default.div`
12
12
  display: flex;
13
+ flex-wrap: wrap;
13
14
  gap: var(--spacing-xxs);
14
15
  word-break: normal;
15
16
  `,TitleSchema=styled_components_1.default.p`
@@ -1,5 +1,6 @@
1
1
  "use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SecuritySchemeItem=SecuritySchemeItem;const jsx_runtime_1=require("react/jsx-runtime"),styled_components_1=__importDefault(require("styled-components"));function SecuritySchemeItem({label:e,value:t}){return e&&t?(0,jsx_runtime_1.jsxs)(Row,{children:[(0,jsx_runtime_1.jsx)(Label,{children:e}),(0,jsx_runtime_1.jsx)(Value,{children:t})]}):null}const Row=styled_components_1.default.div`
2
2
  display: flex;
3
+ flex-wrap: wrap;
3
4
  justify-content: flex-start;
4
5
  margin-bottom: var(--spacing-xxs);
5
6
  font-size: var(--font-size-sm);
@@ -1,2 +1,2 @@
1
- import{useAtomValue}from"jotai";import{getCodeSample}from"../../services";import{globalStoreAtom}from"../../jotai/store";import{operationStore}from"../../jotai/operation";import{environmentAtom,getLangKey,languageAtom}from"../../jotai/app";import{useTranslate}from"../../hooks";export function useCodeSamples({payload:e,isWebhook:a,definitionSamples:t,pointer:o}){var n;const{parser:r,options:{codeSamples:s,generatedSamplesMaxDepth:l}}=useAtomValue(globalStoreAtom),i=useAtomValue(operationStore(o)),{languages:g}=useAtomValue(languageAtom),[m]=useAtomValue(environmentAtom),p=useTranslate(),u=new Map(null==g?void 0:g.map((({key:e,order:a})=>[e,a]))),d=t.filter((e=>u.has(getLangKey(e)))),c=new Set(d.map(getLangKey));let b=[];if(!a){b=createCodeSamples((null===(n=s.languages)||void 0===n?void 0:n.filter((({lang:e,label:a})=>"Payload"!==e&&!c.has(getLangKey({lang:e,label:a})))))||[],s,r.definition,l,i,m,p)}const f=[...d,...b];e&&u.has(e.lang.toLowerCase())&&f.push(Object.assign(Object.assign({},e),{order:u.get(e.lang.toLowerCase())}));const S=f.map((e=>{var a;const t=null!==(a=e.label)&&void 0!==a?a:e.lang;return Object.assign({key:getLangKey(e),title:t,order:"number"==typeof u.get(t.toLowerCase())?u.get(t.toLowerCase()):9999},e)})).sort(((e,a)=>e.order-a.order));return{samples:S}}function createCodeSamples(e,{skipOptionalParameters:a,withOAuth2Call:t},o,n,r,s,l){return e.map((({lang:e,label:i,options:g})=>({lang:e,label:i,get:i=>getCodeSample(Object.assign(Object.assign({},i),{lang:e,options:Object.assign(Object.assign({},g),{skipOptionalParameters:a,withOAuth2Call:t,spec:o,generatedPayloadSamplesMaxDepth:n,store:r}),environment:s,translate:l}))})))}
1
+ import{useAtomValue}from"jotai";import{getCodeSample}from"../../services";import{globalStoreAtom}from"../../jotai/store";import{operationStore}from"../../jotai/operation";import{environmentAtom,getLangKey,languageAtom}from"../../jotai/app";import{useTranslate}from"../../hooks";export function useCodeSamples({payload:e,isWebhook:a,definitionSamples:t,pointer:o}){var l,n;const{parser:r,options:{codeSamples:s,generatedSamplesMaxDepth:i}}=useAtomValue(globalStoreAtom),g=useAtomValue(operationStore(o)),{languages:m}=useAtomValue(languageAtom),[p]=useAtomValue(environmentAtom),u=useTranslate(),d=new Map(null==m?void 0:m.map((({key:e,order:a})=>[e,a]))),b=t.filter((e=>d.has(getLangKey(e)))),c=new Set(b.map(getLangKey));let f=[];if(!a){f=createCodeSamples((null===(l=s.languages)||void 0===l?void 0:l.filter((({lang:e,label:a})=>"Payload"!==e&&!c.has(getLangKey({lang:e,label:a})))))||[],s,r.definition,i,g,p,u)}const v=[...b,...f],S=null===(n=null==m?void 0:m.find((({lang:a})=>a===(null==e?void 0:e.lang))))||void 0===n?void 0:n.title,A=e&&getLangKey({label:S,lang:e.lang});e&&A&&d.has(A)&&v.push(Object.assign(Object.assign({},e),{label:S,order:d.get(A)}));const h=v.map((e=>{var a;const t=null!==(a=e.label)&&void 0!==a?a:e.lang;return Object.assign({key:getLangKey(e),title:t,order:"number"==typeof d.get(t.toLowerCase())?d.get(t.toLowerCase()):9999},e)})).sort(((e,a)=>e.order-a.order));return{samples:h}}function createCodeSamples(e,{skipOptionalParameters:a,withOAuth2Call:t},o,l,n,r,s){return e.map((({lang:e,label:i,options:g})=>({lang:e,label:i,get:i=>getCodeSample(Object.assign(Object.assign({},i),{lang:e,options:Object.assign(Object.assign({},g),{skipOptionalParameters:a,withOAuth2Call:t,spec:o,generatedPayloadSamplesMaxDepth:l,store:n}),environment:r,translate:s}))})))}
2
2
  //# sourceMappingURL=useCodeSamples.js.map
@@ -1,4 +1,4 @@
1
- import{jsx as _jsx,Fragment as _Fragment,jsxs as _jsxs}from"react/jsx-runtime";import styled from"styled-components";import{SecuritySchemeItem}from"./SecuritySchemeItem";import{titleize}from"../../utils";import{OAuthFlow}from"./OAuthFlow";import{StyledLink,Tag}from"./styled";import{Markdown}from"../Markdown";import{getRequiredScopes}from"./helper";import{useTranslate}from"../../hooks";export function SecurityFlow({type:e,bearerFormat:r,name:t,flows:a,openIdConnectUrl:o,description:i,id:s,securities:n,in:l}){const m=useTranslate();if(!e||!s)return null;const c=getRequiredScopes(s,n),p={http:_jsxs(_Fragment,{children:[_jsx(SecuritySchemeItem,{label:m("openapi.httpAuthorizationScheme","HTTP Authorization Scheme"),value:e}),_jsx(SecuritySchemeItem,{label:m("openapi.bearerFormat","Bearer Format"),value:r})]}),apiKey:_jsx(SecuritySchemeItem,{label:`${titleize(l||"")} ${m("openapi.parameterName","parameter name")}:`,value:t}),oauth2:_jsxs(_Fragment,{children:[_jsx(SecuritySchemeItem,{label:m("openapi.flowType","Flow type"),value:e}),a&&Object.keys(a).map((e=>_jsx(OAuthFlow,{flow:a[e]},e)))]}),openIdConnect:_jsx(SecuritySchemeItem,{label:m("openapi.connectUrl","Connect URL"),value:o&&_jsx(StyledLink,{target:"_blank",rel:"noopener noreferrer",href:o,children:o})})};return _jsxs(Wrapper,{children:[_jsx(TitleSchema,{children:s}),_jsx(Markdown,{source:i}),_jsxs(List,{children:[p[e]||null,_jsx(SecuritySchemeItem,{label:m("openapi.requiredScopes","Required scopes"),value:c.length&&_jsx(Row,{children:c.map((e=>_jsx(Tag,{className:"tag-grey",children:e},e)))})})]})]})}const Wrapper=styled.div`
1
+ import{jsx as _jsx,Fragment as _Fragment,jsxs as _jsxs}from"react/jsx-runtime";import styled from"styled-components";import{SecuritySchemeItem}from"./SecuritySchemeItem";import{titleize}from"../../utils";import{OAuthFlow}from"./OAuthFlow";import{StyledLink,Tag}from"./styled";import{Markdown}from"../Markdown";import{getRequiredScopes}from"./helper";import{useTranslate}from"../../hooks";export function SecurityFlow({type:e,bearerFormat:r,name:t,flows:a,openIdConnectUrl:o,description:i,id:s,securities:n,in:l}){const m=useTranslate();if(!e||!s)return null;const p=getRequiredScopes(s,n),c={http:_jsxs(_Fragment,{children:[_jsx(SecuritySchemeItem,{label:m("openapi.httpAuthorizationScheme","HTTP Authorization Scheme"),value:e}),_jsx(SecuritySchemeItem,{label:m("openapi.bearerFormat","Bearer Format"),value:r})]}),apiKey:_jsx(SecuritySchemeItem,{label:`${titleize(l||"")} ${m("openapi.parameterName","parameter name")}:`,value:t}),oauth2:_jsxs(_Fragment,{children:[_jsx(SecuritySchemeItem,{label:m("openapi.flowType","Flow type"),value:e}),a&&Object.keys(a).map((e=>_jsx(OAuthFlow,{flow:a[e]},e)))]}),openIdConnect:_jsx(SecuritySchemeItem,{label:m("openapi.connectUrl","Connect URL"),value:o&&_jsx(StyledLink,{target:"_blank",rel:"noopener noreferrer",href:o,children:o})})};return _jsxs(Wrapper,{children:[_jsx(TitleSchema,{children:s}),_jsx(Markdown,{source:i}),_jsxs(List,{children:[c[e]||null,_jsx(SecuritySchemeItem,{label:m("openapi.requiredScopes","Required scopes"),value:p.length&&_jsx(Row,{children:p.map((e=>_jsx(Tag,{className:"tag-grey",children:e},e)))})})]})]})}const Wrapper=styled.div`
2
2
  background: var(--layer-color);
3
3
  padding: var(--spacing-base);
4
4
  border-radius: var(--border-radius);
@@ -10,6 +10,7 @@ import{jsx as _jsx,Fragment as _Fragment,jsxs as _jsxs}from"react/jsx-runtime";i
10
10
  margin-top: var(--spacing-md);
11
11
  `,Row=styled.div`
12
12
  display: flex;
13
+ flex-wrap: wrap;
13
14
  gap: var(--spacing-xxs);
14
15
  word-break: normal;
15
16
  `,TitleSchema=styled.p`
@@ -1,5 +1,6 @@
1
1
  import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import styled from"styled-components";export function SecuritySchemeItem({label:e,value:t}){return e&&t?_jsxs(Row,{children:[_jsx(Label,{children:e}),_jsx(Value,{children:t})]}):null}const Row=styled.div`
2
2
  display: flex;
3
+ flex-wrap: wrap;
3
4
  justify-content: flex-start;
4
5
  margin-bottom: var(--spacing-xxs);
5
6
  font-size: var(--font-size-sm);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/openapi-docs",
3
- "version": "3.5.14",
3
+ "version": "3.5.15",
4
4
  "description": "Redocly OpenAPI Docs",
5
5
  "main": "lib/index.js",
6
6
  "module": "lib-esm/index.js",
@@ -44,11 +44,11 @@
44
44
  "url": "~0.11.0",
45
45
  "url-template": "^2.0.8",
46
46
  "util": "~0.12.5",
47
- "@redocly/replay": "0.8.11",
48
- "@redocly/config": "0.19.4"
47
+ "@redocly/config": "0.19.4",
48
+ "@redocly/replay": "0.8.12"
49
49
  },
50
50
  "devDependencies": {
51
- "@shikijs/transformers": "^1.22.2",
51
+ "@shikijs/transformers": "1.24.0",
52
52
  "@testing-library/jest-dom": "6.1.5",
53
53
  "@testing-library/react": "14.1.2",
54
54
  "@testing-library/react-hooks": "^8.0.1",
@@ -61,7 +61,7 @@
61
61
  "@types/node": "18.19.3",
62
62
  "@types/prismjs": "1.26.4",
63
63
  "@types/react": "18.3.9",
64
- "@types/react-dom": "18.2.25",
64
+ "@types/react-dom": "18.3.5",
65
65
  "@types/styled-components": "5.1.34",
66
66
  "@types/webpack": "5.28.5",
67
67
  "@types/webpack-env": "1.18.5",
@@ -96,7 +96,7 @@
96
96
  "webpack": "5.94.0",
97
97
  "webpack-cli": "5.1.4",
98
98
  "webpack-dev-server": "5.1.0",
99
- "@redocly/theme": "0.47.0"
99
+ "@redocly/theme": "0.47.1"
100
100
  },
101
101
  "scripts": {
102
102
  "start": "npm run copy-highlight-hook && webpack serve --mode=development --hot",