@redocly/reference-docs 2.1.9 → 2.1.13

package/lib-esm/services/code-samples/generator.js

@@ -1,2 +1,2 @@
-import{__assign}from"tslib";import{HTTPSnippet}from"./httpsnippet";import{serializeParameterValue}from"../../redoc-lib";import{parse as parseQueryString,stringify as stringifyQueryString}from"query-string";import*as Sampler from"openapi-sampler";import{getSecurityDetails,getParameterValue}from"../../utils";import{isSameMime,normalizeMimeType}from"../utils";function mapOperationToHAR(e,a){var t,r,i,n,s,o,l,u=a.exampleName,p=void 0===u?"":u,c=a.skipOptionalParameters,d=void 0!==c&&c,m=a.withOAuth2Call,f=void 0!==m&&m,h=a.spec,v=a.generatedPayloadSamplesMaxDepth,g=void 0===v?8:v,y=getSecurityData(null===(t=e.security)||void 0===t?void 0:t[0],f),O=y.securityHeaders,_=y.securityCookies,S=y.securityQueries,T=y.securityOAuth2ExtraCalls,w=y.basicAuth,C=null===(i=null===(r=e.requestBody)||void 0===r?void 0:r.content)||void 0===i?void 0:i.active,P={skipNonRequired:d,skipReadOnly:!0,maxSampleDepth:g},A=!1,x=e.parameters.filter((function(e){return"header"===e.in})).filter((function(e){return!(d&&!e.required)})).map((function(e){return{name:e.name,value:getParameterValue("header",e.name)||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,P,h))}})).map((function(e){return(null==C?void 0:C.name)&&"content-type"===e.name.toLowerCase()&&(A=!0,e.value=C.name),e})).concat(O);!A&&(null==C?void 0:C.name)&&x.unshift({name:"Content-Type",value:null==C?void 0:C.name});var E=e.parameters.filter((function(e){return"cookie"===e.in})).filter((function(e){return!(d&&!e.required)})).map((function(e){return parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,P,h)))})).reduce((function(e,a){for(var t=0,r=Object.entries(a);t<r.length;t++){var i=r[t],n=i[0],s=i[1];e.push({name:n,value:String(s)})}return e}),[]).concat(_),b=e.parameters.filter((function(e){return"query"===e.in})).filter((function(e){return!(d&&!e.required)})).map((function(e){return parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,P,h)))})).reduce((function(e,a){for(var t=0,r=Object.entries(a);t<r.length;t++){var i=r[t],n=i[0],s=i[1];e.push({name:n,value:String(s)})}return e}),[]).concat(S),H=(null===(n=e.servers[0])||void 0===n?void 0:n.url.replace(/\/$/,""))+"/"+e.path.replace(/^\//,""),k=e.parameters.filter((function(e){return"path"===e.in})).reduce((function(e,a){var t=a.in,r=a.name;return e[r]=getParameterValue(t,r),e}),{}),R=(null===(o=null===(s=null==C?void 0:C.examples)||void 0===s?void 0:s[p])||void 0===o?void 0:o.value)||(null===(l=Object.values((null==C?void 0:C.examples)||{})[0])||void 0===l?void 0:l.value),z=null==C?void 0:C.name.toLowerCase(),D=isSameMime(z,"application/x-www-form-urlencoded")||isSameMime(z,"multipart/form-data"),j="application/json"===normalizeMimeType(z)?JSON.stringify(R):String(R||"");!j&&D&&(j=(null==C?void 0:C.schema)?stringifyQueryString(Sampler.sample(C.schema.rawSchema,P,h)):"");var N=D?objectToHarParams(parseQueryString(j)):[],q=j?{mimeType:(null==C?void 0:C.name)||"application/octet-stream",text:j,params:N}:void 0;return{method:e.httpVerb,url:H,httpVersion:"HTTP/1.1",cookies:E,headers:x,queryString:b,postData:q,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:T,basicAuth:w,pathParameters:k}}var defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:__assign(__assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:__assign(__assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:__assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:__assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:__assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:__assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:__assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:__assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:__assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:__assign({},defaultOptions)}};export function getCodeSample(e){var a=e.lang,t=e.operation,r=e.exampleName,i=e.options,n=void 0===i?{}:i;try{var s=mapOperationToHAR(t,{exampleName:r,skipOptionalParameters:n.skipOptionalParameters,withOAuth2Call:n.withOAuth2Call,spec:n.spec,generatedPayloadSamplesMaxDepth:n.generatedPayloadSamplesMaxDepth}),o=new HTTPSnippet(s);return langToSnippetConfig[a]?o.convert(langToSnippetConfig[a].code,langToSnippetConfig[a].defaultTarget,__assign(__assign({},langToSnippetConfig[a].defaultOptions),n)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,a){for(var t,r,i,n,s={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0},o=0,l=(null==e?void 0:e.schemes)||[];o<l.length;o++){var u=l[o],p=getSecurityDetails(u.id);switch(u.type){case"openIdConnect":null===(t=s.securityHeaders)||void 0===t||t.push({name:"Authorization",value:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":var c=p.token?(p.token.token_type||"Bearer")+" "+p.token.access_token:"Bearer <YOUR_TOKEN_HERE>";u.flows.clientCredentials&&a?s.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(u.flows.clientCredentials,u.scopes,p)):u.flows.password&&a&&s.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(u.flows.password,u.scopes,p)),null===(r=s.securityHeaders)||void 0===r||r.push({name:"Authorization",value:c});break;case"apiKey":var d=p.raw||"YOUR_API_KEY_HERE";"header"===u.in&&(null===(i=s.securityHeaders)||void 0===i||i.push({name:u.name,value:d})),"cookie"===u.in&&s.securityCookies.push({name:u.name,value:d}),"query"===u.in&&s.securityQueries.push({name:u.name,value:d});break;case"http":"basic"===u.scheme?s.basicAuth={username:p.username||"<username>",password:p.password||"<password>"}:null===(n=s.securityHeaders)||void 0===n||n.push({name:"Authorization",value:capitalizeFirst(u.scheme||"bearer")+" <YOUR_"+(u.bearerFormat||"TOKEN")+"_HERE>"})}}return s}function getOAuth2PasswordCallHar(e,a,t){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:"application/x-www-form-urlencoded"},{name:"Accept",value:"application/json"}],queryString:[],postData:{mimeType:"application/x-www-form-urlencoded",text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:t.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:t.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:t.username||"<username>"},{name:"password",value:t.password||"<password>"},a.length?{name:"scope",value:a.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,a,t){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:"application/x-www-form-urlencoded"},{name:"Accept",value:"application/json"}],queryString:[],postData:{mimeType:"application/x-www-form-urlencoded",text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:t.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:t.client_secret||"YOUR_CLIENT_SECRET"},a.length?{name:"scope",value:a.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function objectToHarParams(e){for(var a=[],t=0,r=Object.entries(e);t<r.length;t++){var i=r[t],n=i[0],s=i[1];a.push({name:n,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)}
+import{__assign}from"tslib";import{parse as parseQueryString,stringify as stringifyQueryString}from"query-string";import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{serializeParameterValue}from"../../redoc-lib";import{getSecurityDetails,getParameterValue}from"../../utils";import{isSameMime,normalizeMimeType,arrayMerge}from"../utils";import{HTTPSnippet}from"./httpsnippet";function mapOperationToHAR(e,a){var t,r,i,n,s,o=a.exampleName,l=void 0===o?"":o,u=a.skipOptionalParameters,p=void 0!==u&&u,c=a.withOAuth2Call,d=void 0!==c&&c,m=a.spec,h=a.generatedPayloadSamplesMaxDepth,f=void 0===h?8:h,v=a.pathParams,g=void 0===v?{}:v,y=a.properties,O=void 0===y?{}:y,_=getSecurityData(null===(t=e.security)||void 0===t?void 0:t[0],d),S=_.securityHeaders,T=_.securityCookies,w=_.securityQueries,C=_.securityOAuth2ExtraCalls,P=_.basicAuth,A=null===(i=null===(r=e.requestBody)||void 0===r?void 0:r.content)||void 0===i?void 0:i.active,x={skipNonRequired:p,skipReadOnly:!0,maxSampleDepth:f},E=!1,b=e.parameters.filter((function(e){return"header"===e.in})).filter((function(e){return!(p&&!e.required)})).map((function(e){return{name:e.name,value:getParameterValue("header",e.name)||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,x,m))}})).map((function(e){return(null==A?void 0:A.name)&&"content-type"===e.name.toLowerCase()&&(E=!0,e.value=A.name),e})).concat(S);!E&&(null==A?void 0:A.name)&&b.unshift({name:"Content-Type",value:null==A?void 0:A.name});var H=e.parameters.filter((function(e){return"cookie"===e.in})).filter((function(e){return!(p&&!e.required)})).map((function(e){return parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,x,m)))})).reduce((function(e,a){for(var t=0,r=Object.entries(a);t<r.length;t++){var i=r[t],n=i[0],s=i[1];e.push({name:n,value:String(s)})}return e}),[]).concat(T),k=e.parameters.filter((function(e){return"query"===e.in})).filter((function(e){return!(p&&!e.required)})).map((function(e){return parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,x,m)))})).reduce((function(e,a){for(var t=0,r=Object.entries(a);t<r.length;t++){var i=r[t],n=i[0],s=i[1];e.push({name:n,value:String(s)})}return e}),[]).concat(w),R=(null===(n=e.servers[0])||void 0===n?void 0:n.url.replace(/\/$/,""))+"/"+e.path.replace(/^\//,""),z=e.parameters.filter((function(e){return"path"===e.in})).reduce((function(e,a){var t=a.in,r=a.name;return e[r]=g[r]||getParameterValue(t,r),e}),{}),D=null===(s=null==A?void 0:A.examples)||void 0===s?void 0:s[l],j=(null==A?void 0:A.examples)||{},N=Object.values(j)[0],q=(null==D?void 0:D.value)||(null==N?void 0:N.value),M=q&&merge(q,O,{arrayMerge:arrayMerge}),U=null==A?void 0:A.name.toLowerCase(),V=isSameMime(U,"application/x-www-form-urlencoded")||isSameMime(U,"multipart/form-data"),I="application/json"===normalizeMimeType(U)?JSON.stringify(M):String(M||"");!I&&V&&(I=(null==A?void 0:A.schema)?stringifyQueryString(Sampler.sample(A.schema.rawSchema,x,m)):"");var Q=V?objectToHarParams(parseQueryString(I)):[],Y=I?{mimeType:(null==A?void 0:A.name)||"application/octet-stream",text:I,params:Q}:void 0;return{method:e.httpVerb,url:R,httpVersion:"HTTP/1.1",cookies:H,headers:b,queryString:k,postData:Y,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:C,basicAuth:P,pathParameters:z}}var defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:__assign(__assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:__assign(__assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:__assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:__assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:__assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:__assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:__assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:__assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:__assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:__assign({},defaultOptions)}};export function getCodeSample(e){var a=e.lang,t=e.operation,r=e.exampleName,i=e.pathParams,n=e.properties,s=e.options,o=void 0===s?{}:s;try{var l=mapOperationToHAR(t,{exampleName:r,pathParams:i,properties:n,skipOptionalParameters:o.skipOptionalParameters,withOAuth2Call:o.withOAuth2Call,spec:o.spec,generatedPayloadSamplesMaxDepth:o.generatedPayloadSamplesMaxDepth}),u=new HTTPSnippet(l);return langToSnippetConfig[a]?u.convert(langToSnippetConfig[a].code,langToSnippetConfig[a].defaultTarget,__assign(__assign({},langToSnippetConfig[a].defaultOptions),o)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,a){for(var t,r,i,n,s={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0},o=0,l=(null==e?void 0:e.schemes)||[];o<l.length;o++){var u=l[o],p=getSecurityDetails(u.id);switch(u.type){case"openIdConnect":null===(t=s.securityHeaders)||void 0===t||t.push({name:"Authorization",value:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":var c=p.token?(p.token.token_type||"Bearer")+" "+p.token.access_token:"Bearer <YOUR_TOKEN_HERE>";u.flows.clientCredentials&&a?s.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(u.flows.clientCredentials,u.scopes,p)):u.flows.password&&a&&s.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(u.flows.password,u.scopes,p)),null===(r=s.securityHeaders)||void 0===r||r.push({name:"Authorization",value:c});break;case"apiKey":var d=p.raw||"YOUR_API_KEY_HERE";"header"===u.in&&(null===(i=s.securityHeaders)||void 0===i||i.push({name:u.name,value:d})),"cookie"===u.in&&s.securityCookies.push({name:u.name,value:d}),"query"===u.in&&s.securityQueries.push({name:u.name,value:d});break;case"http":"basic"===u.scheme?s.basicAuth={username:p.username||"<username>",password:p.password||"<password>"}:null===(n=s.securityHeaders)||void 0===n||n.push({name:"Authorization",value:capitalizeFirst(u.scheme||"bearer")+" <YOUR_"+(u.bearerFormat||"TOKEN")+"_HERE>"})}}return s}function getOAuth2PasswordCallHar(e,a,t){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:"application/x-www-form-urlencoded"},{name:"Accept",value:"application/json"}],queryString:[],postData:{mimeType:"application/x-www-form-urlencoded",text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:t.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:t.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:t.username||"<username>"},{name:"password",value:t.password||"<password>"},a.length?{name:"scope",value:a.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,a,t){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:"application/x-www-form-urlencoded"},{name:"Accept",value:"application/json"}],queryString:[],postData:{mimeType:"application/x-www-form-urlencoded",text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:t.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:t.client_secret||"YOUR_CLIENT_SECRET"},a.length?{name:"scope",value:a.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function objectToHarParams(e){for(var a=[],t=0,r=Object.entries(e);t<r.length;t++){var i=r[t],n=i[0],s=i[1];a.push({name:n,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)}
 //# sourceMappingURL=generator.js.map

package/lib-esm/services/index.d.ts

@@ -1,3 +1,4 @@
 export * from './ProStore';
 export * from './history';
 export * from './store-types';
+export * from './code-samples';

package/lib-esm/services/index.js

@@ -1,2 +1,2 @@
-export*from"./ProStore";export*from"./history";export*from"./store-types";
+export*from"./ProStore";export*from"./history";export*from"./store-types";export*from"./code-samples";
 //# sourceMappingURL=index.js.map

package/lib-esm/services/utils.d.ts

@@ -11,3 +11,4 @@ export declare function isSameMime(a?: string, b?: string): boolean;
  */
 export declare function normalizeMimeType(mimeType?: string): string | undefined;
 export declare function unescapeServerVariables(str: string): string;
+export declare function arrayMerge(target: any[], source: any[]): any[];

package/lib-esm/services/utils.js

@@ -1,2 +1,2 @@
-export function normalizePath(e){return e.startsWith("/")||(e="/"+e),e.endsWith("/")&&(e=e.slice(0,-1)),e}export function isSameMime(e,r){return!(!e||!r)&&e.split(";")[0]===r.split(";")[0]}export function normalizeMimeType(e){if(e)return e.split(";")[0]}export function unescapeServerVariables(e){var r=new RegExp("%7B","g"),t=new RegExp("%7D","g");return e.replace(r,"{").replace(t,"}").replace("///","//")}
+import merge from"deepmerge";export function normalizePath(e){return e.startsWith("/")||(e="/"+e),e.endsWith("/")&&(e=e.slice(0,-1)),e}export function isSameMime(e,r){return!(!e||!r)&&e.split(";")[0]===r.split(";")[0]}export function normalizeMimeType(e){if(e)return e.split(";")[0]}export function unescapeServerVariables(e){var r=new RegExp("%7B","g"),t=new RegExp("%7D","g");return e.replace(r,"{").replace(t,"}").replace("///","//")}export function arrayMerge(e,r){if(e.length){var t=e.map((function(e,t){return merge(e,r[t]||{})}));return r.length>e.length?t.concat(r.slice(e.length)):t}return r}
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/reference-docs",
-  "version": "2.1.9",
+  "version": "2.1.13",
   "description": "Redocly Reference Docs",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",
@@ -76,6 +76,7 @@
     "prepublish-test": "scripts/prepublish-test.sh",
     "test": "npm run test:unit && npm run test:e2e",
     "test:unit": "jest",
+    "test:unit:watch": "jest --watch",
     "test:update-snapshot": "jest --updateSnapshot",
     "test:e2e": "cypress run",
     "cypress": "cypress open",
@@ -129,14 +130,15 @@
     "babylon": "7.0.0-beta.47",
     "core-js": "^3.5.0",
     "css-loader": "^3.3.2",
-    "cypress": "^5.6.0",
+    "cypress": "^8.4.0",
+    "cypress-file-upload": "^5.0.8",
     "enzyme": "^3.7.0",
     "enzyme-to-json": "^3.6.2",
     "eslint": "^7.30.0",
     "eslint-import-resolver-typescript": "^2.4.0",
     "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-react": "^7.24.0",
+    "eslint-plugin-react": "^7.25.1",
     "eslint-plugin-react-hooks": "^4.2.0",
     "html-webpack-plugin": "^4.0.3",
     "husky": "^7.0.0",
@@ -201,7 +203,9 @@
       "/node_modules/"
     ],
     "modulePathIgnorePatterns": [
-      "/benchmark/"
+      "/benchmark/",
+      "src/components/__tests__/mocks/*",
+      "src/models/*"
     ],
     "snapshotSerializers": [
       "enzyme-to-json/serializer"