@redocly/openapi-docs 3.0.0-alpha.10 → 3.0.0-alpha.12

package/lib/models/MediaContent.js

@@ -0,0 +1,2 @@
+"use strict";var __decorate=this&&this.__decorate||function(e,t,i,a){var o,r=arguments.length,n=r<3?t:null===a?a=Object.getOwnPropertyDescriptor(t,i):a;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,i,a);else for(var l=e.length-1;l>=0;l--)(o=e[l])&&(n=(r<3?o(n):r>3?o(t,i,n):o(t,i))||n);return r>3&&n&&Object.defineProperty(t,i,n),n};Object.defineProperty(exports,"__esModule",{value:!0}),exports.MediaContentModel=void 0;const mobx_1=require("mobx"),utils_1=require("../utils"),MediaType_1=require("./MediaType");class MediaContentModel{constructor(e,t,i,a,{operation:o,type:r,response:n}={}){Object.defineProperty(this,"isRequestType",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"mediaTypes",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"operation",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),this.operation=o,a.unstable_ignoreMimeParameters&&(t=(0,utils_1.mergeSimilarMediaTypes)(t)),this.mediaTypes=Object.keys(t).map((l=>{const s=t[l];return new MediaType_1.MediaTypeModel(e,l,i,s,a,{operation:o,type:r,response:n})}))}activate(e){var t;null===(t=this.operation)||void 0===t||t.activateMimeName(e)}activateExampleName(e){var t,i,a,o,r;if(null===(t=this.operation)||void 0===t||t.activateExampleName(e),e&&this.active.examples&&(null===(i=this.active.schema)||void 0===i?void 0:i.oneOf)&&Object.keys(this.active.examples).includes(e)){const t=null===(o=null===(a=this.active.schema)||void 0===a?void 0:a.oneOf)||void 0===o?void 0:o.findIndex((t=>t.title===e));-1!==t&&(null===(r=this.active.schema)||void 0===r||r.activateOneOf(t))}}get active(){return this.mediaTypes.find((e=>{var t;return e.name===(null===(t=this.operation)||void 0===t?void 0:t.activeMimeName)}))||this.mediaTypes[0]}get hasSample(){return this.mediaTypes.filter((e=>!!e.examples)).length>0}}__decorate([mobx_1.action],MediaContentModel.prototype,"activate",null),__decorate([mobx_1.action],MediaContentModel.prototype,"activateExampleName",null),__decorate([mobx_1.computed],MediaContentModel.prototype,"active",null),exports.MediaContentModel=MediaContentModel;
+//# sourceMappingURL=MediaContent.js.map

package/lib/models/MediaType.d.ts

@@ -0,0 +1,27 @@
+import type { OpenAPIMediaType } from '../types';
+import type { OpenAPIParser } from '../services';
+import type { OperationModel } from './Operation';
+import type { ResponseModel } from './Response';
+import type { Options } from 'src/services/Options/types';
+import { ExampleModel } from './Example';
+import { SchemaModel } from './Schema';
+export declare class MediaTypeModel {
+    options: Options;
+    examples?: {
+        [name: string]: ExampleModel;
+    };
+    schema?: SchemaModel;
+    name: string;
+    isRequestType: boolean;
+    onlyRequiredInSamples: boolean;
+    operation?: OperationModel;
+    /**
+     * @param isRequestType needed to know if skipe RO/RW fields in objects
+     */
+    constructor(parser: OpenAPIParser, name: string, isRequestType: boolean, info: OpenAPIMediaType, options: Options, { operation, type, response, }?: {
+        operation?: OperationModel;
+        type?: 'request' | 'response';
+        response?: ResponseModel;
+    });
+    generateExample(parser: OpenAPIParser, info: OpenAPIMediaType): void;
+}

package/lib/models/MediaType.js

@@ -0,0 +1,2 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,i,t,a){void 0===a&&(a=t);var r=Object.getOwnPropertyDescriptor(i,t);r&&!("get"in r?!i.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return i[t]}}),Object.defineProperty(e,a,r)}:function(e,i,t,a){void 0===a&&(a=t),e[a]=i[t]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,i){Object.defineProperty(e,"default",{enumerable:!0,value:i})}:function(e,i){e.default=i}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var i={};if(null!=e)for(var t in e)"default"!==t&&Object.prototype.hasOwnProperty.call(e,t)&&__createBinding(i,e,t);return __setModuleDefault(i,e),i};Object.defineProperty(exports,"__esModule",{value:!0}),exports.MediaTypeModel=void 0;const Sampler=__importStar(require("openapi-sampler")),utils_1=require("../utils"),Example_1=require("./Example"),Schema_1=require("./Schema");class MediaTypeModel{constructor(e,i,t,a,r,{operation:l,type:s,response:o}={}){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"examples",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"schema",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isRequestType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"onlyRequiredInSamples",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"operation",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),this.name=i,this.operation=l,this.isRequestType=t,this.schema=a.schema&&new Schema_1.SchemaModel(e,a.schema,"",r,void 0,void 0,{operation:l,type:s,response:o}),this.onlyRequiredInSamples=r.onlyRequiredInSamples,void 0!==a.examples?this.examples=(0,utils_1.mapValues)(a.examples,(t=>new Example_1.ExampleModel(e,t,i,a.encoding))):void 0!==a.example?this.examples={default:new Example_1.ExampleModel(e,{value:e.deref(a.example).resolved},i,a.encoding)}:((0,utils_1.isJsonLike)(i)||(0,utils_1.isFormUrlEncoded)(i))&&this.generateExample(e,a)}generateExample(e,i){const t={skipReadOnly:this.isRequestType,skipWriteOnly:!this.isRequestType,skipNonRequired:this.isRequestType&&this.onlyRequiredInSamples,maxSampleDepth:this.options.generatedPayloadSamplesMaxDepth};if(this.schema&&this.schema.oneOf){this.examples={};for(const a of this.schema.oneOf){const r=Sampler.sample(a.rawSchema,t,e.definition);this.schema.discriminatorProp&&"object"==typeof r&&r&&(r[this.schema.discriminatorProp]=a.title),this.examples[a.title]=new Example_1.ExampleModel(e,{value:r},this.name,i.encoding)}}else this.schema&&(this.examples={default:new Example_1.ExampleModel(e,{value:Sampler.sample(i.schema,t,e.definition)},this.name,i.encoding)})}}exports.MediaTypeModel=MediaTypeModel;
+//# sourceMappingURL=MediaType.js.map

package/lib/models/Operation.d.ts

@@ -0,0 +1,92 @@
+import type { IMenuItem, ExtendedOpenAPIOperation, Unstable_ExternalCodeSample, OpenAPIParser, Options } from '../services';
+import type { OpenAPIExternalDocumentation, OpenAPIServer, OpenAPIXCodeSample, Server } from '../types';
+import type { MediaContentModel } from './MediaContent';
+import type { GroupModel } from './Group';
+import type { ContentItemModel } from './types';
+import { CallbackModel } from './Callback';
+import { FieldModel } from './Field';
+import { RequestBodyModel } from './RequestBody';
+import { ResponseModel } from './Response';
+import { SecurityRequirementModel } from './SecurityRequirement';
+export interface Sample {
+    lang: string;
+    label?: string;
+}
+export interface XPayloadSample extends Sample {
+    lang: 'payload';
+    requestBodyContent: MediaContentModel;
+    source: string;
+}
+export declare function isPayloadSample(sample: XPayloadSample | OpenAPIXCodeSample | Unstable_ExternalCodeSample): sample is XPayloadSample;
+/**
+ * Operation model ready to be used by components
+ */
+export declare class OperationModel implements IMenuItem {
+    private parser;
+    operationDefinition: ExtendedOpenAPIOperation;
+    private options;
+    id: string;
+    absoluteIdx?: number;
+    name: string;
+    description?: string;
+    href?: string;
+    type: "operation";
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    items: ContentItemModel[];
+    depth: number;
+    ready?: boolean;
+    active: boolean;
+    expanded: boolean;
+    activeMimeName?: string;
+    activeExampleName?: string | false;
+    activeServer: Server;
+    requestValues?: {
+        [field: string]: any;
+    };
+    defaultExampleName?: string | false;
+    defaultMimeType?: string;
+    pointer: string;
+    operationId?: string;
+    httpVerb: string;
+    deprecated: boolean;
+    path: string;
+    servers: OpenAPIServer[];
+    security: SecurityRequirementModel[];
+    extensions: GenericObject;
+    isCallback: boolean;
+    isWebhook: boolean;
+    isEvent: boolean;
+    constructor(parser: OpenAPIParser, operationDefinition: ExtendedOpenAPIOperation, parent: GroupModel | undefined, options: Options, isCallback?: boolean);
+    /**
+     * set operation as active (used by side menu)
+     */
+    activate(): void;
+    /**
+     * set operation as inactive (used by side menu)
+     */
+    deactivate(): void;
+    /**
+     * Toggle expansion in middle panel (for callbacks, which are operations)
+     */
+    toggle(): void;
+    activateMimeName(name?: string): void;
+    activateExampleName(name?: string): void;
+    expand(): void;
+    collapse(): void;
+    get requestBody(): RequestBodyModel | undefined;
+    get payload(): XPayloadSample | undefined;
+    get hasSamples(): boolean;
+    get definitionSamples(): Array<OpenAPIXCodeSample | Unstable_ExternalCodeSample>;
+    get allCodeSamples(): Array<Unstable_ExternalCodeSample | OpenAPIXCodeSample>;
+    get parameters(): FieldModel[];
+    get responses(): ResponseModel[];
+    get callbacks(): CallbackModel[];
+    get hideTryItPanel(): boolean;
+    setActiveServer(activeServer: Server): void;
+    setRequestValues(values: {
+        [field: string]: any;
+    }): void;
+    private mergeInMockServer;
+    private generateCodeSamples;
+}

package/lib/models/Operation.js

@@ -0,0 +1,2 @@
+"use strict";var __decorate=this&&this.__decorate||function(e,t,i,r){var o,a=arguments.length,l=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,i):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)l=Reflect.decorate(e,t,i,r);else for(var n=e.length-1;n>=0;n--)(o=e[n])&&(l=(a<3?o(l):a>3?o(t,i,l):o(t,i))||l);return a>3&&l&&Object.defineProperty(t,i,l),l};Object.defineProperty(exports,"__esModule",{value:!0}),exports.OperationModel=exports.isPayloadSample=void 0;const mobx_1=require("mobx"),utils_1=require("../utils"),utils_2=require("../components/rightPanel/utils"),Callback_1=require("./Callback"),Field_1=require("./Field"),RequestBody_1=require("./RequestBody"),Response_1=require("./Response"),SecurityRequirement_1=require("./SecurityRequirement"),services_1=require("../services");function isPayloadSample(e){return"payload"===e.lang&&"requestBodyContent"in e}exports.isPayloadSample=isPayloadSample;let isCodeSamplesWarningPrinted=!1;class OperationModel{constructor(e,t,i,r,o=!1){var a,l;Object.defineProperty(this,"parser",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"operationDefinition",{enumerable:!0,configurable:!0,writable:!0,value:t}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"absoluteIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"href",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:"operation"}),Object.defineProperty(this,"parent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"depth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"ready",{enumerable:!0,configurable:!0,writable:!0,value:!0}),Object.defineProperty(this,"active",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"activeMimeName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeExampleName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeServer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"requestValues",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"defaultExampleName",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"defaultMimeType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"pointer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"operationId",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"httpVerb",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"deprecated",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"path",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"servers",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"security",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"extensions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isCallback",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isWebhook",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isEvent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),(0,mobx_1.makeObservable)(this),this.pointer=t.pointer,this.description=t.description,this.parent=i,this.externalDocs=t.externalDocs,this.deprecated=!!t.deprecated,this.httpVerb=t.httpVerb,this.deprecated=!!t.deprecated,this.operationId=t.operationId,this.path=t.pathName,this.isCallback=o,this.isWebhook=t.isWebhook,this.isEvent=this.isCallback||this.isWebhook,this.name=(0,utils_1.getOperationSummary)(t),this.defaultExampleName=t.defaultSampleName;const n=null===(l=null===(a=this.requestBody)||void 0===a?void 0:a.content)||void 0===l?void 0:l.mediaTypes,[s]=n||[],[p]=Object.keys((null==s?void 0:s.examples)||[]);this.activeExampleName=!1!==t.defaultSampleName&&(t.defaultSampleName||p),this.defaultMimeType=t.defaultMimeType;const d=null==n?void 0:n.find((e=>e.name===t.defaultMimeType));if(this.activeMimeName=(null==d?void 0:d.name)||(null==s?void 0:s.name),this.isCallback)this.security=(t.security||[]).map((t=>new SecurityRequirement_1.SecurityRequirementModel(t,e))),this.servers=(0,utils_1.normalizeServers)("",t.servers||t.pathServers||[]);else{this.id=(0,utils_1.sanitizeItemId)(void 0!==t.operationId?"operation/"+t.operationId:void 0!==i?i.id+this.pointer:this.pointer),this.security=(t.security||e.definition.security||[]).map((t=>new SecurityRequirement_1.SecurityRequirementModel(t,e)));const o=this.mergeInMockServer(t.servers||t.pathServers||e.definition.servers||[],r.mockServer);this.servers=(0,utils_1.normalizeServers)(e.definitionUrl,o)}r.showExtensions&&(this.extensions=(0,utils_1.extractExtensions)(t,r.showExtensions)),this.activeServer=(0,utils_2.getInitialServerWithVariables)(this.servers)}activate(){this.active=!0}deactivate(){this.active=!1}toggle(){this.expanded=!this.expanded}activateMimeName(e){this.activeMimeName=e}activateExampleName(e){this.activeExampleName=e}expand(){this.parent&&this.parent.expand()}collapse(){}get requestBody(){return this.operationDefinition.requestBody&&new RequestBody_1.RequestBodyModel({parser:this.parser,infoOrRef:this.operationDefinition.requestBody,options:this.options,operation:this,isEvent:this.isEvent})}get payload(){var e;const t=null===(e=this.requestBody)||void 0===e?void 0:e.content;return(null==t?void 0:t.hasSample)?{lang:"payload",label:"Payload",source:"",requestBodyContent:t}:void 0}get hasSamples(){var e,t;return(null===(t=null===(e=this.requestBody)||void 0===e?void 0:e.content)||void 0===t?void 0:t.hasSample)||this.definitionSamples.length>0}get definitionSamples(){const e=this.operationDefinition["x-codeSamples"]||this.operationDefinition["x-code-samples"]||[];return this.operationDefinition["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),e}get allCodeSamples(){var e;const{payloadSampleIdx:t,hideRequestPayloadSample:i}=this.options;let r=[];if(!this.isWebhook){const t=this.options.generateCodeSamples||{},i=new Set(this.definitionSamples.map((({lang:e})=>e.toLowerCase()))),o=(null===(e=t.languages)||void 0===e?void 0:e.filter((({lang:e})=>!i.has(e.toLowerCase()))))||[];r=this.generateCodeSamples(o,t)}const o=this.definitionSamples.concat(r),a=Math.min(o.length,t);return this.payload&&!i&&o.splice(a,0,this.payload),o}get parameters(){const e=(0,utils_1.mergeParams)(this.parser,this.operationDefinition.pathParameters,this.operationDefinition.parameters).map((e=>new Field_1.FieldModel(this.parser,e,this.pointer,this.options,void 0,{operation:this,type:"request"})));return this.options.sortPropsAlphabetically?(0,utils_1.sortByField)(e,"name"):this.options.requiredPropsFirst?(0,utils_1.sortByRequired)(e):e}get responses(){let e=!1;return Object.keys(this.operationDefinition.responses||[]).filter((t=>"default"===t||("success"===(0,utils_1.getStatusCodeType)(t)&&(e=!0),(0,utils_1.isStatusCode)(t)))).map((t=>new Response_1.ResponseModel({parser:this.parser,code:t,defaultAsError:e,infoOrRef:this.operationDefinition.responses[t],options:this.options,isEvent:this.isEvent,operation:this})))}get callbacks(){return Object.keys(this.operationDefinition.callbacks||[]).map((e=>{var t;return new Callback_1.CallbackModel(this.parser,e,null===(t=this.operationDefinition.callbacks)||void 0===t?void 0:t[e],this.pointer,this.options)}))}get hideTryItPanel(){return!0===this.operationDefinition["x-hideTryItPanel"]}setActiveServer(e){this.activeServer=e}setRequestValues(e){this.requestValues=e}mergeInMockServer(e,t){if(!t)return e;const i={url:t.url,description:t.description};switch(t.position){case"first":return[i,...e];case"last":return[...e,i];case"replace":return[i];default:return e}}generateCodeSamples(e,{skipOptionalParameters:t,withOAuth2Call:i}){return e.map((({lang:e,label:r,options:o})=>({lang:e,label:r,get:r=>(0,services_1.getCodeSample)(Object.assign(Object.assign({},r),{lang:e,options:Object.assign(Object.assign({},o),{skipOptionalParameters:t,withOAuth2Call:i,spec:this.parser.definition,generatedPayloadSamplesMaxDepth:this.options.generatedPayloadSamplesMaxDepth})}))})))}}__decorate([mobx_1.observable],OperationModel.prototype,"ready",void 0),__decorate([mobx_1.observable],OperationModel.prototype,"active",void 0),__decorate([mobx_1.observable],OperationModel.prototype,"expanded",void 0),__decorate([mobx_1.observable],OperationModel.prototype,"activeMimeName",void 0),__decorate([mobx_1.observable],OperationModel.prototype,"activeExampleName",void 0),__decorate([mobx_1.observable.ref],OperationModel.prototype,"activeServer",void 0),__decorate([mobx_1.observable],OperationModel.prototype,"requestValues",void 0),__decorate([mobx_1.action],OperationModel.prototype,"activate",null),__decorate([mobx_1.action],OperationModel.prototype,"deactivate",null),__decorate([mobx_1.action],OperationModel.prototype,"toggle",null),__decorate([mobx_1.action],OperationModel.prototype,"activateMimeName",null),__decorate([mobx_1.action],OperationModel.prototype,"activateExampleName",null),__decorate([utils_1.memoize],OperationModel.prototype,"requestBody",null),__decorate([utils_1.memoize],OperationModel.prototype,"payload",null),__decorate([utils_1.memoize],OperationModel.prototype,"hasSamples",null),__decorate([utils_1.memoize],OperationModel.prototype,"definitionSamples",null),__decorate([utils_1.memoize],OperationModel.prototype,"allCodeSamples",null),__decorate([utils_1.memoize],OperationModel.prototype,"parameters",null),__decorate([utils_1.memoize],OperationModel.prototype,"responses",null),__decorate([utils_1.memoize],OperationModel.prototype,"callbacks",null),__decorate([utils_1.memoize],OperationModel.prototype,"hideTryItPanel",null),__decorate([mobx_1.action],OperationModel.prototype,"setActiveServer",null),__decorate([mobx_1.action],OperationModel.prototype,"setRequestValues",null),exports.OperationModel=OperationModel;
+//# sourceMappingURL=Operation.js.map

package/lib/models/RequestBody.d.ts

@@ -0,0 +1,18 @@
+import type { OpenAPIRequestBody, Referenced } from '../types';
+import type { OpenAPIParser, Options } from '../services';
+import type { OperationModel } from './Operation';
+import { MediaContentModel } from './MediaContent';
+type RequestBodyProps = {
+    parser: OpenAPIParser;
+    infoOrRef: Referenced<OpenAPIRequestBody>;
+    options: Options;
+    isEvent?: boolean;
+    operation?: OperationModel;
+};
+export declare class RequestBodyModel {
+    description: string;
+    required: boolean;
+    content?: MediaContentModel;
+    constructor(props: RequestBodyProps);
+}
+export {};

package/lib/models/RequestBody.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.RequestBodyModel=void 0;const utils_1=require("../utils"),MediaContent_1=require("./MediaContent");class RequestBodyModel{constructor(e){Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"required",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"content",{enumerable:!0,configurable:!0,writable:!0,value:void 0});const{parser:t,infoOrRef:o,options:i,isEvent:r,operation:n}=e,s=!r,{resolved:d}=t.deref(o);this.description=d.description||"",this.required=!!d.required;const u=(0,utils_1.getContentWithLegacyExamples)(d);void 0!==u&&(this.content=new MediaContent_1.MediaContentModel(t,u,s,i,{operation:n,type:"request"}))}}exports.RequestBodyModel=RequestBodyModel;
+//# sourceMappingURL=RequestBody.js.map

package/lib/models/Response.d.ts

@@ -0,0 +1,28 @@
+import type { OpenAPIResponse, Referenced } from '../types';
+import type { OpenAPIParser } from '../services';
+import type { OperationModel } from './Operation';
+import type { Options } from 'src/services/Options';
+import { FieldModel } from './Field';
+import { MediaContentModel } from './MediaContent';
+type ResponseProps = {
+    parser: OpenAPIParser;
+    code: string;
+    defaultAsError: boolean;
+    infoOrRef: Referenced<OpenAPIResponse>;
+    options: Options;
+    operation?: OperationModel;
+    isEvent?: boolean;
+};
+export declare class ResponseModel {
+    expanded: boolean;
+    content?: MediaContentModel;
+    code: string;
+    summary: string;
+    description: string;
+    type: string;
+    headers: FieldModel[];
+    constructor(props: ResponseProps);
+    toggle(): void;
+    expand(): void;
+}
+export {};

package/lib/models/Response.js

@@ -0,0 +1,2 @@
+"use strict";var __decorate=this&&this.__decorate||function(e,t,o,r){var i,s=arguments.length,n=s<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var a=e.length-1;a>=0;a--)(i=e[a])&&(n=(s<3?i(n):s>3?i(t,o,n):i(t,o))||n);return s>3&&n&&Object.defineProperty(t,o,n),n};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ResponseModel=void 0;const mobx_1=require("mobx"),utils_1=require("../utils"),Field_1=require("./Field"),MediaContent_1=require("./MediaContent");class ResponseModel{constructor(e){Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"content",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"code",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"summary",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headers",{enumerable:!0,configurable:!0,writable:!0,value:[]});const{parser:t,code:o,defaultAsError:r,infoOrRef:i,options:s,isEvent:n,operation:a}=e,d=!!n;(0,mobx_1.makeObservable)(this),this.expanded="all"===s.expandResponses||s.expandResponses[o];const{resolved:l}=t.deref(i);this.code=o;const p=(0,utils_1.getContentWithLegacyExamples)(l);void 0!==p&&(this.content=new MediaContent_1.MediaContentModel(t,p,d,s,{operation:a,type:"response",response:this})),void 0!==l["x-summary"]?(this.summary=l["x-summary"],this.description=l.description||""):(this.summary=l.description||"",this.description=""),this.type=(0,utils_1.getStatusCodeType)(o,r);const c=l.headers;void 0!==c&&(this.headers=Object.keys(c).map((e=>{const o=c[e];return new Field_1.FieldModel(t,Object.assign(Object.assign({},o),{name:e}),"",s,void 0,{operation:a,type:"response",response:this})})))}toggle(){this.expanded=!this.expanded}expand(){this.expanded=!0}}__decorate([mobx_1.observable],ResponseModel.prototype,"expanded",void 0),__decorate([mobx_1.action],ResponseModel.prototype,"toggle",null),__decorate([mobx_1.action],ResponseModel.prototype,"expand",null),exports.ResponseModel=ResponseModel;
+//# sourceMappingURL=Response.js.map

package/lib/models/Schema.d.ts

@@ -0,0 +1,78 @@
+import type { OpenAPIExternalDocumentation, OpenAPISchema, Referenced } from '../types';
+import type { OpenAPIParser, MergedOpenAPISchema } from '../services';
+import type { OperationModel } from './Operation';
+import type { ResponseModel } from './Response';
+import type { Options } from 'src/services/Options';
+import { FieldModel } from './Field';
+export type Deps = {
+    parentFieldFullPath?: string;
+    operation?: OperationModel;
+    type?: 'request' | 'response';
+    response?: ResponseModel;
+    in?: string;
+};
+export declare class SchemaModel {
+    private parser;
+    private options;
+    private refsStack;
+    private deps;
+    pointer: string;
+    type: string | string[];
+    displayType: string;
+    typePrefix: string;
+    title: string;
+    description: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    isPrimitive: boolean;
+    isCircular: boolean;
+    format?: string;
+    displayFormat?: string;
+    nullable: boolean;
+    deprecated: boolean;
+    pattern?: string;
+    example?: any;
+    enum: any[];
+    default?: any;
+    readOnly: boolean;
+    writeOnly: boolean;
+    constraints: string[];
+    private _fields?;
+    items?: SchemaModel;
+    oneOf?: SchemaModel[];
+    oneOfType: string;
+    discriminatorProp: string;
+    activeOneOf: number;
+    rawSchema: OpenAPISchema;
+    schema: MergedOpenAPISchema;
+    extensions?: GenericObject;
+    'x-enumDescriptions': {
+        [name: string]: string;
+    };
+    const: any;
+    contentEncoding?: string;
+    contentMediaType?: string;
+    minItems?: number;
+    maxItems?: number;
+    /**
+     * @param parser
+     * @param schemaOrRef
+     * @param pointer
+     * @param options - normalized options
+     * @param isChild if schema discriminator Child
+     * When true forces dereferencing in allOfs even if circular
+     * @param refsStack - $ref stack leading to this Schema, used for circular resolution
+     * @param deps - items depth
+     */
+    constructor(parser: OpenAPIParser, schemaOrRef: Referenced<OpenAPISchema>, pointer: string, options: Options, isChild?: boolean, refsStack?: string[], deps?: Deps);
+    /**
+     * Set specified alternative schema as active
+     * @param idx oneOf index
+     */
+    activateOneOf(idx: number): void;
+    hasType(type: string): boolean;
+    get fields(): FieldModel[] | undefined;
+    init(parser: OpenAPIParser, isChild: boolean): void;
+    private initOneOf;
+    private initDiscriminator;
+    private initConditionalOperators;
+}

package/lib/models/Schema.js

@@ -0,0 +1,2 @@
+"use strict";var __decorate=this&&this.__decorate||function(e,i,t,r){var s,n=arguments.length,a=n<3?i:null===r?r=Object.getOwnPropertyDescriptor(i,t):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)a=Reflect.decorate(e,i,t,r);else for(var o=e.length-1;o>=0;o--)(s=e[o])&&(a=(n<3?s(a):n>3?s(i,t,a):s(i,t))||a);return n>3&&a&&Object.defineProperty(i,t,a),a},__rest=this&&this.__rest||function(e,i){var t={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&i.indexOf(r)<0&&(t[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var s=0;for(r=Object.getOwnPropertySymbols(e);s<r.length;s++)i.indexOf(r[s])<0&&Object.prototype.propertyIsEnumerable.call(e,r[s])&&(t[r[s]]=e[r[s]])}return t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SchemaModel=void 0;const mobx_1=require("mobx"),OpenAPIParser_1=require("../services/OpenAPIParser"),utils_1=require("../utils"),services_1=require("../services"),Field_1=require("./Field");class SchemaModel{constructor(e,i,t,r,s=!1,n=[],a={}){Object.defineProperty(this,"parser",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"refsStack",{enumerable:!0,configurable:!0,writable:!0,value:n}),Object.defineProperty(this,"deps",{enumerable:!0,configurable:!0,writable:!0,value:a}),Object.defineProperty(this,"pointer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"displayType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"typePrefix",{enumerable:!0,configurable:!0,writable:!0,value:""}),Object.defineProperty(this,"title",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isPrimitive",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isCircular",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"format",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"displayFormat",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"nullable",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"deprecated",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"pattern",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"example",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"enum",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"default",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"readOnly",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"writeOnly",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"constraints",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_fields",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"oneOf",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"oneOfType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"discriminatorProp",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeOneOf",{enumerable:!0,configurable:!0,writable:!0,value:0}),Object.defineProperty(this,"rawSchema",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"schema",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"extensions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"x-enumDescriptions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"const",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"contentEncoding",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"contentMediaType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"minItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"maxItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),(0,mobx_1.makeObservable)(this),this.pointer=i.$ref||t||"";const{resolved:o,refsStack:l}=e.deref(i,n,!0);this.refsStack=(0,OpenAPIParser_1.pushRef)(l,this.pointer),this.rawSchema=o,this.schema=e.mergeAllOf(this.rawSchema,this.pointer,this.refsStack),this.init(e,s),r.showExtensions&&(this.extensions=(0,utils_1.extractExtensions)(this.schema,r.showExtensions))}activateOneOf(e){var i,t;this.activeOneOf=e;const r=null===(i=this.oneOf)||void 0===i?void 0:i[e].title;r&&(null===(t=this.deps.operation)||void 0===t||t.activateExampleName(r))}hasType(e){return this.type===e||Array.isArray(this.type)&&this.type.includes(e)}get fields(){if(!this.isCircular)return!this._fields&&this.hasType("object")&&(this._fields=buildFields(this.parser,this.schema,this.pointer,this.options,this.refsStack,this.deps)),this._fields}init(e,i){var t,r,s,n,a,o,l,d;const p=this.schema;if(this.isCircular=!!p["x-circular-ref"],this.title=p.title||(0,utils_1.isNamedDefinition)(this.pointer)&&utils_1.JsonPointer.baseName(this.pointer)||"",this.description=p.description||"",this.type=p.type||(0,utils_1.detectType)(p),this.format=p.format,this.enum=p.enum||[],this["x-enumDescriptions"]=p["x-enumDescriptions"],this.example=p.example,this.deprecated=!!p.deprecated,this.pattern=p.pattern,this.externalDocs=p.externalDocs,this.constraints=(0,utils_1.humanizeConstraints)(p),this.displayFormat=this.format,this.isPrimitive=(0,utils_1.isPrimitiveType)(p,this.type),this.default=p.default,this.readOnly=!!p.readOnly,this.writeOnly=!!p.writeOnly,this.const=p.const||"",this.contentEncoding=p.contentEncoding,this.contentMediaType=p.contentMediaType,this.minItems=p.minItems,this.maxItems=p.maxItems,(p.nullable||p["x-nullable"])&&(Array.isArray(this.type)&&!this.type.some((e=>null===e||"null"===e))?this.type=[...this.type,"null"]:Array.isArray(this.type)||null===this.type&&"null"===this.type||(this.type=[this.type,"null"])),this.displayType=Array.isArray(this.type)?this.type.map((e=>null===e?"null":e)).join(" or "):this.type,!this.isCircular)if(p.if&&p.then||p.if&&p.else)this.initConditionalOperators(p,e);else if(i||void 0===getDiscriminator(p)){if(i&&Array.isArray(p.oneOf)&&p.oneOf.find((e=>e.$ref===this.pointer))&&delete p.oneOf,void 0!==p.oneOf)return this.initOneOf(p.oneOf,e),this.oneOfType="One of",void(void 0!==p.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${this.pointer}`));if(void 0!==p.anyOf)return this.initOneOf(p.anyOf,e),void(this.oneOfType="Any of");if(this.hasType("array")&&(Array.isArray(p.items)||Array.isArray(p.prefixItems)?this._fields=buildFields(e,p,this.pointer,this.options,this.refsStack,this.deps):p.items&&(this.items=new SchemaModel(e,p.items,this.pointer+"/items",this.options,!1,this.refsStack,this.deps)),this.displayType=p.prefixItems||Array.isArray(p.items)?"items":(0,utils_1.pluralizeType)((null===(t=this.items)||void 0===t?void 0:t.displayType)||this.displayType),this.displayFormat=(null===(r=this.items)||void 0===r?void 0:r.format)||"",this.typePrefix=(null===(s=this.items)||void 0===s?void 0:s.typePrefix)||""+(0,services_1.l)("arrayOf"),this.title=this.title||(null===(n=this.items)||void 0===n?void 0:n.title)||"",this.isPrimitive=void 0!==(null===(a=this.items)||void 0===a?void 0:a.isPrimitive)?null===(o=this.items)||void 0===o?void 0:o.isPrimitive:this.isPrimitive,void 0===this.example&&void 0!==(null===(l=this.items)||void 0===l?void 0:l.example)&&(this.example=[this.items.example]),(null===(d=this.items)||void 0===d?void 0:d.isPrimitive)&&(this.enum=this.items.enum,this["x-enumDescriptions"]=this.items["x-enumDescriptions"]),Array.isArray(this.type))){const e=this.type.filter((e=>"array"!==e));e.length&&(this.displayType+=` or ${e.join(" or ")}`)}this.enum.length&&this.options.sortEnumValuesAlphabetically&&this.enum.sort()}else this.initDiscriminator(p,e)}initOneOf(e,i){if(this.oneOf=e.map(((e,t)=>{const{resolved:r,refsStack:s}=i.deref(e,this.refsStack,!0),n=i.mergeAllOf(r,this.pointer+"/oneOf/"+t,s),a=(0,utils_1.isNamedDefinition)(e.$ref)&&!n.title?utils_1.JsonPointer.baseName(e.$ref):`${n.title||""}${n.const&&JSON.stringify(n.const)||""}`;return new SchemaModel(i,Object.assign(Object.assign({},n),{title:a,allOf:[Object.assign(Object.assign({},this.schema),{oneOf:void 0,anyOf:void 0})],discriminator:r.allOf?void 0:n.discriminator}),e.$ref||this.pointer+"/oneOf/"+t,this.options,!1,s,Object.assign(Object.assign({},this.deps),{parentFieldFullPath:this.deps.parentFieldFullPath?this.deps.parentFieldFullPath+this.options.deepLinkSeparator+t:t.toString()}))})),this.options.simpleOneOfTypeLabel){const e=collectUniqueOneOfTypesDeep(this);this.displayType=e.join(" or ")}else this.displayType=this.oneOf.map((e=>{let i=e.typePrefix+(e.title?`${e.title} (${e.displayType})`:e.displayType);return i.indexOf(" or ")>-1&&(i=`(${i})`),i})).join(" or ")}initDiscriminator(e,i){const t=getDiscriminator(e);this.discriminatorProp=null==t?void 0:t.propertyName;const r=i.findDerived([...this.schema["x-parentRefs"]||[],this.pointer]);if(e.oneOf)for(const i of e.oneOf){if(void 0===i.$ref)continue;const e=utils_1.JsonPointer.baseName(i.$ref);r[i.$ref]=e}const s=(null==t?void 0:t.mapping)||{};let n=(null==t?void 0:t["x-explicitMappingOnly"])||!1;0===Object.keys(s).length&&(n=!1);const a={};for(const e in s){const i=s[e];Array.isArray(a[i])?a[i].push(e):a[i]=[e]}const o=n?Object.assign({},a):Object.assign(Object.assign({},r),a);let l=[];for(const e of Object.keys(o)){const i=o[e];if(Array.isArray(i))for(const t of i)l.push({$ref:e,name:t});else l.push({$ref:e,name:i})}const d=Object.keys(s);0!==d.length&&(l=l.sort(((e,i)=>{const t=d.indexOf(e.name),r=d.indexOf(i.name);return t<0&&r<0?e.name.localeCompare(i.name):t<0?1:r<0?-1:t-r}))),this.oneOf=l.map((({$ref:e,name:t},r)=>{const s=new SchemaModel(i,{$ref:e},e,this.options,!0,this.refsStack.slice(0,-1),Object.assign(Object.assign({},this.deps),{parentFieldFullPath:this.deps.parentFieldFullPath?this.deps.parentFieldFullPath+this.options.deepLinkSeparator+r:r.toString()}));return s.title=t,s}))}initConditionalOperators(e,i){const{if:t,else:r={},then:s={}}=e,n=__rest(e,["if","else","then"]),a=[{allOf:[n,s,t],title:t&&t["x-displayName"]||(null==t?void 0:t.title)||"case 1"},{allOf:[n,r],title:r&&r["x-displayName"]||(null==r?void 0:r.title)||"case 2"}];this.oneOf=a.map(((e,t)=>new SchemaModel(i,Object.assign({},e),this.pointer+"/oneOf/"+t,this.options,!1,this.refsStack,Object.assign(Object.assign({},this.deps),{parentFieldFullPath:this.deps.parentFieldFullPath?this.deps.parentFieldFullPath+this.options.deepLinkSeparator+t:t.toString()})))),this.oneOfType="One of"}}function normalizeField(e,i,t){return e||(console.warn(`Field "${i}" is invalid, skipping.\n Field must be an object but got ${typeof e} at "${t}"`),{})}function buildFields(e,i,t,r,s,n){const a=i.properties||i.prefixItems||i.items||{},o=i.patternProperties||{},l=i.additionalProperties||i.unevaluatedProperties,d=i.prefixItems?i.items:i.additionalItems,p=i.default||{};let c=Object.keys(a).map((o=>{var l;const d=normalizeField(a[o],o,t),c=void 0!==i.required&&i.required.indexOf(o)>-1;return new Field_1.FieldModel(e,{name:i.properties?o:`[${o}]`,required:c,schema:Object.assign(Object.assign({},d),{example:(null===(l=i.example)||void 0===l?void 0:l[o])||d.example,default:void 0===d.default&&p?p[o]:d.default})},t+"/properties/"+o,r,s,n)}));return r.sortPropsAlphabetically&&(c=(0,utils_1.sortByField)(c,"name")),r.requiredPropsFirst&&(c=(0,utils_1.sortByRequired)(c,r.sortPropsAlphabetically?void 0:i.required)),c.push(...Object.keys(o).map((i=>{const a=normalizeField(o[i],i,t);return new Field_1.FieldModel(e,{name:i,required:!1,schema:a,kind:"patternProperties"},`${t}/patternProperties/${i}`,r,s,n)}))),((0,utils_1.isObject)(l)||!0===l)&&c.push(new Field_1.FieldModel(e,{name:((0,utils_1.isObject)(l)&&l["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===l?{}:l,kind:"additionalProperties"},t+"/additionalProperties",r,s,n)),c.push(...buildAdditionalItems({parser:e,schema:d,fieldsCount:c.length,$ref:t,options:r,refsStack:s,deps:n})),c}function buildAdditionalItems({parser:e,schema:i=!1,fieldsCount:t,$ref:r,options:s,refsStack:n,deps:a}){return"boolean"==typeof i?i?[new Field_1.FieldModel(e,{name:`[${t}...]`,schema:{},kind:"additionalItems"},`${r}/additionalItems`,s,n,a)]:[]:Array.isArray(i)?[...i.map(((i,o)=>new Field_1.FieldModel(e,{name:`[${t+o}]`,schema:i,kind:"additionalItems"},`${r}/additionalItems/${o}`,s,n,a)))]:(0,utils_1.isObject)(i)?[new Field_1.FieldModel(e,{name:`[${t}...]`,schema:i,kind:"additionalItems"},`${r}/additionalItems`,s,n,a)]:[]}function getDiscriminator(e){return e.discriminator||e["x-discriminator"]}function collectUniqueOneOfTypesDeep(e){const i=new Set;return function e(t){for(const r of t.oneOf||[])r.oneOf?e(r):r.type&&i.add(r.type)}(e),Array.from(i.values())}__decorate([mobx_1.observable],SchemaModel.prototype,"activeOneOf",void 0),__decorate([mobx_1.action],SchemaModel.prototype,"activateOneOf",null),exports.SchemaModel=SchemaModel;
+//# sourceMappingURL=Schema.js.map

package/lib/models/SecurityRequirement.d.ts

@@ -0,0 +1,12 @@
+import type { OpenAPISecurityRequirement, OpenAPISecurityScheme } from '../types';
+import type { OpenAPIParser } from '../services';
+export interface SecurityScheme extends OpenAPISecurityScheme {
+    id: string;
+    sectionId: string;
+    scopes: string[];
+    'x-defaultClientId'?: string;
+}
+export declare class SecurityRequirementModel {
+    schemes: SecurityScheme[];
+    constructor(requirement: OpenAPISecurityRequirement, parser: OpenAPIParser);
+}

package/lib/models/SecuritySchemes.d.ts

@@ -0,0 +1,25 @@
+import type { OpenAPISecurityScheme, Referenced } from '../types';
+import type { OpenAPIParser } from '../services';
+export declare class SecuritySchemeModel {
+    id: string;
+    sectionId: string;
+    type: OpenAPISecurityScheme['type'];
+    description: string;
+    apiKey?: {
+        name: string;
+        in: OpenAPISecurityScheme['in'];
+    };
+    http?: {
+        scheme: string;
+        bearerFormat?: string;
+    };
+    flows: OpenAPISecurityScheme['flows'];
+    openId?: {
+        connectUrl: string;
+    };
+    constructor(parser: OpenAPIParser, id: string, scheme: Referenced<OpenAPISecurityScheme>);
+}
+export declare class SecuritySchemesModel {
+    schemes: SecuritySchemeModel[];
+    constructor(parser: OpenAPIParser);
+}

package/lib/models/Webhook.d.ts

@@ -0,0 +1,8 @@
+import type { OpenAPIPath, Referenced } from '../types';
+import type { OpenAPIParser, Options } from '../services';
+import { OperationModel } from './Operation';
+export declare class WebhookModel {
+    operations: OperationModel[];
+    constructor(parser: OpenAPIParser, options: Options, infoOrRef?: Referenced<OpenAPIPath>);
+    initWebhooks(parser: OpenAPIParser, webhooks: OpenAPIPath, options: Options): void;
+}

package/lib/models/Webhook.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.WebhookModel=void 0;const utils_1=require("../utils"),Operation_1=require("./Operation");class WebhookModel{constructor(e,o,t){Object.defineProperty(this,"operations",{enumerable:!0,configurable:!0,writable:!0,value:[]});const{resolved:s}=e.deref(t||{});this.initWebhooks(e,s,o)}initWebhooks(e,o,t){for(const s of Object.keys(o)){const i=o[s],r=Object.keys(i).filter(utils_1.isOperationName);for(const o of r){const s=i[o];if(i.$ref){const s=e.deref(i||{});this.initWebhooks(e,{[o]:s},t)}if(!s)continue;const r=new Operation_1.OperationModel(e,Object.assign(Object.assign({},s),{httpVerb:o}),void 0,t,!1);this.operations.push(r)}}}}exports.WebhookModel=WebhookModel;
+//# sourceMappingURL=Webhook.js.map

package/lib/models/file-upload.d.ts

@@ -8,4 +8,4 @@ export declare enum FileUploadFormats {
     BASE64 = "base64",
     BINARY = "binary"
 }
-export declare type UploadFileType = File | File[] | string | string[];
+export type UploadFileType = File | File[] | string | string[];

package/lib/models/index.d.ts

@@ -1,2 +1,17 @@
 export * from './code-sample-options';
 export * from './file-upload';
+export * from './Group';
+export * from './Operation';
+export * from './RequestBody';
+export * from './Example';
+export * from './MediaContent';
+export * from './MediaType';
+export * from './Response';
+export * from './Schema';
+export * from './Field';
+export * from './ApiInfo';
+export * from './SecuritySchemes';
+export * from './Callback';
+export * from './SecurityRequirement';
+export * from './Webhook';
+export * from './types';

package/lib/models/index.js

@@ -1,2 +1,2 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./code-sample-options"),exports),__exportStar(require("./file-upload"),exports);
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var p=Object.getOwnPropertyDescriptor(r,t);p&&!("get"in p?!r.__esModule:p.writable||p.configurable)||(p={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,p)}:function(e,r,t,o){void 0===o&&(o=t),e[o]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./code-sample-options"),exports),__exportStar(require("./file-upload"),exports),__exportStar(require("./Group"),exports),__exportStar(require("./Operation"),exports),__exportStar(require("./RequestBody"),exports),__exportStar(require("./Example"),exports),__exportStar(require("./MediaContent"),exports),__exportStar(require("./MediaType"),exports),__exportStar(require("./Response"),exports),__exportStar(require("./Schema"),exports),__exportStar(require("./Field"),exports),__exportStar(require("./ApiInfo"),exports),__exportStar(require("./SecuritySchemes"),exports),__exportStar(require("./Callback"),exports),__exportStar(require("./SecurityRequirement"),exports),__exportStar(require("./Webhook"),exports),__exportStar(require("./types"),exports);
 //# sourceMappingURL=index.js.map

package/lib/models/types.d.ts

@@ -0,0 +1,3 @@
+import type { GroupModel } from './Group';
+import type { OperationModel } from './Operation';
+export type ContentItemModel = GroupModel | OperationModel;

package/lib/models/types.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});
+//# sourceMappingURL=types.js.map

package/lib/services/MarkdownRenderer.d.ts

@@ -0,0 +1,23 @@
+import { marked } from 'marked';
+import type { MarkdownHeading, MDXComponentMeta } from './types';
+import type { Options } from './Options/types';
+export declare function buildComponentComment(name: string): string;
+export declare class MarkdownRenderer {
+    options?: Options | undefined;
+    static containsComponent(rawText: string, componentName: string): boolean;
+    static getTextBeforeHading(md: string, heading: string): string;
+    headings: MarkdownHeading[];
+    currentTopHeading: MarkdownHeading;
+    private readonly headingSectionLevel;
+    private readonly headingEnhanceRenderer;
+    private readonly originalHeadingRule;
+    parser: marked.Parser;
+    constructor(options?: Options | undefined);
+    saveHeading(name: string, level: number, container?: MarkdownHeading[], parentId?: string): MarkdownHeading;
+    flattenHeadings(container?: MarkdownHeading[]): MarkdownHeading[];
+    attachHeadingsDescriptions(rawText: string): void;
+    headingRule: (text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string, slugger: marked.Slugger) => string;
+    renderMd(rawText: string, extractHeadings?: boolean): string;
+    extractHeadings(rawText: string): MarkdownHeading[];
+    renderMdWithComponents(rawText: string): Array<string | MDXComponentMeta>;
+}

package/lib/services/MarkdownRenderer.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.MarkdownRenderer=exports.buildComponentComment=void 0;const marked_1=require("marked"),utils_1=require("../utils"),constants_1=require("../constants"),renderer=new marked_1.marked.Renderer;function buildComponentComment(e){return`\x3c!-- ReDoc-Inject: <${e}> --\x3e`}marked_1.marked.setOptions({renderer:renderer,highlight:(e,n)=>(0,utils_1.highlight)(e,n)}),exports.buildComponentComment=buildComponentComment;class MarkdownRenderer{static containsComponent(e,n){return new RegExp(constants_1.COMPONENT_REGEXP.replace(/{component}/g,n),"gmi").test(e)}static getTextBeforeHading(e,n){const r=e.search(new RegExp(`^(>\\s+#+|#+)?\\s+${n}`,"m"));return r>-1?e.substring(0,r):e}constructor(e){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"headings",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"currentTopHeading",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headingSectionLevel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headingEnhanceRenderer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"originalHeadingRule",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"parser",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headingRule",{enumerable:!0,configurable:!0,writable:!0,value:(e,n,r,t)=>{var i,s;return 1===n?this.currentTopHeading=this.saveHeading(e,n):n<=this.headingSectionLevel&&this.saveHeading(e,n,null===(i=this.currentTopHeading)||void 0===i?void 0:i.items,null===(s=this.currentTopHeading)||void 0===s?void 0:s.id),this.originalHeadingRule(e,n,r,t)}}),this.headingEnhanceRenderer=new marked_1.marked.Renderer,this.parser=new marked_1.marked.Parser,this.originalHeadingRule=this.headingEnhanceRenderer.heading.bind(this.headingEnhanceRenderer),this.headingEnhanceRenderer.heading=this.headingRule,this.headingSectionLevel=(null==e?void 0:e.markdownHeadingsAnchorLevel)||2}saveHeading(e,n,r=this.headings,t){e=(0,utils_1.unescapeHTMLChars)(e);const i={id:t?`${t}/${(0,utils_1.safeSlugify)(e)}`:`section/${(0,utils_1.safeSlugify)(e)}`,name:e,level:n,items:[]};return r.push(i),i}flattenHeadings(e){if(void 0===e)return[];const n=[];for(const r of e)n.push(r),n.push(...this.flattenHeadings(r.items));return n}attachHeadingsDescriptions(e){const n=e=>new RegExp(`##?\\s+${e.name.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&")}`),r=this.flattenHeadings(this.headings);if(r.length<1)return;let t=r[0],i=n(t),s=e.search(i);for(let a=1;a<r.length;a++){const o=r[a],d=n(o),c=e.substr(s+1).search(d)+s+1;t.description=e.substring(s,c).replace(i,"").trim(),t=o,i=d,s=c}t.description=e.substring(s).replace(i,"").trim()}renderMd(e,n=!1){const r=n?{renderer:this.headingEnhanceRenderer}:void 0;return(0,marked_1.marked)(e.toString(),r)}extractHeadings(e){this.renderMd(e,!0),this.attachHeadingsDescriptions(e);const n=this.headings;return this.headings=[],n}renderMdWithComponents(e){const n=this.options&&this.options.allowedMdComponents;if(!n||0===Object.keys(n).length)return[this.renderMd(e)];const r=Object.keys(n).join("|"),t=new RegExp(constants_1.COMPONENT_REGEXP.replace(/{component}/g,r),"mig"),i=[],s=[];let a=t.exec(e),o=0;for(;a;){i.push(e.substring(o,a.index)),o=t.lastIndex;const r=n[a[1]||a[2]||a[5]],d=a[3]||a[6],c=a[4];r&&s.push({component:r.component,propsSelector:r.propsSelector,props:Object.assign(Object.assign(Object.assign({},parseProps(d)),r.props),{children:c})}),a=t.exec(e)}i.push(e.substring(o));const d=[];for(let e=0;e<i.length;e++){const n=i[e];n&&d.push(this.renderMd(n)),s[e]&&d.push(s[e])}return d}}function parseProps(e){if(!e)return{};const n=/([\w-]+)\s*=\s*(?:{([^}]+?)}|"([^"]+?)")/gim,r={};let t;for(;null!==(t=n.exec(e));)if(t[3])r[t[1]]=t[3];else if(t[2]){let e;try{e=JSON.parse(t[2])}catch(e){}r[t[1]]=e}return r}exports.MarkdownRenderer=MarkdownRenderer;
+//# sourceMappingURL=MarkdownRenderer.js.map

package/lib/services/MenuBuilder.d.ts

@@ -0,0 +1,63 @@
+import type { OpenAPITag } from '../types';
+import type { OpenAPIParser } from './OpenAPIParser';
+import type { TagGroup, TagInfo, TagsInfoMap } from './types';
+import type { ContentItemModel } from '../models';
+import type { Options } from './Options/types';
+import { GroupModel, OperationModel } from '../models';
+export declare class MenuBuilder {
+    /**
+     * Builds page content structure based on tags
+     */
+    static buildStructure(parser: OpenAPIParser, options: Options): ContentItemModel[];
+    /**
+     * extracts items from markdown description
+     * @param description - markdown source
+     * @param parent
+     * @param initialDepth - number of items depth
+     * @param options - normalized options
+     */
+    static addMarkdownItems(description: string, parent: GroupModel | undefined, initialDepth: number, options: Options): ContentItemModel[];
+    /**
+     * Returns array of OperationsGroup items for the tag groups (x-tagGroups vendor extension)
+     * @param parser
+     * @param parent
+     * @param groups
+     * @param tags value of `x-tagGroups` vendor extension
+     * @param options - normalized options
+     */
+    static getTagGroupsItems(parser: OpenAPIParser, parent: GroupModel | undefined, groups: TagGroup[], tags: TagsInfoMap, options: Options): GroupModel[];
+    /**
+     * Returns array of OperationsGroup items for the tags of the group or for all tags
+     * @param parser
+     * @param tagsMap tags info returned from `getTagsWithOperations`
+     * @param parent parent item
+     * @param group group which this tag belongs to. if not provided gets all tags
+     * @param options - normalized options
+     */
+    static getTagsItems(parser: OpenAPIParser, tagsMap: TagsInfoMap, parent: GroupModel | undefined, group: TagGroup | undefined, options: Options): ContentItemModel[];
+    /**
+     * Returns array of schemas with reference to tag, or schemas with reference to schemaDefinitionsTagName tag
+     * @param tagsMap all tags
+     * @param tag tag to find reference of schema
+     * @param schemaDefinitionsTagName config
+     */
+    static getTagRelatedSchema({ parser, tag, parent, schemaDefinitionsTagName, }: {
+        parser: OpenAPIParser;
+        tag: TagInfo;
+        parent: GroupModel;
+        schemaDefinitionsTagName?: string;
+    }): GroupModel[];
+    /**
+     * Returns array of Operation items for the tag
+     * @param parser
+     * @param parent parent OperationsGroup
+     * @param tag tag info returned from `getTagsWithOperations`
+     * @param depth items depth
+     * @param options - normalized options
+     */
+    static getOperationsItems(parser: OpenAPIParser, parent: GroupModel | undefined, tag: TagInfo, depth: number, options: Options): OperationModel[];
+    /**
+     * collects tags and maps each tag to list of operations belonging to this tag
+     */
+    static getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;
+}

package/lib/services/MenuBuilder.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.MenuBuilder=void 0;const utils_1=require("../utils"),MarkdownRenderer_1=require("./MarkdownRenderer"),models_1=require("../models"),constants_1=require("../constants");class MenuBuilder{static buildStructure(e,t){const s=e.definition,n=[],o=[...s.tags||[]]||[];!o.find((e=>(null==e?void 0:e.name)===t.schemaDefinitionsTagName))&&t.schemaDefinitionsTagName&&o.push({name:t.schemaDefinitionsTagName});const i=MenuBuilder.getTagsWithOperations(e,o),r=s["x-tagGroups"];return n.push(...MenuBuilder.addMarkdownItems(s.info.description||"",void 0,1,t)),r&&r.length>0?n.push(...MenuBuilder.getTagGroupsItems(e,void 0,r,i,t)):n.push(...MenuBuilder.getTagsItems(e,i,void 0,void 0,t)),n}static addMarkdownItems(e,t,s,n){const o=new MarkdownRenderer_1.MarkdownRenderer(n).extractHeadings(e||"");o.length&&t&&t.description&&(t.description=MarkdownRenderer_1.MarkdownRenderer.getTextBeforeHading(t.description,o[0].name));const i=(e,t,s=1)=>t.map((t=>{const n=new models_1.GroupModel("section",t,e);return n.depth=s,t.items&&(n.items=i(n,t.items,s+1)),n}));return i(t,o,s)}static getTagGroupsItems(e,t,s,n,o){const i=[];for(const r of s){const s=new models_1.GroupModel("group",r,t);s.depth=constants_1.GROUP_DEPTH,s.items=MenuBuilder.getTagsItems(e,n,s,r,o),i.push(s)}return i}static getTagsItems(e,t,s,n,o){let i;if(i=void 0===n?Object.keys(t):n.tags,!Array.isArray(i))return console.warn("Unexpected values of tags. Check tags or x-tagGroups in your definition."),[];const r=i.map((e=>t[e]?(t[e].used=!0,t[e]):(console.warn(`Non-existing tag "${e}" is added to the group "${null==n?void 0:n.name}"`),null))),a=[];for(const t of r){if(!t)continue;const n=new models_1.GroupModel("tag",t,s);if(n.depth=constants_1.GROUP_DEPTH+1,""===t.name){const s=[...MenuBuilder.addMarkdownItems(t.description||"",n,n.depth+1,o),...this.getOperationsItems(e,void 0,t,n.depth+1,o)];a.push(...s);continue}const i=this.getTagRelatedSchema({parser:e,tag:t,parent:n,schemaDefinitionsTagName:o.schemaDefinitionsTagName});n.items=[...i,...MenuBuilder.addMarkdownItems(t.description||"",n,n.depth+1,o),...this.getOperationsItems(e,n,t,n.depth+1,o)],a.push(n)}return o.sortTagsAlphabetically&&a.sort((0,utils_1.alphabeticallyByProp)("name")),a}static getTagRelatedSchema({parser:e,tag:t,parent:s,schemaDefinitionsTagName:n}){var o;const i=n?[n]:[];return Object.entries((null===(o=e.definition.components)||void 0===o?void 0:o.schemas)||{}).map((([e,n])=>{if(!(n["x-tags"]||i).includes(t.name))return null;const o=new models_1.GroupModel("schema",{name:e,"x-displayName":`${n.title||e}`,description:`<SchemaDefinition showWriteOnly={true} schemaRef="#/components/schemas/${e}" />`,isSchema:!0,level:2},s);return o.depth=s.depth+1,o})).filter(Boolean)}static getOperationsItems(e,t,s,n,o){if(0===s.operations.length)return[];const i=[];for(const r of s.operations){const s=new models_1.OperationModel(e,r,t,o);s.depth=n,i.push(s)}return o.sortOperationsAlphabetically&&i.sort((0,utils_1.alphabeticallyByProp)("name")),i}static getTagsWithOperations(e,t){const s={},{definition:n}=e,o=n["x-webhooks"]||n.webhooks;for(const e of t||[])s[e.name]=Object.assign(Object.assign({},e),{operations:[]});function i(e,t,n){for(const o of Object.keys(t||{})){const r=t[o],a=Object.keys(r).filter(utils_1.isOperationName);for(const t of a){const a=r[t];if(r.$ref){const{resolved:t}=e.deref(r);i(e,{[o]:t},n);continue}let d=null==a?void 0:a.tags;d&&d.length||(d=[""]);for(const e of d){let i=s[e];void 0===i&&(i={name:e,operations:[]},s[e]=i),i["x-traitTag"]||i.operations.push(Object.assign(Object.assign({},a),{pathName:o,pointer:utils_1.JsonPointer.compile(["paths",o,t]),httpVerb:t,pathParameters:r.parameters||[],pathServers:r.servers,isWebhook:!!n}))}}}}return n.paths&&i(e,n.paths),o&&i(e,o,!0),s}}exports.MenuBuilder=MenuBuilder;
+//# sourceMappingURL=MenuBuilder.js.map

package/lib/services/OpenAPIParser.d.ts

@@ -0,0 +1,51 @@
+import type { OpenAPIRef, OpenAPIDefinition } from '../types';
+import type { MergedOpenAPISchema } from './types';
+import type { Options } from './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);
+    validate(spec: GenericObject): void;
+    preprocess(spec: OpenAPIDefinition): 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 forceCircular whether to dereference even if it is circular ref
+     * @param mergeAsAllOf
+     */
+    deref<T>(obj: OpenAPIRef | T, baseRefsStack?: string[], mergeAsAllOf?: boolean): {
+        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 forceCircular whether to dereference children even if it is a circular ref
+     * @param used$Refs
+     */
+    mergeAllOf(schema: MergedOpenAPISchema, $ref: string | undefined, refsStack: string[]): 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;
+}