@redocly/openapi-docs 3.0.0-alpha.14.beta.2 → 3.0.0-alpha.14.beta.3

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

@@ -0,0 +1,38 @@
+import type { RouterType } from '../types';
+export interface RoutingProps {
+    /**
+     * Only applies when using `history`-based routing. (See the `router` prop.) Specifies the base path under which
+     * all API component controlled pages are located. The host must route any location under this path to the API component.
+     */
+    basePath?: string;
+    /**
+     * Only applies when using `static`-based routing. (See the `router` prop.) Specifies the current static path
+     * that is being rendered by the StaticRouter, which allows us to properly render the currently active route
+     * on the server and already render the content instead of sending an empty page to the client.
+     */
+    staticRouterPath?: string;
+    /**
+     * Which routing solution to use when the user navigates using the table of contents.
+     * Only applies when using the *sidebar* layout.
+     *
+     * - **`history`** - The table of contents pushes entries onto the navigation stack, e.g. `location.pushState`.
+     *   This requires that the host routes any location under `basePath` (see `basePath` prop) to the API component.
+     * - **`hash`** - Navigation happens using hash-fragments (`/some/page#these-fragments-here`).
+     *   This still allows the user to link to individual pages without requiring the more complex routing setup `history` needs.
+     * - **`memory`** - Internal navigation does not change the host `location` at all.
+     *   This works in every scenario, but it lacks the important feature of being able to link to individual pages.
+     * - **`static`** - Renders a single static page for the provided `staticRouterPath`.
+     *   This can be used when the page is being rendered on the server (either SSR or SSG) to pre-generate the
+     *   markup of the page, which can be rehydrated on the client. This can reduce the amount of time spent rendering
+     *   the page on the client.
+     *
+     *   @default "history"
+     */
+    router?: RouterType;
+    /**
+     * Either uses the app's own or the parent router ex. (Portal).
+     *
+     *   @default true
+     */
+    enableRouter?: boolean;
+}

package/lib-esm/hoc/types.js

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

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

@@ -0,0 +1,2 @@
+import type * as React from 'react';
+export declare function getDisplayName<T>(WrappedComponent: React.ComponentType<T>): string;

package/lib-esm/hoc/utils.js

@@ -0,0 +1,2 @@
+export function getDisplayName(e){return e.displayName||e.name||"Component"}
+//# sourceMappingURL=utils.js.map

package/lib-esm/hoc/withRouter.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { RoutingProps } from './types';
+export declare function withRouter<P extends RoutingProps>(WrappedComponent: React.ComponentType<Omit<P, 'enableRouter'>>): React.FC<P>;

package/lib-esm/hoc/withRouter.js

@@ -0,0 +1,2 @@
+var __rest=this&&this.__rest||function(e,t){var r={};for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var a=0;for(o=Object.getOwnPropertySymbols(e);a<o.length;a++)t.indexOf(o[a])<0&&Object.prototype.propertyIsEnumerable.call(e,o[a])&&(r[o[a]]=e[o[a]])}return r};import React from"react";import{useRouter}from"../hooks";import{getDisplayName}from"./utils";import{IS_BROWSER}from"../utils";export function withRouter(e){const t=t=>{var r,o,{enableRouter:a=!0}=t,n=__rest(t,["enableRouter"]);const s=null!==(r=n.basePath)&&void 0!==r?r:"/",i=null!==(o=n.router)&&void 0!==o?o:"history",{Router:l,routerProps:u}=useRouter(i,s);return IS_BROWSER&&a?React.createElement(l,Object.assign({},u,{key:s}),React.createElement(e,Object.assign({},n))):React.createElement(e,Object.assign({},n))};return t.displayName=`WithRouter(${getDisplayName(e)})`,t}
+//# sourceMappingURL=withRouter.js.map

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

@@ -1,2 +1,6 @@
 export { useDimensions } from './useDimensions';
 export { usePrevious } from './usePrevious';
+export { useLicense } from './useLicense';
+export { useActivateExample } from './useActivateExample';
+export { useRouter } from './useRouter';
+export { useContentItems } from './useContentItems';

package/lib-esm/hooks/index.js

@@ -1,2 +1,2 @@
-export{useDimensions}from"./useDimensions";export{usePrevious}from"./usePrevious";
+export{useDimensions}from"./useDimensions";export{usePrevious}from"./usePrevious";export{useLicense}from"./useLicense";export{useActivateExample}from"./useActivateExample";export{useRouter}from"./useRouter";export{useContentItems}from"./useContentItems";
 //# sourceMappingURL=index.js.map

package/lib-esm/hooks/useActivateExample.d.ts

@@ -0,0 +1,2 @@
+import type { MediaContentModel } from '../models';
+export declare function useActivateExample(mediaContent?: MediaContentModel): (key: string) => void;

package/lib-esm/hooks/useActivateExample.js

@@ -0,0 +1,2 @@
+import{useCallback}from"react";import{useSetRecoilState}from"recoil";import{getActiveMediaType}from"../models";import{operationStore}from"../recoil/operation";export function useActivateExample(e){const i=useSetRecoilState(operationStore((null==e?void 0:e.operation.pointer)||"no_operation_pointer")),o=e?getActiveMediaType(e):void 0;return useCallback((e=>{var t,a,l;if(o)if(o.examples&&(null===(t=o.schema)||void 0===t?void 0:t.oneOf)&&Object.keys(o.examples).includes(e)){const t=null===(l=null===(a=o.schema)||void 0===a?void 0:a.oneOf)||void 0===l?void 0:l.findIndex((i=>i.title===e));i((e=>{var i,a,l;return Object.assign(Object.assign({},e),{activeOneOf:t,activeExampleName:(null===(l=null===(a=null===(i=o.schema)||void 0===i?void 0:i.oneOf)||void 0===a?void 0:a[t])||void 0===l?void 0:l.title)||e.activeExampleName})}))}else i((i=>Object.assign(Object.assign({},i),{activeExampleName:e})))}),[o,i])}
+//# sourceMappingURL=useActivateExample.js.map

package/lib-esm/hooks/useContentItems.d.ts

@@ -0,0 +1,12 @@
+import type { ContentItemModel } from '../models';
+import type { ExtendedMenuItem, IMenuItem, OpenAPIParser, Options } from '../services';
+type UseContentItemsInput = {
+    parser: OpenAPIParser;
+    options: Options;
+};
+type UseContentItemsReturnType = {
+    contentItems: ContentItemModel[];
+    flatItems: (ExtendedMenuItem & IMenuItem)[];
+};
+export declare const useContentItems: ({ options, parser, }: UseContentItemsInput) => UseContentItemsReturnType;
+export {};

package/lib-esm/hooks/useContentItems.js

@@ -0,0 +1,2 @@
+import{useMemo}from"react";import{buildContentItems}from"../services";export const useContentItems=({options:t,parser:e})=>{const{contentItems:o,flatItems:s}=useMemo((()=>buildContentItems(e,t)),[t,e]);return{flatItems:s,contentItems:o}};
+//# sourceMappingURL=useContentItems.js.map

package/lib-esm/hooks/useLicense.d.ts

@@ -0,0 +1,5 @@
+import type { LicenseInfo } from '../services/check';
+export declare function useLicense(licenceKey?: string): {
+    licenseInfo: LicenseInfo;
+    isValid: boolean;
+};

package/lib-esm/hooks/useLicense.js

@@ -0,0 +1,2 @@
+var __awaiter=this&&this.__awaiter||function(e,n,t,i){return new(t||(t=Promise))((function(o,c){function a(e){try{s(i.next(e))}catch(e){c(e)}}function r(e){try{s(i.throw(e))}catch(e){c(e)}}function s(e){var n;e.done?o(e.value):(n=e.value,n instanceof t?n:new t((function(e){e(n)}))).then(a,r)}s((i=i.apply(e,n||[])).next())}))};import{useState,useEffect}from"react";import parseToken from"../services/check";export function useLicense(e){const[n,t]=useState("development"===process.env.NODE_ENV?{valid:!0,allowed:!0}:{});return useEffect((()=>{!function(){__awaiter(this,void 0,void 0,(function*(){const n=yield parseToken(e);t(n)}))}()}),[e]),{licenseInfo:n,isValid:isValidLicense(n)}}function isValidLicense(e){return e.valid&&e.allowed&&!e.expired||!!e.local}
+//# sourceMappingURL=useLicense.js.map

package/lib-esm/hooks/useRouter.d.ts

@@ -0,0 +1,11 @@
+import type * as React from 'react';
+import type { RouterType } from '../types';
+interface RouterProps {
+    basename?: string;
+    location?: string;
+}
+export declare const useRouter: (router: RouterType, basePath: string) => {
+    Router: React.ComponentType<{}>;
+    routerProps: RouterProps;
+};
+export {};

package/lib-esm/hooks/useRouter.js

@@ -0,0 +1,2 @@
+import{BrowserRouter,HashRouter,MemoryRouter}from"react-router-dom";const RouterComponent={history:BrowserRouter,memory:MemoryRouter,hash:HashRouter};export const useRouter=(o,r)=>({Router:RouterComponent[o],routerProps:Object.assign({},"memory"!==o&&{basename:r})});
+//# sourceMappingURL=useRouter.js.map

package/lib-esm/index.d.ts

@@ -5,6 +5,7 @@ export * from './events/index';
 export * from './constants';
 export { setSecurityDetails, setSecurityDetailsVariants, setParameterValue, isOperationName, JsonPointer, } from './utils';
 export type { SecurityDetails, OpenAPIDefinition, OpenAPIOperation, OpenAPIParameterLocation, OpenAPISchema, } from './types';
-export type { OpenAPIParser } from './services';
+export { OpenAPIParser } from './services';
+export { buildContentItems, normalizeOptions } from './services';
 export type { OAuth2 } from './services/OAuth2';
 export type { OpenApiResponseData } from './components/rightPanel/types';

package/lib-esm/index.js

@@ -1,2 +1,2 @@
-export*from"./components/index";export*from"./services/index";export*from"./models/index";export*from"./events/index";export*from"./constants";export{setSecurityDetails,setSecurityDetailsVariants,setParameterValue,isOperationName,JsonPointer}from"./utils";
+export*from"./components/index";export*from"./services/index";export*from"./models/index";export*from"./events/index";export*from"./constants";export{setSecurityDetails,setSecurityDetailsVariants,setParameterValue,isOperationName,JsonPointer}from"./utils";export{OpenAPIParser}from"./services";export{buildContentItems,normalizeOptions}from"./services";
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,5 @@
+import type { Options } from 'src/services/Options';
+import type { OpenAPIParser } from 'src/services/OpenAPIParser';
+import type { OpenAPICallback, Referenced } from '../types';
+import type { CallbackModel, GroupModel } from './types';
+export declare function getCallback(parser: OpenAPIParser, name: string, infoOrRef: Referenced<OpenAPICallback>, parentPointer: string, options: Options, href: string, parent?: GroupModel): CallbackModel;

package/lib-esm/models/callback.js

@@ -0,0 +1,2 @@
+import{isOperationName,JsonPointer}from"../utils";import{getOperation}from"./operation";import{joinWithSeparator}from"../services";export function getCallback(e,t,r,o,a,s,i){const{resolved:n}=e.deref(r),p=[];for(const r of Object.keys(n)){const c=n[r],m=Object.keys(c).filter(isOperationName);for(const n of m){const m=c[n],f=getOperation(e,Object.assign(Object.assign({},m),{pathName:r,pointer:JsonPointer.join(o,["callbacks",t,n]),httpVerb:n,pathParameters:c.parameters||[],pathServers:c.servers}),i,a,s,{isCallback:!0,id:joinWithSeparator(t,n)});p.push(f)}}return{name:t,operations:p}}
+//# sourceMappingURL=callback.js.map

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

@@ -0,0 +1,10 @@
+import type { OpenAPIExample, Referenced } from '../types';
+import type { OpenAPIParser } from '../services';
+import type { ExampleModel } from './types';
+export declare function getExternalExampleValue(mimeType: string, externalValueUrl?: string): Promise<string | undefined>;
+type GetExamplesInput = Pick<ExampleModel, 'mime' | 'encoding'> & {
+    parser: OpenAPIParser;
+    infoOrRef: Referenced<OpenAPIExample>;
+};
+export declare function getExamples({ parser, infoOrRef, mime, encoding }: GetExamplesInput): ExampleModel;
+export {};

package/lib-esm/models/example.js

@@ -0,0 +1,2 @@
+import{resolve as urlResolve}from"url";import{isJsonLike}from"../utils";const ExternalExamplesCache={};export function getExternalExampleValue(e,r){return r?(r in ExternalExamplesCache||(ExternalExamplesCache[r]=fetch(r).then((r=>r.text().then((t=>{if(!r.ok)return Promise.reject(new Error(t));if(!isJsonLike(e))return t;try{return JSON.parse(t)}catch(e){return t}}))))),ExternalExamplesCache[r]):Promise.resolve(void 0)}export function getExamples({parser:e,infoOrRef:r,mime:t,encoding:n}){let l;const{resolved:a}=e.deref(r),o=a.value,i=a.value,s=a.summary,u=a.description;return a.externalValue&&(l=urlResolve(e.definitionUrl||"",a.externalValue)),{value:i,rawValue:o,externalValueUrl:l,summary:s,description:u,mime:t,encoding:n}}
+//# sourceMappingURL=example.js.map

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

@@ -0,0 +1,7 @@
+import type { OpenAPIParser, Options } from '../services';
+import type { OpenAPIParameter, Referenced } from '../types';
+import type { FieldModel, Deps } from './types';
+export declare function getField(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIParameter> & {
+    name?: string;
+    kind?: string;
+}, pointer: string, options: Options, deps: Deps, refsStack?: string[]): FieldModel;

package/lib-esm/models/field.js

@@ -0,0 +1,2 @@
+import{extractExtensions,mapValues}from"../utils";import{getSchema}from"./schema";import{getExamples}from"./example";const DEFAULT_SERIALIZATION={path:{style:"simple",explode:!1},query:{style:"form",explode:!0},header:{style:"simple",explode:!1},cookie:{style:"form",explode:!0}};export function getField(e,l,o,t,i,n){var s,d,a,p,r,c;const{resolved:m}=e.deref(l),x=l.kind||"field",u=l.name||m.name,v=m.in,f=!!m.required;let h,E,g=m.schema,F="";if(!g&&m.in&&m.content){F=Object.keys(m.content)[0];const l=m.content[F];g=l&&(null==l?void 0:l.example)?Object.assign(Object.assign({},e.deref(l.schema,n,!0).resolved),{example:m.example||l.example}):l.schema}const y=(null==i?void 0:i.parentFieldFullPath)?i.parentFieldFullPath+"/"+u:u,O=getSchema({parser:e,schemaOrRef:g||{},pointer:o,options:t,baseRefsStack:n,deps:Object.assign(Object.assign({},i),{parentFieldFullPath:y,in:v})}),A=void 0===m.description?O.description||"":m.description,I=m.example||O.example,b=m.examples||(null===(d=null===(s=m.content)||void 0===s?void 0:s[F])||void 0===d?void 0:d.examples),L=b?mapValues(b,((l,o)=>getExamples({parser:e,infoOrRef:l,mime:o,encoding:m.encoding}))):void 0;F?h=F:m.style?E=m.style:v&&(E=null!==(p=null===(a=DEFAULT_SERIALIZATION[v])||void 0===a?void 0:a.style)&&void 0!==p?p:"form");const R=void 0===m.explode&&v?null===(c=null===(r=DEFAULT_SERIALIZATION[v])||void 0===r?void 0:r.explode)||void 0===c||c:!!m.explode;return{deps:i||{},schema:O,name:u,required:f,description:A,example:I,examples:L,deprecated:void 0===m.deprecated?O.deprecated:m.deprecated,in:v,kind:x,extensions:t.showExtensions?extractExtensions(m,t.showExtensions):void 0,explode:R,style:E,const:(null==O?void 0:O.const)||(null==m?void 0:m.const)||"",serializationMime:h,fieldFullPath:y}}
+//# sourceMappingURL=field.js.map

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

@@ -0,0 +1,4 @@
+import type { OpenAPITag } from '../types';
+import type { MarkdownHeading, MenuItemGroupType, Options } from '../services';
+import type { GroupModel } from './types';
+export declare function getGroup(type: MenuItemGroupType, tagOrGroup: OpenAPITag | MarkdownHeading, { pagination, markdownHeadingsAnchorLevel, }: Pick<Options, 'pagination' | 'markdownHeadingsAnchorLevel'>, parent?: GroupModel): GroupModel;

package/lib-esm/models/group.js

@@ -0,0 +1,2 @@
+import{safeSlugify}from"../utils";import{getHref}from"../services/menu/operation";import{saveTextBeforeHeading}from"../utils/saveTextBeforeHeading";export function getGroup(e,t,{pagination:i,markdownHeadingsAnchorLevel:a},r){const n=t.id||e+"/"+safeSlugify(t.name),o=t["x-displayName"]||t.name,s=t.level||1,m=t.isSchema,p=t.ast||void 0;return{id:n,type:e,parent:r,name:o,level:s,depth:0,isSchema:m,description:saveTextBeforeHeading(t.description||"",a),items:t.items,ast:p,externalDocs:t.externalDocs,href:getHref({id:n,parent:r,type:e},i)}}
+//# sourceMappingURL=group.js.map

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

@@ -1,17 +1,16 @@
 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 { getGroup } from './group';
+export { getOperation, isPayloadSample } from './operation';
+export type { Sample, XPayloadSample } from './operation';
+export { getRequestBody } from './request';
+export { getExamples, getExternalExampleValue } from './example';
+export { getActiveMediaType, getMediaContent } from './mediaContent';
+export type { MediaContentModel, OperationModel, GroupModel, SchemaModel } from './types';
+export { getMediaType } from './mediaType';
+export { getResponse } from './response';
+export { getSchema } from './schema';
+export { getField } from './field';
+export { getCallback } from './callback';
+export * from './security';
 export * from './types';

package/lib-esm/models/index.js

@@ -1,2 +1,2 @@
-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";
+export*from"./code-sample-options";export*from"./file-upload";export{getGroup}from"./group";export{getOperation,isPayloadSample}from"./operation";export{getRequestBody}from"./request";export{getExamples,getExternalExampleValue}from"./example";export{getActiveMediaType,getMediaContent}from"./mediaContent";export{getMediaType}from"./mediaType";export{getResponse}from"./response";export{getSchema}from"./schema";export{getField}from"./field";export{getCallback}from"./callback";export*from"./security";export*from"./types";
 //# sourceMappingURL=index.js.map

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 }, }: MediaContentModelInput): MediaContentModel;
+export declare function getActiveMediaType(content: MediaContentModel, mime?: string): import("./types").MediaTypeModel;

package/lib-esm/models/mediaContent.js

@@ -0,0 +1,2 @@
+import{getRecoil}from"recoil-nexus";import{mergeSimilarMediaTypes}from"../utils";import{getMediaType}from"./mediaType";import{activeMimeNameSelector}from"../recoil/app";export function getMediaContent({parser:e,info:t,isRequestType:i,options:r,data:{operation:o,type:a,response:p}}){r.unstable_ignoreMimeParameters&&(t=mergeSimilarMediaTypes(t));const m=Object.keys(t).map((m=>{const n=t[m];return getMediaType(e,m,i,n,r,{operation:o,type:a,response:p})})),n=m.filter((e=>!!e.examples)).length>0;return{mediaTypes:m,isRequestType:i,hasSample:n,operation:o}}export function getActiveMediaType(e,t){const i=t||getRecoil(activeMimeNameSelector);return i&&e.mediaTypes.find((e=>e.name===i))||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 } from '../services';
+import type { Options } from 'src/services/Options/types';
+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, }: {
+    operation: OperationModel;
+    type?: 'request' | 'response';
+    response?: ResponseModel;
+}): MediaTypeModel;

package/lib-esm/models/mediaType.js

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

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

@@ -0,0 +1,18 @@
+import type { ExtendedOpenAPIOperation, Unstable_ExternalCodeSample, OpenAPIParser, Options } from '../services';
+import type { 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): OperationModel;

package/lib-esm/models/operation.js

@@ -0,0 +1,2 @@
+import{extractExtensions,getOperationId,getOperationName,getStatusCodeType,isStatusCode,mergeParams,normalizeServers,sortByField,sortByRequired}from"../utils";import{getInitialServerWithVariables}from"../components/rightPanel/utils";import{getCallback}from"./callback";import{getField}from"./field";import{getRequestBody}from"./request";import{getSecurityRequirement}from"./security";import{getCodeSample}from"../services";import{getResponse}from"./response";export function isPayloadSample(e){return"payload"===e.lang&&"requestBodyContent"in e}let isCodeSamplesWarningPrinted=!1;export function getOperation(e,t,a,r,s,i){var o,n,l,p;const d=t.isWebhook,m={operationDefinition:t,parent:a,pointer:t.pointer,description:t.description,externalDocs:t.externalDocs,deprecated:!!t.deprecated,httpVerb:t.httpVerb,operationId:t.operationId,path:t.pathName,isWebhook:d,isCallback:Boolean(null==i?void 0:i.isCallback),isEvent:(null==i?void 0:i.isCallback)||d,name:getOperationName(t),defaultExampleName:t.defaultSampleName,type:"operation",callbackId:null==i?void 0:i.id,href:s,get callbacks(){return Object.keys(t.callbacks||[]).map((i=>{var o;return getCallback(e,i,null===(o=t.callbacks)||void 0===o?void 0:o[i],m.pointer,r,s,a)}))},get responses(){let a=!1;return Object.keys(t.responses||[]).filter((e=>"default"===e||("success"===getStatusCodeType(e)&&(a=!0),isStatusCode(e)))).map((s=>getResponse({parser:e,code:s,defaultAsError:a,infoOrRef:t.responses[s],options:r,isEvent:m.isEvent,operation:m})))},get parameters(){let a=mergeParams(e,t.pathParameters,t.parameters).map((t=>getField(e,t,m.pointer,r,{operation:m,type:"request"})));return r.sortPropsAlphabetically&&(a=sortByField(a,"name")),r.requiredPropsFirst&&(a=sortByRequired(a)),a}};(null==i?void 0:i.isCallback)?(m.security=(t.security||[]).map((t=>getSecurityRequirement({requirement:t,parser:e}))),m.servers=normalizeServers("",t.servers||t.pathServers||[])):(m.id=getOperationId(t,a),m.security=(t.security||e.definition.security||[]).map((t=>getSecurityRequirement({requirement:t,parser:e}))),m.servers=normalizeServers(e.definitionUrl,mergeInMockServer(t.servers||t.pathServers||e.definition.servers||[],r.mockServer))),r.showExtensions&&(m.extensions=extractExtensions(t,r.showExtensions)),m.activeServer=getInitialServerWithVariables(m.servers),m.requestBody=t.requestBody&&getRequestBody({parser:e,infoOrRef:t.requestBody,options:r,operation:m,isEvent:m.isEvent});const c=null===(n=null===(o=m.requestBody)||void 0===o?void 0:o.content)||void 0===n?void 0:n.mediaTypes,[u]=c||[],[g]=Object.keys((null==u?void 0:u.examples)||[]);m.activeExampleName=!1===t.defaultSampleName?void 0:t.defaultSampleName||g;const v=null===(l=m.requestBody)||void 0===l?void 0:l.content;m.payload=(null==v?void 0:v.hasSample)?{lang:"payload",label:"Payload",source:"",requestBodyContent:v}:void 0,m.definitionSamples=t["x-codeSamples"]||t["x-code-samples"]||[],t["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),m.hasSamples=(null==v?void 0:v.hasSample)||m.definitionSamples.length>0;const{payloadSampleIdx:S,hideRequestPayloadSample:y}=r;let f=[];if(!d){const t=r.generateCodeSamples||{},a=new Set(m.definitionSamples.map((({lang:e})=>e.toLowerCase())));f=generateCodeSamples((null===(p=t.languages)||void 0===p?void 0:p.filter((({lang:e})=>!a.has(e.toLowerCase()))))||[],t,e.definition,r.generatedPayloadSamplesMaxDepth)}const h=m.definitionSamples.concat(f),b=Math.min(h.length,S);return m.payload&&!y&&h.splice(b,0,m.payload),m.allCodeSamples=h,m.hideTryItPanel=!0===t["x-hideTryItPanel"],m}function generateCodeSamples(e,{skipOptionalParameters:t,withOAuth2Call:a},r,s){return e.map((({lang:e,label:i,options:o})=>({lang:e,label:i,get:i=>getCodeSample(Object.assign(Object.assign({},i),{lang:e,options:Object.assign(Object.assign({},o),{skipOptionalParameters:t,withOAuth2Call:a,spec:r,generatedPayloadSamplesMaxDepth:s})}))})))}function mergeInMockServer(e,t){if(!t)return e;const a={url:t.url,description:t.description};switch(t.position){case"first":return[a,...e];case"last":return[...e,a];case"replace":return[a];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}from"../utils";import{getMediaContent}from"./mediaContent";export function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:n,operation:i}){const{resolved:r}=e.deref(t),s=r.description||"",p=!!r.required;let a;const d=!n,c=getContentWithLegacyExamples(r);return void 0!==c&&(a=getMediaContent({parser:e,info:c,isRequestType:d,options:o,data:{operation:i,type:"request"}})),{description:s,required:p,content:a}}
+//# sourceMappingURL=request.js.map

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

@@ -0,0 +1,15 @@
+import type { OpenAPIResponse, Referenced } from '../types';
+import type { OpenAPIParser } from '../services';
+import type { Options } from 'src/services/Options';
+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}from"../utils";import{getField}from"./field";import{getMediaContent}from"./mediaContent";export function getResponse({parser:e,code:t,defaultAsError:o,infoOrRef:s,options:n,isEvent:r,operation:i}){var p;const a=!!r,d="all"===n.expandResponses||(null===(p=n.expandResponses)||void 0===p?void 0:p[t])||!1,{resolved:m}=e.deref(s),c={code:t,expanded:d};void 0!==m["x-summary"]?(c.summary=m["x-summary"],c.description=m.description||""):(c.summary=m.description||"",c.description=""),c.type=getStatusCodeType(t,o);const g=m.headers;void 0!==g&&(c.headers=Object.keys(g).map((t=>{const o=g[t];return getField(e,Object.assign(Object.assign({},o),{name:t}),"",n,{operation:i,type:"response",response:c})})));const u=getContentWithLegacyExamples(m);return void 0!==u&&(c.content=getMediaContent({parser:e,info:u,isRequestType:a,options:n,data:{operation:i,type:"response",response:c}})),c}
+//# sourceMappingURL=response.js.map

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

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

package/lib-esm/models/schema.js

@@ -0,0 +1,2 @@
+var __rest=this&&this.__rest||function(e,i){var t={};for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&i.indexOf(n)<0&&(t[n]=e[n]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var r=0;for(n=Object.getOwnPropertySymbols(e);r<n.length;r++)i.indexOf(n[r])<0&&Object.prototype.propertyIsEnumerable.call(e,n[r])&&(t[n[r]]=e[n[r]])}return t};import{pushRef}from"../services/OpenAPIParser";import{detectType,extractExtensions,humanizeConstraints,isNamedDefinition,isObject,isPrimitiveType,JsonPointer,pluralizeType,sortByField,sortByRequired}from"../utils";import{l}from"../services";import{getField}from"./field";export function getSchema({parser:e,schemaOrRef:i,pointer:t,options:n,isChild:r=!1,baseRefsStack:s=[],deps:a}){var o,p,d,c,f,m,y,u;const{resolved:O,refsStack:h}=e.deref(i,s,!0),v=i.$ref||t||"",b=pushRef(h,v),g=e.mergeAllOf(O,v,b),x=g.type||detectType(g),P={parser:e,options:n,deps:a,schemaOrRef:i,isChild:r,typePrefix:"",pointer:v,refsStack:b,rawSchema:O,type:x,isCircular:!!g["x-circular-ref"],title:g.title||isNamedDefinition(v)&&JsonPointer.baseName(v)||"",description: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,"x-enumDescriptions":g["x-enumDescriptions"],get fields(){return hasType(P,"object")||hasType(P,"array")&&(Array.isArray(g.items)||Array.isArray(g.prefixItems))?buildFields(e,g,v,n,b,a):void 0}};if((g.nullable||g["x-nullable"])&&(Array.isArray(P.type)&&!P.type.some((e=>null===e||"null"===e))?P.type=[...P.type,"null"]:Array.isArray(P.type)||null===P.type&&"null"===P.type||(P.type=[P.type,"null"])),P.displayType=Array.isArray(P.type)?P.type.map((e=>null===e?"null":e)).join(" or "):P.type,P.isCircular)return P;if(g.if&&g.then||g.if&&g.else){const{oneOf:i,oneOfType:t}=initConditionalOperators({schema:g,parser:e,pointer:v,options:n,deps:a,refsStack:b});return P.oneOf=i,P.oneOfType=t,P}if(!r&&void 0!==getDiscriminator(g)){const{oneOf:i,discriminatorProp:t}=initDiscriminator({schema:g,parser:e,deps:a,mergedSchema:g,options:n,pointer:v,refsStack:b});return P.oneOf=i,P.discriminatorProp=t,P}if(r&&Array.isArray(g.oneOf)&&g.oneOf.find((e=>e.$ref===v))&&delete g.oneOf,void 0!==g.oneOf){const{oneOf:i,displayType:t}=initOneOf({schemaOneOf:g.oneOf,parser:e,deps:a,options:n,pointer:v,refsStack:b,schema:g});return P.oneOfType="One of",i&&(P.oneOf=i),P.displayType=t,void 0!==g.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${v}`),P}if(void 0!==g.anyOf){const{oneOf:i,displayType:t}=initOneOf({schemaOneOf:g.anyOf,parser:e,deps:a,options:n,pointer:v,refsStack:b,schema:g});return i&&(P.oneOf=i),P.displayType=t,P.oneOfType="Any of",P}if(hasType(P,"array")&&(g.items&&(P.items=getSchema({parser:e,schemaOrRef:g.items,pointer:v+"/items",options:n,baseRefsStack:b,deps:a})),P.displayType=g.prefixItems||Array.isArray(g.items)?"items":pluralizeType((null===(o=P.items)||void 0===o?void 0:o.displayType)||P.displayType),P.displayFormat=(null===(p=P.items)||void 0===p?void 0:p.format)||"",P.typePrefix=(null===(d=P.items)||void 0===d?void 0:d.typePrefix)||""+l("arrayOf"),P.title=P.title||(null===(c=P.items)||void 0===c?void 0:c.title)||"",P.isPrimitive=void 0!==(null===(f=P.items)||void 0===f?void 0:f.isPrimitive)?null===(m=P.items)||void 0===m?void 0:m.isPrimitive:P.isPrimitive,void 0===P.example&&void 0!==(null===(y=P.items)||void 0===y?void 0:y.example)&&(P.example=[P.items.example]),(null===(u=P.items)||void 0===u?void 0:u.isPrimitive)&&(P.enum=P.items.enum,P["x-enumDescriptions"]=P.items["x-enumDescriptions"]),Array.isArray(P.type))){const e=P.type.filter((e=>"array"!==e));e.length&&(P.displayType+=` or ${e.join(" or ")}`)}return P.enum.length&&n.sortEnumValuesAlphabetically&&P.enum.sort(),n.showExtensions&&(P.extensions=extractExtensions(g,n.showExtensions)),P}function initDiscriminator({schema:e,parser:i,pointer:t,options:n,refsStack:r,deps:s,mergedSchema:a}){const o=getDiscriminator(e),l=null==o?void 0:o.propertyName,p=i.findDerived([...a["x-parentRefs"]||[],t]);if(e.oneOf)for(const i of e.oneOf){if(void 0===i.$ref)continue;const e=JsonPointer.baseName(i.$ref);p[i.$ref]=e}const d=(null==o?void 0:o.mapping)||{};let c=(null==o?void 0:o["x-explicitMappingOnly"])||!1;0===Object.keys(d).length&&(c=!1);const f={};for(const e in d){const i=d[e];Array.isArray(f[i])?f[i].push(e):f[i]=[e]}const m=c?Object.assign({},f):Object.assign(Object.assign({},p),f);let y=[];for(const e of Object.keys(m)){const i=m[e];if(Array.isArray(i))for(const t of i)y.push({$ref:e,name:t});else y.push({$ref:e,name:i})}const u=Object.keys(d);0!==u.length&&(y=y.sort(((e,i)=>{const t=u.indexOf(e.name),n=u.indexOf(i.name);return t<0&&n<0?e.name.localeCompare(i.name):t<0?1:n<0?-1:t-n})));return{oneOf:y.map((({$ref:e,name:t},a)=>{const o=getSchema({parser:i,schemaOrRef:{$ref:e},pointer:e,options:n,isChild:!0,baseRefsStack:r.slice(0,-1),deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"/"+a:a.toString()})});return o.title=t,o})),discriminatorProp:l}}function initOneOf({schemaOneOf:e,parser:i,refsStack:t,pointer:n,schema:r,options:s,deps:a}){const o=e.map(((e,o)=>{const{resolved:l,refsStack:p}=i.deref(e,t,!0),d=i.mergeAllOf(l,n+"/oneOf/"+o,p),c=isNamedDefinition(e.$ref)&&!d.title?JsonPointer.baseName(e.$ref):`${d.title||""}${d.const&&JSON.stringify(d.const)||""}`;return getSchema({parser:i,schemaOrRef:Object.assign(Object.assign({},d),{title:c,allOf:[Object.assign(Object.assign({},r),{oneOf:void 0,anyOf:void 0})],discriminator:l.allOf?void 0:d.discriminator}),pointer:e.$ref||n+"/oneOf/"+o,options:s,baseRefsStack:p,deps:Object.assign(Object.assign({},a),{parentFieldFullPath:a.parentFieldFullPath?a.parentFieldFullPath+"/"+o:o.toString()})})}));let l;if(s.simpleOneOfTypeLabel){l=collectUniqueOneOfTypesDeep(r).join(" or ")}else l=o.map((e=>{let i=e.typePrefix+(e.title?`${e.title} (${e.displayType})`:e.displayType);return i.indexOf(" or ")>-1&&(i=`(${i})`),i})).join(" or ");return{oneOf:o,displayType:l}}function initConditionalOperators({schema:e,parser:i,pointer:t,options:n,refsStack:r,deps:s}){const{if:a,else:o={},then:l={}}=e,p=__rest(e,["if","else","then"]);return{oneOf:[{allOf:[p,l,a],title:a&&a["x-displayName"]||(null==a?void 0:a.title)||"case 1"},{allOf:[p,o],title:o&&o["x-displayName"]||(null==o?void 0:o.title)||"case 2"}].map(((e,a)=>getSchema({parser:i,schemaOrRef:Object.assign({},e),pointer:t+"/oneOf/"+a,options:n,baseRefsStack:r,deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"/"+a:a.toString()})}))),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,n,r,s){const a=i.properties||i.prefixItems||i.items||{},o=i.patternProperties||{},l=i.additionalProperties||i.unevaluatedProperties,p=i.prefixItems?i.items:i.additionalItems,d=i.default||{};let c=Object.keys(a).map((o=>{var l;const p=normalizeField(a[o],o,t),c=void 0!==i.required&&i.required.indexOf(o)>-1;return getField(e,{name:i.properties?o:`[${o}]`,required:c,schema:Object.assign(Object.assign({},p),{example:(null===(l=i.example)||void 0===l?void 0:l[o])||p.example,default:void 0===p.default&&d?d[o]:p.default})},t+"/properties/"+o,n,s,r)}));return n.sortPropsAlphabetically&&(c=sortByField(c,"name")),n.requiredPropsFirst&&(c=sortByRequired(c,n.sortPropsAlphabetically?void 0:i.required)),c.push(...Object.keys(o).map((i=>{const a=normalizeField(o[i],i,t);return getField(e,{name:i,required:!1,schema:a,kind:"patternProperties"},`${t}/patternProperties/${i}`,n,s,r)}))),(isObject(l)||!0===l)&&c.push(getField(e,{name:(isObject(l)&&l["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===l?{}:l,kind:"additionalProperties"},t+"/additionalProperties",n,s,r)),c.push(...buildAdditionalItems({parser:e,schema:p,fieldsCount:c.length,$ref:t,options:n,refsStack:r,deps:s})),c}function buildAdditionalItems({parser:e,schema:i=!1,fieldsCount:t,$ref:n,options:r,refsStack:s,deps:a}){return"boolean"==typeof i?i?[getField(e,{name:`[${t}...]`,schema:{},kind:"additionalItems"},`${n}/additionalItems`,r,a,s)]:[]:Array.isArray(i)?[...i.map(((i,o)=>getField(e,{name:`[${t+o}]`,schema:i,kind:"additionalItems"},`${n}/additionalItems/${o}`,r,a,s)))]:isObject(i)?[getField(e,{name:`[${t}...]`,schema:i,kind:"additionalItems"},`${n}/additionalItems`,r,a,s)]:[]}function getDiscriminator(e){return e.discriminator||e["x-discriminator"]}function collectUniqueOneOfTypesDeep(e){const i=new Set;return function e(t){for(const n of t.oneOf||[])n.oneOf?e(n):n.type&&i.add(n.type)}(e),Array.from(i.values())}function hasType(e,i){return e.type===i||Array.isArray(e.type)&&e.type.includes(i)}
+//# sourceMappingURL=schema.js.map

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

@@ -0,0 +1,13 @@
+import type { OpenAPISecurityRequirement, OpenAPISecurityScheme, Referenced } from '../types';
+import type { OpenAPIParser } from '../services';
+import type { SecurityRequirement, SecurityScheme } from './types';
+type GetSecurityRequirementsInput = {
+    requirement: OpenAPISecurityRequirement;
+    parser: OpenAPIParser;
+};
+export declare function getSecurityRequirement({ requirement, parser, }: GetSecurityRequirementsInput): SecurityRequirement;
+export declare function getSecurityScheme(parser: Partial<OpenAPIParser>, id: string, scheme: Referenced<OpenAPISecurityScheme>): SecurityScheme;
+export declare function getSecuritySchemes({ parser, }: {
+    parser: Partial<OpenAPIParser>;
+}): Array<SecurityScheme>;
+export {};

package/lib-esm/models/security.js

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