@redocly/reference-docs 2.11.10 → 2.12.0

package/lib-esm/services/code-samples/httpsnippet/targets/python/requests.js

@@ -1,2 +1,2 @@
-import{__assign}from"tslib";import{format}from"util";import{CodeBuilder}from"../../helpers/code-builder";import{normalizeMimeType}from"../../../../utils";import{addIndentation,buildUrlExpression,printUrlVariablesDeclarations}from"../../helpers/code-helpers";import{HTTPSnippet}from"../..";import{Lang}from"../../helpers/constants";var handler=function(e,t,a){var r,s,o,n=a.target,i=a.client,l=Object.assign({indent:"  "},t),p=new CodeBuilder({indentation:l.indent,variablesPrefix:l.variablesPrefix,lang:Lang.PYTHON});l.withComments&&addComments(p),l.withImports&&p.push("import requests").blank();var u,d,h=!1,m=e.allHeaders;if(null===(r=e.securityOAuth2ExtraCalls)||void 0===r?void 0:r.length){var c=new HTTPSnippet(null===(s=e.securityOAuth2ExtraCalls)||void 0===s?void 0:s[0]).convert(n,i,__assign(__assign({},l),{withImports:!1,withComments:!1,variablesPrefix:"oauth2_"}));p.push(c),p.blank(),(m=m||{}).Authorization='"Bearer " + oauth2_data["access_token"]',h=!0}(printUrlVariablesDeclarations(e,p),p.push(p.var("url").toLowerCase()+" = %s",buildUrlExpression(e,p)).blank(),Object.keys(e.queryObj||{}).length)&&(u="query = "+jsObjectToPythonDict(e.queryObj,l.indent),p.push(u).blank());var b,f=normalizeMimeType(null===(o=e.postData)||void 0===o?void 0:o.mimeType);if(e.postData)switch(f){case"application/x-www-form-urlencoded":d=e.postData.paramsObj?""+addIndentation(jsObjectToPythonDict(e.postData.paramsObj,l.indent),{level:0,firstLine:!1}):e.postData.text;break;case"application/json":e.postData.jsonObj&&(d=addIndentation(jsObjectToPythonDict(e.postData.jsonObj,l.indent),{level:0,firstLine:!1}));break;case"multipart/form-data":p.unshift("# multipart/form-data is not supported yet\n");break;default:e.postData.text&&(console.log(e.postData.text),d="'''\n"+addIndentation(e.postData.text.trim(),{level:1,indent:l.indent,firstLine:!0})+"\n'''")}d&&p.push(p.var("payload").toLowerCase()+" = %s",d).blank();var v=Object.keys(m).length,_=function(e,t){return"Authorization"===e&&h?t:'"'+t+'"'};if(1===v)for(b in m)p.push(p.var("headers").toLowerCase()+' = {"'+b+'": '+_(b,m[b])+"}").blank();else if(v>1){var w=1;for(b in p.push(p.var("headers").toLowerCase()+" = {"),m)w++!==v?p.push(1,'"'+b+'": '+_(b,m[b])+","):p.push(1,'"'+b+'": '+_(b,m[b]));p.push(0,"}").blank()}var C=e.method.toLowerCase(),j=format(p.var("response").toLowerCase()+" = requests."+C+"("+p.var("url").toLowerCase());d&&(j+=", "+("application/json"===f?"json":"data")+"="+p.var("payload").toLowerCase());return v>0&&(j+=", headers="+p.var("headers").toLowerCase()),u&&(j+=", params="+p.var("query").toLowerCase()),e.basicAuth&&(j+=", auth=('"+e.basicAuth.username+"','"+e.basicAuth.password+"')"),j+=")",p.push(j).blank().push(p.var("data").toLowerCase()+" = "+p.var("response").toLowerCase()+".json()").push("print("+p.var("data").toLowerCase()+")"),p.join()};export default handler;function addComments(e){e.push('"""'),e.push("Requires python >= 3"),e.blank(),e.push('Requires module "requests" >= 2.25.1'),e.push("See here for installation details:"),e.push("  https://requests.readthedocs.io/"),e.push('"""'),e.blank()}function jsObjectToPythonDict(e,t){return JSON.stringify(e,(function(e,t){return e&&"boolean"==typeof t?t?"__REDOCLY_<True>__":"__REDOCLY_<False>__":null===t?"__REDOCLY_<None>__":t}),t).replace(/"__REDOCLY_<(\w+)>__"/g,"$1")}
+import{__assign}from"tslib";import{format}from"util";import{CodeBuilder}from"../../helpers/code-builder";import{normalizeMimeType}from"../../../../utils";import{addIndentation,buildUrlExpression,printUrlVariablesDeclarations}from"../../helpers/code-helpers";import{HTTPSnippet}from"../..";import{Lang}from"../../helpers/constants";var handler=function(e,t,a){var r,s,o,n=a.target,i=a.client,l=Object.assign({indent:"  "},t),p=new CodeBuilder({indentation:l.indent,variablesPrefix:l.variablesPrefix,lang:Lang.PYTHON});l.withComments&&addComments(p),l.withImports&&p.push("import requests").blank();var u,d,h=!1,m=e.allHeaders;if(null===(r=e.securityOAuth2ExtraCalls)||void 0===r?void 0:r.length){var c=new HTTPSnippet(null===(s=e.securityOAuth2ExtraCalls)||void 0===s?void 0:s[0]).convert(n,i,__assign(__assign({},l),{withImports:!1,withComments:!1,variablesPrefix:"oauth2_"}));p.push(c),p.blank(),(m=m||{}).Authorization='"Bearer " + oauth2_data["access_token"]',h=!0}(printUrlVariablesDeclarations(e,p),p.push(p.var("url").toLowerCase()+" = %s",buildUrlExpression(e,p)).blank(),Object.keys(e.queryObj||{}).length)&&(u="query = "+jsObjectToPythonDict(e.queryObj,l.indent),p.push(u).blank());var b,f=normalizeMimeType(null===(o=e.postData)||void 0===o?void 0:o.mimeType);if(e.postData)switch(f){case"application/x-www-form-urlencoded":d=e.postData.paramsObj?""+addIndentation(jsObjectToPythonDict(e.postData.paramsObj,l.indent),{level:0,firstLine:!1}):e.postData.text;break;case"application/json":e.postData.jsonObj&&(d=addIndentation(jsObjectToPythonDict(e.postData.jsonObj,l.indent),{level:0,firstLine:!1}));break;case"multipart/form-data":p.unshift("# multipart/form-data is not supported yet\n");break;default:e.postData.text&&(d="'''\n"+addIndentation(e.postData.text.trim(),{level:1,indent:l.indent,firstLine:!0})+"\n'''")}d&&p.push(p.var("payload").toLowerCase()+" = %s",d).blank();var v=Object.keys(m).length,_=function(e,t){return"Authorization"===e&&h?t:'"'+t+'"'};if(1===v)for(b in m)p.push(p.var("headers").toLowerCase()+' = {"'+b+'": '+_(b,m[b])+"}").blank();else if(v>1){var w=1;for(b in p.push(p.var("headers").toLowerCase()+" = {"),m)w++!==v?p.push(1,'"'+b+'": '+_(b,m[b])+","):p.push(1,'"'+b+'": '+_(b,m[b]));p.push(0,"}").blank()}var C=e.method.toLowerCase(),j=format(p.var("response").toLowerCase()+" = requests."+C+"("+p.var("url").toLowerCase());d&&(j+=", "+("application/json"===f?"json":"data")+"="+p.var("payload").toLowerCase());return v>0&&(j+=", headers="+p.var("headers").toLowerCase()),u&&(j+=", params="+p.var("query").toLowerCase()),e.basicAuth&&(j+=", auth=('"+e.basicAuth.username+"','"+e.basicAuth.password+"')"),j+=")",p.push(j).blank().push(p.var("data").toLowerCase()+" = "+p.var("response").toLowerCase()+".json()").push("print("+p.var("data").toLowerCase()+")"),p.join()};export default handler;function addComments(e){e.push('"""'),e.push("Requires python >= 3"),e.blank(),e.push('Requires module "requests" >= 2.25.1'),e.push("See here for installation details:"),e.push("  https://requests.readthedocs.io/"),e.push('"""'),e.blank()}function jsObjectToPythonDict(e,t){return JSON.stringify(e,(function(e,t){return e&&"boolean"==typeof t?t?"__REDOCLY_<True>__":"__REDOCLY_<False>__":null===t?"__REDOCLY_<None>__":t}),t).replace(/"__REDOCLY_<(\w+)>__"/g,"$1")}
 //# sourceMappingURL=requests.js.map

package/lib-esm/services/code-samples/httpsnippet/targets/r/httr.d.ts

@@ -0,0 +1,4 @@
+import type { LanguageHandler } from '../..';
+import type { RCodeSampleConfig } from '../../../types';
+declare const handler: LanguageHandler<RCodeSampleConfig['options']>;
+export default handler;

package/lib-esm/services/code-samples/httpsnippet/targets/r/httr.js

@@ -0,0 +1,2 @@
+import{__assign}from"tslib";import{CodeBuilder}from"../../helpers/code-builder";import{buildUrlExpression,printUrlVariablesDeclarations}from"../../helpers/code-helpers";import{Lang}from"../../helpers/constants";import{HTTPSnippet}from"../..";import{normalizeMimeType}from"../../../../utils";import{postDataToRListBody,objectToRString}from"./utils";var indent=1,contentType={X_FORM_URLENCODED:"application/x-www-form-urlencoded",JSON:"application/json",FORM_DATA:"multipart/form-data"},handler=function(a,e,t){var r,s,o,n,i,l=t.target,p=t.client,d=Object.assign({indent:"  ",showBoilerplate:!0,printBody:!0},e),u=new CodeBuilder({indentation:d.indent,variablesPrefix:d.variablesPrefix,lang:Lang.R}),h=a.method.toUpperCase(),c=null===(r=a.securityOAuth2ExtraCalls)||void 0===r?void 0:r[0];if(d.showBoilerplate&&u.push("library(httr)").blank(),c){var b="oauth2_",m=new HTTPSnippet(c).convert(l,p,__assign(__assign({},d),{variablesPrefix:b,showBoilerplate:!1}));u.push(m).push('access_token = content(oauth2_data_req, "parsed")$access_token').blank(),a.allHeaders.Authorization='paste("Bearer", access_token)'}var v="";if(null==a?void 0:a.postData)switch(normalizeMimeType(null===(s=null==a?void 0:a.postData)||void 0===s?void 0:s.mimeType)){case contentType.X_FORM_URLENCODED:i="form",v=u.var("body");var y=postDataToRListBody(a.postData.params,d);u.push(v+" <- list("+y+")").blank();break;case contentType.JSON:i="json",v=u.var("body");y=objectToRString(a.postData.jsonObj,d);u.push(v+" = '"+y+"'").blank();break;case contentType.FORM_DATA:i="multipart",v=u.var("body");y=postDataToRListBody(a.postData.params,d);u.push(v+" <- list("+y+")").blank();break;default:(null===(o=a.postData)||void 0===o?void 0:o.text)&&(v=u.var("body"),i="raw",u.push(v+" = "+objectToRString(null===(n=a.postData)||void 0===n?void 0:n.text)).blank())}printUrlVariablesDeclarations(a,u),Object.keys(__assign(__assign({},a.pathParameters),a.serverVariables)).length&&u.blank().push("# create you own operator").push('"%&%" <- function(x, y)paste0(x,y)').blank();var _=buildUrlExpression(a,u);u.push("url = "+_).blank();var f=u.var("data_req");if(u.push(f+" <- "+h+"("),u.push(indent,"url,"),a.basicAuth){var k=a.basicAuth,T=k.username,D=k.password;u.push(indent,'authenticate("'+T+'", "'+D+'")')}if(Object.keys(a.allHeaders).length){var g=""+Object.keys(a.allHeaders).map((function(e){return'"'+e+'" = '+(a.allHeaders[e].startsWith("paste")?a.allHeaders[e]:'"'+a.allHeaders[e]+'"')})).join(", ");g&&u.push(indent,"add_headers("+g+"),")}return v&&(u.push(indent,"body = "+v+","),u.push(indent,'encode = "'+i+'",')),u.push(indent,"verbose()"),u.push(")"),d.printBody&&u.blank().push("content("+f+("raw"===i?', "text"':"")+")"),u.join()};export default handler;
+//# sourceMappingURL=httr.js.map

package/lib-esm/services/code-samples/httpsnippet/targets/r/index.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    info: {
+        key: string;
+        title: string;
+        extname: string;
+        default: string;
+    };
+    httr: import("../..").LanguageHandler<import("../../..").BasicLanguageOptions | undefined>;
+};
+export default _default;

package/lib-esm/services/code-samples/httpsnippet/targets/r/index.js

@@ -0,0 +1,2 @@
+import httr from"./httr";export default{info:{key:"r",title:"R",extname:".r",default:"httr"},httr:httr};
+//# sourceMappingURL=index.js.map

package/lib-esm/services/code-samples/httpsnippet/targets/r/utils.d.ts

@@ -0,0 +1,5 @@
+import type { PrivateOptions } from '../..';
+import type { BasicLanguageOptions } from '../../../types';
+import type { Param } from '../../../har';
+export declare function objectToRString(input?: GenericObject | string, options?: BasicLanguageOptions & PrivateOptions): string;
+export declare function postDataToRListBody(input: Param[], options: BasicLanguageOptions & PrivateOptions): string;

package/lib-esm/services/code-samples/httpsnippet/targets/r/utils.js

@@ -0,0 +1,2 @@
+export function objectToRString(n,t){return n?"string"==typeof n?JSON.stringify(n):JSON.stringify(n,null,1).split("\n").map((function(n,i,o){return i===o.length-1?n:((null==t?void 0:t.indent)||" ")+n})).join("\n").trim():""}export function postDataToRListBody(n,t){return"\n"+n.map((function(n){var i=n.name,o=n.value;return((null==t?void 0:t.indent)||"")+(i+' = "')+o+'"'})).join(",\n")+"\n"}
+//# sourceMappingURL=utils.js.map

package/lib-esm/services/code-samples/types.d.ts

@@ -1,4 +1,4 @@
-export declare type Languages = 'JavaScript' | 'Node.js' | 'curl' | 'Java8+Apache' | 'Java' | 'Python' | 'Go' | 'PHP' | 'C#' | 'Ruby';
+export declare type Languages = 'JavaScript' | 'Node.js' | 'curl' | 'Java8+Apache' | 'Java' | 'Python' | 'Go' | 'PHP' | 'C#' | 'Ruby' | 'R';
 export interface BasicLanguageOptions {
     indent?: string;
     withImports?: boolean;
@@ -45,7 +45,10 @@ export interface PHPCodeSampleConfig extends CodeSampleBasicConfig {
 export interface RubyCodeSampleConfig extends CodeSampleBasicConfig {
     lang: 'Ruby';
 }
-export declare type CodeSampleConfig = cURULCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig;
+export interface RCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'R';
+}
+export declare type CodeSampleConfig = cURULCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
 /**
  * Code Samples Generator rules
  * - Reference docs always displays all user custom x-code-samples

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/reference-docs",
-  "version": "2.11.10",
+  "version": "2.12.0",
   "description": "Redocly Reference Docs",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",
@@ -36,7 +36,7 @@
     "mkdirp": "^0.5.1",
     "mobx-react": "^7.2.0",
     "node-libs-browser": "^2.2.0",
-    "openapi-sampler": "^1.0.1",
+    "openapi-sampler": "^1.2.1",
     "path-browserify": "^1.0.1",
     "perfect-scrollbar": "^1.4.0",
     "polished": "^3.6.5",