@redocly/openapi-docs 3.11.0-next.10 → 3.11.0-next.2

package/lib-esm/models/mediaContent.d.ts

@@ -0,0 +1,7 @@
+import type { MediaContentModel, MediaContentModelInput } from './types';
+/**
+ * MediaContent model ready to be sued by React components
+ * Contains multiple MediaTypes and keeps track of the currently active one
+ */
+export declare function getMediaContent({ parser, info, isRequestType, options, data: { operation, type, response, absolutePointer }, }: MediaContentModelInput): MediaContentModel;
+export declare function getActiveMediaType(content: MediaContentModel, activeMimeName?: string): import("./types").MediaTypeModel;

package/lib-esm/models/mediaContent.js

@@ -0,0 +1,2 @@
+import{getMediaType}from"./mediaType";export function getMediaContent({parser:e,info:t,isRequestType:p,options:o,data:{operation:i,type:a,response:n,absolutePointer:s=""}}){const r=Object.keys(t).map((r=>getMediaType(e,r,p,t[r],o,{operation:i,type:a,response:n,absolutePointer:s}))),m=r.filter((e=>!!e.examples||!!e.formExamples)).length>0;return{mediaTypes:r,isRequestType:p,hasSample:m,operation:i}}export function getActiveMediaType(e,t){return t&&e.mediaTypes.find((e=>e.name===t))||e.mediaTypes[0]||{}}
+//# sourceMappingURL=mediaContent.js.map

package/lib-esm/models/mediaType.d.ts

@@ -0,0 +1,19 @@
+import type { OpenAPIMediaType } from '../types';
+import type { OpenAPIParser, Options } from '../services';
+import type { MediaTypeModel, ResponseModel, OperationModel } from './types';
+/**
+ * @param parser
+ * @param name
+ * @param isRequestType needed to know if skip RO/RW fields in objects
+ * @param info
+ * @param options
+ * @param operation
+ * @param type
+ * @param response
+ */
+export declare function getMediaType(parser: OpenAPIParser, name: string, isRequestType: boolean, info: OpenAPIMediaType, options: Options, { operation, type, response, absolutePointer, }: {
+    operation: OperationModel;
+    type?: 'request' | 'response';
+    response?: ResponseModel;
+    absolutePointer?: string;
+}): MediaTypeModel;

package/lib-esm/models/mediaType.js

@@ -0,0 +1,2 @@
+import*as Sampler from"openapi-sampler";import{getSchema}from"./schema";import{isFormUrlEncoded,isJsonLike,isXmlLike,isMultipartFormData,JsonPointer,mapValues}from"../utils";import{getExamples}from"./example";function generateExamples({parser:e,info:{encoding:a,schema:i},schema:s,mime:o,options:{isRequestType:n,onlyRequiredInSamples:r,generatedSamplesMaxDepth:m,format:t="json"}}){const p={skipReadOnly:n,skipWriteOnly:!n,skipNonRequired:n&&r,maxSampleDepth:m,quiet:!0,format:t};let l={};if(s&&s.oneOf)for(const i of s.oneOf){const n=Sampler.sample(i.rawSchema,p,e.definition);s.discriminatorProp&&"object"==typeof n&&n&&n[s.discriminatorProp]&&(n[s.discriminatorProp]=i.title),l[i.title]=getExamples({parser:e,infoOrRef:{value:n},mime:o,encoding:a})}else l=s?{default:getExamples({parser:e,infoOrRef:{value:Sampler.sample(i,p,e.definition)},mime:o,encoding:a})}:{default:{value:null,rawValue:"null"}};return l}export function getMediaType(e,a,i,s,o,{operation:n,type:r,response:m,absolutePointer:t=""}){let p,l;const d=s.schema&&getSchema({parser:e,schemaOrRef:s.schema,pointer:"",absolutePointer:JsonPointer.join(t,["content",a,"schema"]),options:o,deps:{operation:n,type:r,response:m}}),{onlyRequiredInSamples:f,generatedSamplesMaxDepth:u}=o,{encoding:c,examples:g,example:x}=s;return o.unstable_skipSamples||(void 0!==g?p=mapValues(g,(i=>getExamples({parser:e,infoOrRef:i,mime:a,encoding:c}))):void 0!==x?p={default:getExamples({parser:e,infoOrRef:{value:e.deref(x).resolved},mime:a,encoding:c})}:isJsonLike(a)||isXmlLike(a)?p=generateExamples({parser:e,info:s,schema:d,mime:a,options:{isRequestType:i,onlyRequiredInSamples:f,generatedSamplesMaxDepth:u,format:isXmlLike(a)?"xml":"json"}}):(isFormUrlEncoded(a)||isMultipartFormData(a))&&(l=generateExamples({parser:e,info:s,schema:d,mime:a,options:{isRequestType:i,onlyRequiredInSamples:f,generatedSamplesMaxDepth:u}}))),{examples:p,schema:d,name:a,isRequestType:i,formExamples:l,onlyRequiredInSamples:f,operation:n}}
+//# sourceMappingURL=mediaType.js.map

package/lib-esm/models/operation.d.ts

@@ -0,0 +1,20 @@
+import type { UserClaims } from '@redocly/theme';
+import type { ExtendedOpenAPIOperation, Unstable_ExternalCodeSample, OpenAPIParser, Options } from '../services';
+import type { OpenAPIServer, OpenAPIXCodeSample } from '../types';
+import type { MediaContentModel, OperationModel, GroupModel } from './types';
+export interface Sample {
+    lang: string;
+    label?: string;
+}
+export interface XPayloadSample extends Sample {
+    lang: 'payload';
+    requestBodyContent: MediaContentModel;
+    source: string;
+}
+export interface Callback {
+    isCallback: boolean;
+    id?: string;
+}
+export declare function isPayloadSample(sample: XPayloadSample | OpenAPIXCodeSample | Unstable_ExternalCodeSample): sample is XPayloadSample;
+export declare function getOperation(parser: OpenAPIParser, operationDefinition: ExtendedOpenAPIOperation, parent: GroupModel | undefined, options: Options, href: string, callback?: Callback, userClaims?: UserClaims): OperationModel;
+export declare function mergeInMockServer(servers: OpenAPIServer[], mockServerOptions: Options['mockServer']): OpenAPIServer[];

package/lib-esm/models/operation.js

@@ -0,0 +1,2 @@
+import{configure,removeLeadingSlash}from"@redocly/theme";import{REDOCLY_TEAMS_RBAC}from"@redocly/config";import{extractExtensions,getOperationId,getOperationName,getStatusCodeType,getValueFromMdParsedExtension,isStatusCode,JsonPointer,mergeParams,normalizeServers,sortByDeprecated,sortByRequired,updateOperationWithRequestValues,updateParametersWithUserValues}from"../utils";import{getCallback}from"./callback";import{getField}from"./field";import{getRequestBody}from"./request";import{getSecurity}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,s,a,i){var n,l,p;const d=r.isWebhook,u={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:d,isCallback:Boolean(null==a?void 0:a.isCallback),isEvent:(null==a?void 0:a.isCallback)||d,name:getOperationName(r),defaultExampleName:r.defaultSampleName,[REDOCLY_TEAMS_RBAC]:r[REDOCLY_TEAMS_RBAC]||(null==t?void 0:t[REDOCLY_TEAMS_RBAC]),type:"operation",callbackId:null==a?void 0:a.id,href:s,get callbacks(){return Object.keys(r.callbacks||[]).map((a=>{var n;return getCallback(e,a,null===(n=r.callbacks)||void 0===n?void 0:n[a],u.pointer,o,s,t,i)}))},get responses(){let t=!1;return Object.keys(r.responses||[]).filter((e=>"default"===e||("success"===getStatusCodeType(e)&&(t=!0),isStatusCode(e)))).map((s=>getResponse({parser:e,code:s,defaultAsError:t,infoOrRef:r.responses[s],options:o,isEvent:u.isEvent,operation:u})))},get parameters(){return processParameters(e,r,u,o,f)}};if(null==a?void 0:a.isCallback)u.security=getSecurity(r.security,e),u.servers=normalizeServers("",r.servers||r.pathServers||[]),u.id=removeLeadingSlash(s);else{u.id=getOperationId(r,t),u.href=u.href||getHref(u),u.security=getSecurity(r.security||e.definition.security,e);const s=r.servers||((null===(n=r.pathServers)||void 0===n?void 0:n.length)?r.pathServers:null)||e.definition.servers||[];u.servers=normalizeServers(e.definitionUrl,mergeInMockServer(s,o.mockServer))}o.showExtensions&&(u.extensions=extractExtensions(r,o.showExtensions)),u.requestBody=r.requestBody?getRequestBody({parser:e,infoOrRef:r.requestBody,options:o,operation:u,isEvent:u.isEvent}):void 0;const c=null===(l=u.requestBody)||void 0===l?void 0:l.content;u.payload={lang:"Payload",source:"",requestBodyContent:(null==c?void 0:c.hasSample)?c:void 0},u.definitionSamples=r["x-codeSamples"]||[],u.badges=(null===(p=r["x-badges"])||void 0===p?void 0:p.map((({name:e,color:r,position:t})=>({name:e,color:r||"var(--color-info-base)",position:t||"after"}))))||[],u.hasSamples=(null==c?void 0:c.hasSample)||u.definitionSamples.length>0,u.hideReplay=!0===r["x-hideReplay"];const m={userClaims:i,operation:{operationId:u.operationId,name:u.name,path:u.path,href:u.href,method:u.httpVerb},servers:u.servers},f=(configure(m)||{}).requestValues||{};return updateOperationWithRequestValues(u,f),u}function processParameters(e,r,t,o,s){let a=mergeParams(e,r.pathParameters,r.parameters,{pathPointer:JsonPointer.dirName(t.pointer),operationPointer:t.pointer}).map((({paramOrRef:r,pointer:a})=>{const i=getField(e,r,a,o,{operation:t,type:"request"});return updateParametersWithUserValues(i,s),i}));return o.sortRequiredPropsFirst&&(a=sortByRequired(a)),sortByDeprecated(a)}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}}
+//# sourceMappingURL=operation.js.map

package/lib-esm/models/request.d.ts

@@ -0,0 +1,12 @@
+import type { OpenAPIRequestBody, Referenced } from '../types';
+import type { OpenAPIParser, Options } from '../services';
+import type { RequestBodyModel, OperationModel } from './types';
+type GetRequestBodyInput = {
+    parser: OpenAPIParser;
+    infoOrRef: Referenced<OpenAPIRequestBody>;
+    options: Options;
+    isEvent?: boolean;
+    operation: OperationModel;
+};
+export declare function getRequestBody({ parser, infoOrRef, options, isEvent, operation, }: GetRequestBodyInput): RequestBodyModel;
+export {};

package/lib-esm/models/request.js

@@ -0,0 +1,2 @@
+import{getContentWithLegacyExamples,getValueFromMdParsedExtension,JsonPointer}from"../utils";import{getMediaContent}from"./mediaContent";export function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:n,operation:r}){const{resolved:i}=e.deref(t),s=getValueFromMdParsedExtension(i,"description")||"",a=i.required;let d;const p=!n,u=getContentWithLegacyExamples(i);return void 0!==u&&(d=getMediaContent({parser:e,info:u,isRequestType:p,options:o,data:{operation:r,type:"request",absolutePointer:t.$ref||JsonPointer.join(r.pointer,["requestBody"])}})),{description:s,required:a,content:d}}
+//# sourceMappingURL=request.js.map

package/lib-esm/models/response.d.ts

@@ -0,0 +1,14 @@
+import type { OpenAPIResponse, Referenced } from '../types';
+import type { OpenAPIParser, Options } from '../services';
+import type { ResponseModel, OperationModel } from './types';
+type ResponseProps = {
+    parser: OpenAPIParser;
+    code: string;
+    defaultAsError: boolean;
+    infoOrRef: Referenced<OpenAPIResponse>;
+    options: Options;
+    operation: OperationModel;
+    isEvent?: boolean;
+};
+export declare function getResponse({ parser, code, defaultAsError, infoOrRef, options, isEvent, operation, }: ResponseProps): ResponseModel;
+export {};

package/lib-esm/models/response.js

@@ -0,0 +1,2 @@
+import{getStatusCodeType,getContentWithLegacyExamples,JsonPointer,getValueFromMdParsedExtension}from"../utils";import{getField}from"./field";import{getMediaContent}from"./mediaContent";export function getResponse({parser:e,code:t,defaultAsError:o,infoOrRef:n,options:s,isEvent:r,operation:i}){const a=!!r,{resolved:d}=e.deref(n),p={code:t};void 0!==d["x-summary"]?(p.summary=getValueFromMdParsedExtension(d,"x-summary"),p.description=getValueFromMdParsedExtension(d,"description")||""):(p.summary=getValueFromMdParsedExtension(d,"description")||"",p.description=""),p.type=getStatusCodeType(t,o);const m=d.headers,u=n.$ref||JsonPointer.join((null==i?void 0:i.pointer)||"",["responses",t]);void 0!==m&&(p.headers=Object.keys(m).map((t=>{const o=m[t];return getField(e,Object.assign(Object.assign({},o),{name:t}),JsonPointer.join(u,["headers",t]),s,{operation:i,type:"response",response:p})})));const c=getContentWithLegacyExamples(d);return void 0!==c&&(p.content=getMediaContent({parser:e,info:c,isRequestType:a,options:s,data:{operation:i,type:"response",response:p,absolutePointer:u}})),p}
+//# sourceMappingURL=response.js.map

package/lib-esm/models/schema.d.ts

@@ -0,0 +1,13 @@
+import type { OpenAPISchema, Referenced } from '../types';
+import type { OpenAPIParser, Options } from '../services';
+import type { Deps, SchemaModel } from './types';
+export declare function getSchema({ parser, schemaOrRef, pointer, options, isChild, baseRefsStack, deps, absolutePointer, }: {
+    parser: OpenAPIParser;
+    schemaOrRef: Referenced<OpenAPISchema>;
+    pointer: string;
+    options: Options;
+    isChild?: boolean;
+    baseRefsStack?: string[];
+    deps: Deps;
+    absolutePointer?: string;
+}): SchemaModel;

package/lib-esm/models/schema.js

@@ -0,0 +1,2 @@
+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{REDOCLY_TEAMS_RBAC}from"@redocly/config";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),A={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"],isComplex:!!g["x-complex"],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,[REDOCLY_TEAMS_RBAC]:g[REDOCLY_TEAMS_RBAC],"x-enumDescriptions":getValueFromMdParsedExtension(g,"x-enumDescriptions"),get fields(){if(!A.isCircular&&!A.isComplex&&(hasType(A,"object")||hasType(A,"array")&&hasArrayItems(g)))return buildFields(e,g,b,r,P,o)}};if((g.nullable||g["x-nullable"])&&(Array.isArray(A.type)&&!A.type.some((e=>null===e||"null"===e))?A.type=[...A.type,"null"]:Array.isArray(A.type)||null===A.type&&"null"===A.type||(A.type=[A.type,"null"])),A.displayType=Array.isArray(A.type)?A.type.map((e=>null===e?"null":e)).join(" or "):A.type,A.isCircular)return A;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 A.oneOf=t,A.oneOfType=i,A}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 A.oneOf=t,A.discriminatorProp=i,A}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 A.oneOfType="One of",t&&(A.oneOf=t),A.displayType=i,void 0!==g.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${b}`),A}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&&(A.oneOf=t),A.displayType=i,A.oneOfType="Any of",A}if(hasType(A,"array")&&(g.items&&!hasArrayItems(g)&&(A.items=getSchema({parser:e,schemaOrRef:g.items,pointer:b+"/items",options:r,baseRefsStack:P,deps:o,absolutePointer:JsonPointer.join(g.absolutePointer||"",["items"])})),A.displayType=g.prefixItems||Array.isArray(g.items)?"items":pluralizeType((null===(p=A.items)||void 0===p?void 0:p.displayType)||A.displayType),A.displayFormat=(null===(d=A.items)||void 0===d?void 0:d.format)||"",A.typePrefix=(null===(m=A.items)||void 0===m?void 0:m.typePrefix)||"Array of ",A.title=A.title||(null===(c=A.items)||void 0===c?void 0:c.title)||"",A.isPrimitive=void 0!==(null===(f=A.items)||void 0===f?void 0:f.isPrimitive)?null===(y=A.items)||void 0===y?void 0:y.isPrimitive:A.isPrimitive,void 0===A.example&&void 0!==(null===(u=A.items)||void 0===u?void 0:u.example)&&(A.example=[A.items.example]),(null===(O=A.items)||void 0===O?void 0:O.isPrimitive)&&(A.enum=A.items.enum,A["x-enumDescriptions"]=getValueFromMdParsedExtension(A.items,"x-enumDescriptions")),Array.isArray(A.type))){const e=A.type.filter((e=>"array"!==e));e.length&&(A.displayType+=` or ${e.join(" or ")}`)}return r.showExtensions&&(A.extensions=extractExtensions(g,r.showExtensions)),A}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)}function hasArrayItems(e){return Boolean(Array.isArray(e.items)||Array.isArray(e.prefixItems))}
+//# sourceMappingURL=schema.js.map

package/lib-esm/models/security.d.ts

@@ -0,0 +1,8 @@
+import type { OpenAPISecurityRequirement, OpenAPISecurityScheme, Referenced } from '../types';
+import type { OpenAPIParser } from '../services';
+import type { SecurityRequirement, SecurityScheme } from './types';
+export declare function getSecurity(requirements: OpenAPISecurityRequirement[] | undefined, parser: OpenAPIParser): SecurityRequirement[];
+export declare function getSecurityScheme(parser: Partial<OpenAPIParser>, id: string, scheme: Referenced<OpenAPISecurityScheme>): SecurityScheme;
+export declare function getSecuritySchemes({ parser, }: {
+    parser: Partial<OpenAPIParser>;
+}): Array<SecurityScheme>;

package/lib-esm/models/security.js

@@ -0,0 +1,2 @@
+import{getValueFromMdParsedExtension}from"../utils";export function getSecurity(e=[],t){return e.map((e=>getSecurityRequirement({requirement:e,parser:t}))).filter((({schemes:e})=>e.length>0))}function getSecurityRequirement({requirement:e,parser:t}){const r=t.definition.components&&t.definition.components.securitySchemes||{};return{schemes:Object.keys(e||{}).map((n=>{const i=t.deref(r[n]).resolved,o=e[n]||[];if(i)return Object.assign(Object.assign({},i),{id:n,sectionId:n,scopes:o})})).filter(Boolean)}}export function getSecurityScheme(e,t,r){if(!(null==e?void 0:e.deref))return{};const{resolved:n}=e.deref(r),i=t,o=n.type,s=getValueFromMdParsedExtension(n,"description")||"";let c,a,u,m={};switch(n.type){case"apiKey":c={name:n.name,in:n.in};break;case"http":a={scheme:n.scheme,bearerFormat:n.bearerFormat};break;case"openIdConnect":u={connectUrl:n.openIdConnectUrl};break;case"oauth2":m=n.flows}return{id:t,sectionId:i,type:o,description:s,apiKey:c,http:a,flows:m,openId:u}}export function getSecuritySchemes({parser:e}){var t,r;if(!e)return[];const n=(null===(r=null===(t=e.definition)||void 0===t?void 0:t.components)||void 0===r?void 0:r.securitySchemes)||{};return Object.keys(n).map((t=>getSecurityScheme(e,t,n[t])))}
+//# sourceMappingURL=security.js.map

package/lib-esm/models/tab.d.ts

@@ -0,0 +1,4 @@
+export type TabType<T extends object = object> = {
+    title: string;
+    key: string;
+} & T;

package/lib-esm/models/tab.js

@@ -0,0 +1,2 @@
+export{};
+//# sourceMappingURL=tab.js.map

package/lib-esm/models/types.d.ts

@@ -0,0 +1,265 @@
+import type { REDOCLY_TEAMS_RBAC } from '@redocly/config';
+import type { Node } from '@markdoc/markdoc';
+import type { OpenAPISecurityScheme, OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterLocation, OpenAPIParameterStyle, OpenAPIExternalDocumentation, OpenAPIServer, OpenAPIXCodeSample, OpenAPIXBadges, OpenAPISchema, Referenced, OpenAPIInfo } from '../types';
+import type { OpenAPIParser } from '../services/OpenAPIParser';
+import type { Options } from '../services/config-options';
+import type { ExtendedOpenAPIOperation, MenuItemGroupType, MenuItemType, MergedOpenAPISchema, Unstable_ExternalCodeSample } from '../services/types';
+export type ContentItemModel = GroupModel | OperationMenuItem;
+export interface SecurityCredentials {
+    'x-defaultClientId'?: string;
+    'x-defaultClientSecret'?: string;
+    'x-defaultUsername'?: string;
+    'x-defaultPassword'?: string;
+    'x-defaultAccessToken'?: string;
+    'x-defaultTokenType'?: string;
+    scopes?: string[];
+}
+export interface ExtendedOpenAPISecurityScheme extends OpenAPISecurityScheme, SecurityCredentials {
+    id: string;
+    sectionId: string;
+    scopes: string[];
+    serverUrl?: string;
+    serverValues?: {
+        [serverUrl: string]: SecurityCredentials;
+    };
+}
+export interface SecurityRequirement {
+    schemes: ExtendedOpenAPISecurityScheme[];
+}
+export interface SecurityScheme {
+    id: string;
+    sectionId: string;
+    type: OpenAPISecurityScheme['type'];
+    description: string | GenericObject;
+    apiKey?: {
+        name: string;
+        in: OpenAPISecurityScheme['in'];
+    };
+    http?: {
+        scheme: string;
+        bearerFormat?: string;
+    };
+    openId?: {
+        connectUrl: string;
+    };
+    flows: OpenAPISecurityScheme['flows'];
+}
+export type RequestBodyModel = {
+    description: string | GenericObject;
+    required?: boolean;
+    content: MediaContentModel | undefined;
+};
+export type ExampleModel = {
+    value: any;
+    rawValue: any;
+    summary?: string | GenericObject;
+    description?: string | GenericObject;
+    mime: string;
+    encoding?: {
+        [field: string]: OpenAPIEncoding;
+    };
+    serverValues?: {
+        [serverUrl: string]: {
+            value: any;
+            rawValue: any;
+        };
+    };
+};
+export type MediaTypeModel = {
+    examples?: {
+        [name: string]: ExampleModel;
+    };
+    formExamples?: {
+        [name: string]: ExampleModel;
+    };
+    schema?: SchemaModel;
+    name: string;
+    isRequestType: boolean;
+    onlyRequiredInSamples: boolean;
+    operation: OperationModel;
+};
+export type MediaContentModel = {
+    mediaTypes: MediaTypeModel[];
+    isRequestType: boolean;
+    hasSample: boolean;
+    operation: OperationModel;
+};
+export type MediaContentModelInput = {
+    parser: OpenAPIParser;
+    info: Record<string, OpenAPIMediaType>;
+    isRequestType: boolean;
+    options: Options;
+    data: {
+        operation: OperationModel;
+        type?: 'request' | 'response';
+        response?: ResponseModel;
+        absolutePointer?: string;
+    };
+};
+export type ResponseModel = {
+    content?: MediaContentModel;
+    code: string;
+    summary: string | GenericObject;
+    description: string | GenericObject;
+    type: string;
+    headers: FieldModel[];
+};
+export type FieldModel = {
+    schema: SchemaModel;
+    name: string;
+    required: boolean;
+    description: string | GenericObject;
+    example?: string;
+    examples?: Record<string, ExampleModel>;
+    deprecated: boolean;
+    in?: OpenAPIParameterLocation;
+    kind: string;
+    extensions?: GenericObject;
+    explode: boolean;
+    style?: OpenAPIParameterStyle;
+    const?: any;
+    serializationMime?: string;
+    fieldFullPath?: string;
+    deps: Deps;
+    absolutePointer?: string;
+    serverValues?: {
+        [serverUrl: string]: {
+            example?: string;
+        };
+    };
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type CallbackModel = {
+    name: string;
+    operations: OperationModel[];
+};
+export type OperationModel = {
+    id: string;
+    absoluteIdx?: number;
+    name: string;
+    description?: string | GenericObject;
+    ast?: Node[];
+    href: string;
+    type: MenuItemType;
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    items: ContentItemModel[];
+    depth: number;
+    pointer: string;
+    operationId?: string;
+    httpVerb: string;
+    deprecated: boolean;
+    path: string;
+    servers: OpenAPIServer[];
+    security: SecurityRequirement[];
+    extensions: GenericObject;
+    isCallback: boolean;
+    isWebhook: boolean;
+    isEvent: boolean;
+    callbackId: string;
+    requestBody?: RequestBodyModel;
+    payload?: {
+        lang: string;
+        label?: string;
+        source: string;
+        requestBodyContent?: MediaContentModel;
+    };
+    definitionSamples: OpenAPIXCodeSample[] | Unstable_ExternalCodeSample[];
+    badges: OpenAPIXBadges[];
+    hasSamples: boolean;
+    hideReplay: boolean;
+    parameters: FieldModel[];
+    responses: ResponseModel[];
+    callbacks: CallbackModel[];
+    envVariables?: {
+        values?: Record<string, string>;
+        serverValues?: {
+            [serverUrl: string]: Record<string, string>;
+        };
+    };
+};
+export type GroupModel = {
+    id: string;
+    href: string;
+    name: string;
+    description?: string | GenericObject;
+    isSchema?: boolean;
+    type: MenuItemGroupType;
+    items: ContentItemModel[];
+    ast?: Node[];
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    infoDefinition?: OpenAPIInfo;
+    depth: number;
+    level: number;
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type OperationMenuItem = {
+    id: string;
+    href: string;
+    name: string;
+    operationDefinition: ExtendedOpenAPIOperation;
+    depth: number;
+    items: ContentItemModel[];
+    parent?: GroupModel;
+    deprecated: boolean;
+    type: 'operation';
+    httpVerb: string;
+    path: string;
+    isWebhook: boolean;
+    operationId?: string;
+    badges?: OpenAPIXBadges[];
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type SchemaModel = {
+    operationPointer: string;
+    schemaOrRef: Referenced<OpenAPISchema>;
+    isChild: boolean;
+    refsStack: string[];
+    pointer: string;
+    absolutePointer?: string;
+    type: string | string[];
+    displayType: string;
+    typePrefix: string;
+    title: string;
+    description: string | GenericObject;
+    externalDocs?: OpenAPIExternalDocumentation;
+    isPrimitive: boolean;
+    isCircular: boolean;
+    isComplex: boolean;
+    format?: string;
+    displayFormat?: string;
+    nullable: boolean;
+    deprecated: boolean;
+    pattern?: string;
+    example?: any;
+    enum: any[];
+    default?: any;
+    readOnly: boolean;
+    writeOnly: boolean;
+    constraints: string[];
+    fields?: FieldModel[];
+    items?: SchemaModel;
+    oneOf?: SchemaModel[];
+    oneOfType: string;
+    discriminatorProp?: string;
+    rawSchema: OpenAPISchema;
+    schema: MergedOpenAPISchema;
+    extensions?: GenericObject;
+    'x-enumDescriptions'?: {
+        [name: string]: string;
+    };
+    const: any;
+    contentEncoding?: string;
+    contentMediaType?: string;
+    minItems?: number;
+    maxItems?: number;
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type Deps = {
+    parentFieldFullPath?: string;
+    operation: OperationModel;
+    type?: 'request' | 'response';
+    response?: ResponseModel;
+    in?: string;
+};

package/lib-esm/models/types.js

@@ -0,0 +1,2 @@
+export{};
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1,52 @@
+import type { OpenAPIRef, OpenAPIDefinition } from '../types';
+import type { MergedOpenAPISchema } from './types';
+import type { Options } from './config-options/types';
+/**
+ * Loads and keeps spec. Provides raw spec operations
+ */
+export declare function pushRef(stack: string[], ref?: string): string[];
+export declare function concatRefStacks(base: string[], stack?: string[]): string[];
+export declare class OpenAPIParser {
+    private options;
+    definitionUrl?: string;
+    definition: OpenAPIDefinition;
+    private readonly allowMergeRefs;
+    constructor(definition: OpenAPIDefinition, definitionUrl?: string, options?: Options & {
+        versionId?: string;
+    });
+    validate(spec: GenericObject): void;
+    /**
+     * get spec part by JsonPointer ($ref)
+     */
+    byRef: <T>(ref: string) => T | undefined;
+    /**
+     * checks if the object is OpenAPI reference (contains $ref property)
+     */
+    isRef<T>(obj: OpenAPIRef | T): obj is OpenAPIRef;
+    /**
+     * Resolve given reference object or return as is if it is not a reference
+     * @param obj object to dereference
+     * @param baseRefsStack
+     * @param mergeAsAllOf
+     */
+    deref<T>(obj: OpenAPIRef | T, baseRefsStack?: string[], mergeAsAllOf?: boolean, level?: number): {
+        resolved: T;
+        refsStack: string[];
+    };
+    mergeRefs<T>(ref: OpenAPIRef, resolved: T, mergeAsAllOf: boolean): T;
+    /**
+     * Merge allOf constraints.
+     * @param schema schema with allOF
+     * @param $ref pointer of the schema
+     * @param refsStack
+     * @param absolutePointer
+     */
+    mergeAllOf(schema: MergedOpenAPISchema, $ref: string | undefined, refsStack: string[], absolutePointer?: string, level?: number): MergedOpenAPISchema;
+    /**
+     * Find all derived definitions among #/components/schemas from any of $refs
+     * returns map of definition pointer to definition name
+     * @param $refs array of references to find derived from
+     */
+    findDerived($refs: string[]): Record<string, string[] | string>;
+    private hoistOneOfs;
+}

package/lib-esm/services/OpenAPIParser.js

@@ -0,0 +1,2 @@
+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{IS_BROWSER,isObject,isString,isUndefined}from"@redocly/theme";import{tryDecodeURIComponent,getDefinitionName}from"../utils";import{JsonPointer}from"../utils/JsonPointer";import{normalizeOptions}from"./config-options/normalizeOptions";export function pushRef(e,t){return t&&e[e.length-1]!==t?[...e,t]:e}export function concatRefStacks(e,t){return t?e.concat(t):e}export class OpenAPIParser{constructor(e,t,i=normalizeOptions({})){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"definitionUrl",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"allowMergeRefs",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"byRef",{enumerable:!0,configurable:!0,writable:!0,value:e=>{let t;if(this.definition){"#"!==e.charAt(0)&&(e="#"+e),e=tryDecodeURIComponent(e);try{t=JsonPointer.get(this.definition,e)}catch(e){}return t||{}}}}),this.definition=Object.assign({},e),this.validate(e),this.definition=e,this.allowMergeRefs=e.openapi.startsWith("3.1");const r=IS_BROWSER?window.location.href:"";isString(t)&&(this.definitionUrl=new URL(t,r).href)}validate(e){if(isUndefined(e.openapi))throw new Error("Document must be valid OpenAPI 3.0.0 definition")}isRef(e){return!!e&&(void 0!==e.$ref&&null!==e.$ref)}deref(e,t=[],i=!1,r=0){const n=null==e?void 0:e["x-refsStack"];if(t=concatRefStacks(t,n),r>5)return{resolved:Object.assign({},e,{"x-complex":!0}),refsStack:t};if(this.isRef(e)){const n=getDefinitionName(e.$ref);if(n&&this.options.ignoreNamedSchemas.has(n))return{resolved:{type:"object",title:n},refsStack:t};let s=this.byRef(e.$ref);if(!s)throw new Error(`Failed to resolve $ref "${e.$ref}"`);if(t.includes(e.$ref))s=Object.assign({},s,{"x-circular-ref":!0});else if(this.isRef(s)){s=this.deref(s,t,i,r).resolved}return this.allowMergeRefs&&(s=this.mergeRefs(e,s,i)),{resolved:s,refsStack:pushRef(t,e.$ref)}}return{resolved:e,refsStack:concatRefStacks(t,n)}}mergeRefs(e,t,i){const{$ref:r}=e,n=__rest(e,["$ref"]),s=Object.keys(n);if(0===s.length)return t;if(i&&s.some((e=>!["description","title","externalDocs","x-refsStack","x-parentRefs","readOnly","writeOnly","x-complex"].includes(e)))){const e=n,{description:i,title:r,readOnly:s,writeOnly:o}=e;return{allOf:[{description:i,title:r,readOnly:s,writeOnly:o},t,__rest(e,["description","title","readOnly","writeOnly"])]}}return Object.assign(Object.assign({},t),n)}mergeAllOf(e,t,i,r="",n=0){var s;if(e["x-circular-ref"])return e;if(void 0===(e=this.hoistOneOfs(e)).allOf)return Object.assign({absolutePointer:r},e);let o=Object.assign(Object.assign({},e),{"x-parentRefs":[],absolutePointer:JsonPointer.join(r,["allOf"]),allOf:void 0,title:0===n?e.title||getDefinitionName(t):e.title});!isUndefined(o.properties)&&isObject(o.properties)&&(o.properties=Object.assign({},o.properties)),!isUndefined(o.items)&&isObject(o.items)&&(o.items=Object.assign({},o.items));const f=e.allOf.map(((e,t)=>{var s;const{resolved:f,refsStack:l}=this.deref(e,i,!0,n),a=e.$ref,c=a||JsonPointer.join(r,[String(t)]);if(f["x-complex"])return{$ref:a,refsStack:pushRef(l,a),schema:{"x-complex":!0},absolutePointer:c};const d=this.mergeAllOf(f,a,l,c,n+1);return d["x-circular-ref"]&&d.allOf?void 0:(a&&(null===(s=o["x-parentRefs"])||void 0===s||s.push(...d["x-parentRefs"]||[],a)),{$ref:a,refsStack:pushRef(l,a),schema:d,absolutePointer:c})})).filter(Boolean);for(const[e,{schema:i,refsStack:r,absolutePointer:l}]of f.entries()){const f=i||{},{type:a,enum:c,properties:d,items:p,required:O,title:u,description:m,readOnly:y,writeOnly:b,oneOf:h,anyOf:g,"x-circular-ref":x,"x-complex":j}=f,v=__rest(f,["type","enum","properties","items","required","title","description","readOnly","writeOnly","oneOf","anyOf","x-circular-ref","x-complex"]);if(o.type===a||isUndefined(o.type)||isUndefined(a)||n){if(isUndefined(a)||(Array.isArray(a)&&Array.isArray(o.type)?o.type=[...a,...o.type]:o.type=a),isUndefined(c)||(Array.isArray(c)&&Array.isArray(o.enum)?o.enum=Array.from(new Set([...c,...o.enum])):o.enum=c),!isUndefined(d)&&isObject(d)){o.properties=o.properties||{};for(const i in d){const f=concatRefStacks(r,null===(s=d[i])||void 0===s?void 0:s["x-refsStack"]);if(o.properties[i]){if(!x){const r=this.mergeAllOf({allOf:[o.properties[i],d[i]],"x-refsStack":f},t+"/properties/"+i,f,JsonPointer.join(l,["allOf",String(e),"properties",i]),n+1);o.properties[i]=r}}else o.properties[i]=Object.assign(Object.assign({},d[i]),{absolutePointer:JsonPointer.join(l,["properties",i]),"x-refsStack":f})}}if(!isUndefined(p)&&!x&&!j){const e="boolean"==typeof o.items?{}:Object.assign({},o.items),s="boolean"==typeof i.items?{}:Object.assign({},i.items);o.items=this.mergeAllOf({allOf:[e,s]},t+"/items",r,"",n+1)}isUndefined(h)||(o.oneOf=h),isUndefined(g)||(o.anyOf=g),Array.isArray(O)&&(o.required=[...o.required||[],...O]),o=Object.assign(Object.assign(Object.assign({},o),{title:o.title||u,description:o.description||m,readOnly:isUndefined(o.readOnly)?y:o.readOnly,writeOnly:isUndefined(o.writeOnly)?b:o.writeOnly,"x-circular-ref":o["x-circular-ref"]||x,"x-complex":o["x-complex"]||j}),v)}}return o}findDerived(e){const t={},i=this.definition.components&&this.definition.components.schemas||{};for(const r in i){const{resolved:n}=this.deref(i[r]);!isUndefined(n.allOf)&&n.allOf.find((t=>!isUndefined(t.$ref)&&e.indexOf(t.$ref)>-1))&&(t["#/components/schemas/"+r]=[n["x-discriminator-value"]||r])}return t}hoistOneOfs(e){if(isUndefined(e.allOf))return e;const{allOf:t}=e,i=__rest(e,["allOf"]);for(let e=0;e<t.length;e++){const r=t[e],{oneOf:n}=r,s=__rest(r,["oneOf"]);if(n&&Array.isArray(n)){const r=t.slice(0,e),o=t.slice(e+1),f=Object.keys(s).length>0?[s]:[];return Object.assign(Object.assign({},i),{oneOf:n.map((e=>({allOf:[...r,...f,e,...o]})))})}}return e}}
+//# sourceMappingURL=OpenAPIParser.js.map

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

@@ -0,0 +1,13 @@
+export type LicenseInfo = {
+    t?: boolean;
+    i?: number;
+    e?: number;
+    h?: string[] | true;
+    valid?: boolean;
+    expired?: boolean;
+    allowed?: boolean;
+    local?: boolean;
+    cryptoMissing?: boolean;
+};
+export declare function isHostAllowed(hostname: string, hosts: string[] | boolean | undefined): boolean;
+export default function parse(key?: string): Promise<LicenseInfo>;

package/lib-esm/services/check.js

@@ -0,0 +1,2 @@
+var __awaiter=this&&this.__awaiter||function(t,e,n,o){return new(n||(n=Promise))((function(r,i){function a(t){try{c(o.next(t))}catch(t){i(t)}}function s(t){try{c(o.throw(t))}catch(t){i(t)}}function c(t){var e;t.done?r(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(a,s)}c((o=o.apply(t,e||[])).next())}))};import{cryptoLib}from"./utils";function promisifyIECryptoRes(t){return"then"in t?t:new Promise((e=>{t.oncomplete=t=>{e(t.target.result)}}))}function str2ab(t){const e=new ArrayBuffer(t.length),n=new Uint8Array(e);for(let e=0,o=t.length;e<o;e++)n[e]=t.charCodeAt(e);return e}const getKey=()=>{const t=str2ab(atob("undefined"!=typeof REDOCLY_PUBLIC_KEY?REDOCLY_PUBLIC_KEY:"MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAMHjNir5fXx/ZXoaEeXQ5XyxbNJ4YJYczoCRdSkL6NLzw1FHnng5Vfcgk5+bvox9QRYRbuk84mA4f2NhywDbXKECAwEAAQ=="));return promisifyIECryptoRes(null==cryptoLib?void 0:cryptoLib.subtle.importKey("spki",t,{name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},!0,["verify"]))};function textEncode(t){if(window.TextEncoder)return(new TextEncoder).encode(t);const e=unescape(encodeURIComponent(t)),n=new Uint8Array(e.length);for(let t=0;t<e.length;t++)n[t]=e.charCodeAt(t);return n}function verify(t,e){return __awaiter(this,void 0,void 0,(function*(){return promisifyIECryptoRes(null==cryptoLib?void 0:cryptoLib.subtle.verify({name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},yield getKey(),str2ab(atob(e)),textEncode(t)))}))}export function isHostAllowed(t,e){return!0===e||!(!Array.isArray(e)||"undefined"==typeof window)&&(!("localhost"!==t&&"127.0.0.1"!==t&&!t.endsWith(".localhost")&&!e.find((e=>e===t||t.endsWith("."+e))))||!!e.find((e=>{if(e.indexOf("*")!==e.lastIndexOf("*"))return;const[n,o]=e.split("*");return o&&t.startsWith(n)&&t.endsWith(o)&&o.split(".").length>2})))}export default function parse(t){return __awaiter(this,void 0,void 0,(function*(){if("development"===process.env.NODE_ENV)return{valid:!0,allowed:!0};const e=window.location.hostname;if(!t)return"localhost"===e||"127.0.0.1"===e||e.endsWith(".localhost")?{local:!0}:{};const[n,o]=t.split(".");let r;try{if(!(yield verify(atob(n),o)))return{valid:!1};r=JSON.parse(atob(n))}catch(t){return{valid:!1,cryptoMissing:!0}}return r.valid=!0,(!r.e||Date.now()/1e3>r.e)&&(r.expired=!0),r.allowed=isHostAllowed(e,r.h),r}))}
+//# sourceMappingURL=check.js.map

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

@@ -0,0 +1,2 @@
+import type { Languages as LanguagesType } from './types';
+export declare const Languages: Record<string, LanguagesType | 'Payload'>;

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

@@ -0,0 +1,2 @@
+export const Languages={curl:"curl",JavaScript:"JavaScript",NodeJs:"Node.js",Python:"Python",Java:"Java",CSharp:"C#",PHP:"PHP",Go:"Go",Ruby:"Ruby",R:"R",Payload:"Payload"};
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1,29 @@
+import type { OperationModel } from '../../models';
+import type * as HAR from './har';
+import type { Languages } from './types';
+import type { TFunction } from '@redocly/theme';
+export type CustomHAR = HAR.Request & {
+    securityOAuth2ExtraCalls?: HAR.Request[];
+    basicAuth?: {
+        username: string;
+        password: string;
+    };
+    pathParameters?: {
+        [key in string]: string;
+    };
+    serverVariables?: Record<string, string>;
+    allResponseCodes?: string[];
+};
+export declare function getCodeSample({ lang, operation, exampleName, pathParams, properties, options, environment, translate, }: {
+    lang: Languages;
+    operation: OperationModel;
+    exampleName?: string;
+    pathParams?: GenericObject;
+    properties?: GenericObject;
+    options?: GenericObject;
+    environment: Record<string, string>;
+    translate: TFunction;
+}): string;
+export declare function getDataRequest(exampleValue: any, properties: any): boolean | any;
+export declare function isDefined<T>(arg?: T): arg is T;
+export declare function capitalizeFirst(str: string): string;

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

@@ -0,0 +1,2 @@
+import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{isObject}from"@redocly/theme";import{areArraysEqual,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";import StringUtility from"./httpsnippet/helpers/string-utility";function getSelectedSecurityScheme(e,t){return e.find((e=>{const a=e.schemes.map((e=>e.id));return areArraysEqual(a,t||[])}))}function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:i,generatedPayloadSamplesMaxDepth:s=8,pathParams:n={},properties:l={},activeMimeName:o=""},{environment:u,requestValues:c,activeSecuritySchemeIds:p}){var d,m,v,f,y,h,g,O;const S=u.server,T=e.servers.find((e=>e.url===S))||e.servers[0],b=getSelectedSecurityScheme(e.security,p),{securityHeaders:_,securityCookies:C,securityQueries:j,securityOAuth2ExtraCalls:k,basicAuth:x}=getSecurityData(b||(null===(d=e.security)||void 0===d?void 0:d[0]),r,u),A=(null===(m=null==e?void 0:e.requestBody)||void 0===m?void 0:m.content)&&getActiveMediaType(e.requestBody.content,o),E={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s,quiet:!0},w=c;let P=!1;const M=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t,a,r;return{name:e.name,value:(null===(t=w.header)||void 0===t?void 0:t[e.name])||getParameterValue("header",e.name)||(null===(r=null===(a=e.serverValues)||void 0===a?void 0:a[S])||void 0===r?void 0:r.example)||e.example||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))}})).map((e=>((null==A?void 0:A.name)&&"content-type"===e.name.toLowerCase()&&(P=!0,e.value=A.name),e))).concat(_);!P&&(null==A?void 0:A.name)&&M.unshift({name:"Content-Type",value:null==A?void 0:A.name});const R=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t,a;return queryString.parse(serializeParameterValue(e,(null===(a=null===(t=e.serverValues)||void 0===t?void 0:t[S])||void 0===a?void 0:a.example)||e.example||Sampler.sample(e.schema.rawSchema,E,i)))})).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=w.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(C),D=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t,a;return queryString.parse(serializeParameterValue(e,(null===(a=null===(t=e.serverValues)||void 0===t?void 0:t[S])||void 0===a?void 0:a.example)||e.example||Sampler.sample(e.schema.rawSchema,E,i)))})).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:isArrayOfObjects(null===(a=w.query)||void 0===a?void 0:a[s])&&JSON.stringify(deleteEmptyArrayItem(null===(r=w.query)||void 0===r?void 0:r[s]))||String((null===(i=w.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(j),N=`${null==T?void 0:T.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,q=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a,r,i;const{in:s,name:l}=t;return e[l]=(null===(a=w.path)||void 0===a?void 0:a[l])||(null===(i=null===(r=t.serverValues)||void 0===r?void 0:r[S])||void 0===i?void 0:i.example)||t.example||n[l]||getParameterValue(s,l),e}),{}),H=null==A?void 0:A.name.toLowerCase(),U=H===MediaTypes.MULTIPART||H===MediaTypes.URL_ENCODED,V=U?null===(v=null==A?void 0:A.formExamples)||void 0===v?void 0:v[t]:null===(f=null==A?void 0:A.examples)||void 0===f?void 0:f[t],I=U?(null==A?void 0:A.formExamples)||{}:(null==A?void 0:A.examples)||{},[L]=Object.values(I),$=(null===(h=null===(y=null==V?void 0:V.serverValues)||void 0===y?void 0:y[S])||void 0===h?void 0:h.value)||(null===(O=null===(g=null==L?void 0:L.serverValues)||void 0===g?void 0:g[S])||void 0===O?void 0:O.value),z=e=>{var t;return e&&"object"==typeof e&&(null===(t=null==A?void 0:A.schema)||void 0===t?void 0:t.rawSchema)?Sampler.sample(populateXmlSchemaFields(A.schema.rawSchema,e),Object.assign(Object.assign({},E),{format:"xml"}),i):null},J=(()=>{if(null==w?void 0:w.body)return w.body;if(H!==MediaTypes.XML)return $||(null==V?void 0:V.value)||(null==L?void 0:L.value)||(null==A?void 0:A.schema)&&Sampler.sample(A.schema.rawSchema,Object.assign(Object.assign({},E),{format:"json"}),i);{const e=z($)||z(null==V?void 0:V.value)||z(null==L?void 0:L.value);if(e)return e;if(null==A?void 0:A.schema)return Sampler.sample(A.schema.rawSchema,Object.assign(Object.assign({},E),{format:"xml"}),i)}return""})();let Y="",B=[];switch(normalizeMimeType(H)){case MediaTypes.JSON:Y=JSON.stringify(getDataRequest(J,l));break;case MediaTypes.XML:Y=J;break;case MediaTypes.URL_ENCODED:case MediaTypes.MULTIPART:Y=queryString.stringify(getDataRequest(J,l)),B=objectToHarParams(getDataRequest(J,l));break;default:Y=String(J||"")}const F=Y?{mimeType:(null==A?void 0:A.name)||MediaTypes.OCTET_STREAM,text:Y,params:B}:void 0,K=e.responses.map((e=>e.code));return{method:e.httpVerb,url:N,httpVersion:"HTTP/1.1",cookies:R,headers:M,queryString:D,postData:F,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:k,basicAuth:x,pathParameters:q,serverVariables:u,allResponseCodes:K}}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:i,options:s={},environment:n,translate:l}){try{const{skipOptionalParameters:o,withOAuth2Call:u,spec:c,generatedPayloadSamplesMaxDepth:p,store:d,activeMimeName:m}=s,v=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:i,skipOptionalParameters:o,withOAuth2Call:u,spec:c,generatedPayloadSamplesMaxDepth:p,activeMimeName:m},{environment:n,requestValues:d.requestValues,activeSecuritySchemeIds:d.activeSecuritySchemeIds}),f=new HTTPSnippet(v);return langToSnippetConfig[e]?f.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),s)):l("openapi.unsupportedLanguage","Language is not supported.")}catch(e){return console.error(e),l("openapi.failedToGenerateCodeSample","Failed to generate code sample.")}}function getSecurityData(e,t,a){var r,i,s,n,l;const o={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0},u=null==a?void 0:a.server;for(const c of(null==e?void 0:e.schemes)||[]){const e=getSecurityDetails(c.id,a),p=u&&c.serverValues&&c.serverValues[u],d={access_token:(null==p?void 0:p["x-defaultAccessToken"])||c["x-defaultAccessToken"],token_type:(null==p?void 0:p["x-defaultTokenType"])||c["x-defaultTokenType"],client_id:(null==p?void 0:p["x-defaultClientId"])||c["x-defaultClientId"],client_secret:(null==p?void 0:p["x-defaultClientSecret"])||c["x-defaultClientSecret"]},m=(null==p?void 0:p["x-defaultUsername"])||c["x-defaultUsername"],v=(null==p?void 0:p["x-defaultPassword"])||c["x-defaultPassword"],f=p&&"scopes"in p?p.scopes||[]:c.scopes||[];switch(c.type){case"openIdConnect":null===(r=o.securityHeaders)||void 0===r||r.push({name:"Authorization",value:d.access_token?`${d.token_type||"Bearer"} ${d.access_token}`:e.token?`${d.token_type||e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=d.access_token?`${d.token_type||"Bearer"} ${d.access_token}`:e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";c.flows.clientCredentials&&t?o.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(c.flows.clientCredentials,f,Object.assign(Object.assign({},e),{client_id:d.client_id||e.client_id,client_secret:d.client_secret||e.client_secret}))):c.flows.password&&t&&o.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(c.flows.password,f,Object.assign(Object.assign({},e),{client_id:d.client_id||e.client_id,client_secret:d.client_secret||e.client_secret}))),null===(i=o.securityHeaders)||void 0===i||i.push({name:"Authorization",value:a});break}case"apiKey":{const t=d.access_token||e.raw||"YOUR_API_KEY_HERE";"header"===c.in&&(null===(s=o.securityHeaders)||void 0===s||s.push({name:c.name,value:t})),"cookie"===c.in&&o.securityCookies.push({name:c.name,value:t}),"query"===c.in&&o.securityQueries.push({name:c.name,value:t});break}case"http":if("basic"===c.scheme)o.basicAuth={username:m||e.username||`<${StringUtility.toSnakeCase("Username")}>`,password:v||e.password||`<${StringUtility.toSnakeCase("Password")}>`};else{const t=(null==d?void 0:d.access_token)||(null===(n=e.token)||void 0===n?void 0:n.access_token)||`<YOUR_${c.bearerFormat||"TOKEN"}_HERE>`;null===(l=o.securityHeaders)||void 0===l||l.push({name:"Authorization",value:`${capitalizeFirst(c.scheme||"bearer")} ${t}`})}}}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:[]}}export function getDataRequest(e,t){if(e){if(isObject(e))return Object.keys(e).length>0&&0===Object.keys(t).length?e: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,i]of Object.entries(e)){const s=t?`${t}[${r}]`:r;if("object"==typeof i&&null!==i)a.push(...objectToHarParams(i,s));else{const r=Array.isArray(e)&&"string"==typeof i&&t?t:s;a.push({name:r,value:String(i)})}}return a}export function isDefined(e){return void 0!==e}export function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}function populateXmlSchemaFields(e,t){if(!e||"object"!=typeof e||!t||"object"!=typeof t)return e;const a=JSON.parse(JSON.stringify(e));return function e(t,a){if(t&&a&&"object"==typeof t&&"object"==typeof a&&t.properties)for(const r in t.properties)if(void 0!==a[r]){const i=t.properties[r],s=a[r];if("object"!==i.type||"object"!=typeof s||Array.isArray(s))if("array"===i.type&&Array.isArray(s)&&s.length>0){const t=s[0];i.items&&i.items.properties&&e(i.items,t)}else i.example=s;else e(i,s)}}(a,t),a}
+//# sourceMappingURL=generator.js.map