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

package/lib-esm/types/open-api.d.ts

@@ -0,0 +1,337 @@
+import type { Sample } from '../models';
+export interface OpenAPIDefinition {
+    openapi: string;
+    info: OpenAPIInfo;
+    servers?: OpenAPIServer[];
+    paths: OpenAPIPaths;
+    components?: OpenAPIComponents;
+    security?: OpenAPISecurityRequirement[];
+    tags?: OpenAPITag[];
+    externalDocs?: OpenAPIExternalDocumentation;
+    'x-webhooks'?: OpenAPIPaths;
+    webhooks?: OpenAPIPaths;
+    'x-tagGroups'?: Array<{
+        name: string;
+        tags: Array<string>;
+    }>;
+}
+export interface OpenAPIInfo {
+    title: string;
+    version: string;
+    description?: string;
+    summary?: string;
+    termsOfService?: string;
+    contact?: OpenAPIContact;
+    license?: OpenAPILicense;
+    'x-logo'?: XLogo;
+}
+export interface XLogo {
+    url?: string;
+    backgroundColor?: string;
+    altText?: string;
+    href?: string;
+}
+export interface OpenAPIServer {
+    url: string;
+    description?: string;
+    variables?: {
+        [name: string]: OpenAPIServerVariable;
+    };
+}
+export interface OpenAPIServerVariable {
+    enum?: string[];
+    default: string;
+    description?: string;
+}
+export interface OpenAPIPaths {
+    [path: string]: OpenAPIPath;
+}
+export interface OpenAPIRef {
+    $ref: string;
+    'x-refsStack'?: string[];
+    summary?: string;
+    description?: string;
+}
+export type Referenced<T> = T | OpenAPIRef;
+export interface OpenAPIPath extends Partial<OpenAPIRef> {
+    summary?: string;
+    description?: string;
+    get?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    trace?: OpenAPIOperation;
+    servers?: OpenAPIServer[];
+    parameters?: Array<Referenced<OpenAPIParameter>>;
+}
+export interface OpenAPIXCodeSample extends Sample {
+    source: string;
+}
+export interface OpenAPIOperation {
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    operationId?: string;
+    parameters?: Array<Referenced<OpenAPIParameter>>;
+    requestBody?: Referenced<OpenAPIRequestBody>;
+    responses: OpenAPIResponses;
+    callbacks?: {
+        [name: string]: Referenced<OpenAPICallback>;
+    };
+    deprecated?: boolean;
+    security?: OpenAPISecurityRequirement[];
+    servers?: OpenAPIServer[];
+    'x-codeSamples'?: OpenAPIXCodeSample[];
+    'x-code-samples'?: OpenAPIXCodeSample[];
+}
+export interface OpenAPIParameter {
+    name: string;
+    in?: OpenAPIParameterLocation;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: OpenAPIParameterStyle;
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: Referenced<OpenAPISchema>;
+    example?: any;
+    examples?: {
+        [media: string]: Referenced<OpenAPIExample>;
+    };
+    content?: {
+        [media: string]: OpenAPIMediaType;
+    };
+    encoding?: Record<string, OpenAPIEncoding>;
+    const?: any;
+}
+export interface OpenAPIExample {
+    value: any;
+    summary?: string;
+    description?: string;
+    externalValue?: string;
+}
+export interface OpenAPISchema {
+    $ref?: string;
+    type?: string | string[];
+    properties?: {
+        [name: string]: OpenAPISchema;
+    };
+    patternProperties?: {
+        [name: string]: OpenAPISchema;
+    };
+    additionalProperties?: boolean | OpenAPISchema;
+    unevaluatedProperties?: boolean | OpenAPISchema;
+    description?: string;
+    default?: any;
+    items?: OpenAPISchema | OpenAPISchema[] | boolean;
+    required?: string[];
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    deprecated?: boolean;
+    format?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    discriminator?: OpenAPIDiscriminator;
+    nullable?: boolean;
+    oneOf?: OpenAPISchema[];
+    anyOf?: OpenAPISchema[];
+    allOf?: OpenAPISchema[];
+    not?: OpenAPISchema;
+    title?: string;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean | number;
+    minimum?: number;
+    exclusiveMinimum?: boolean | number;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxProperties?: number;
+    minProperties?: number;
+    enum?: any[];
+    example?: any;
+    examples?: any[];
+    const?: string;
+    contentEncoding?: string;
+    contentMediaType?: string;
+    if?: OpenAPISchema;
+    else?: OpenAPISchema;
+    then?: OpenAPISchema;
+    prefixItems?: OpenAPISchema[];
+    additionalItems?: OpenAPISchema | boolean;
+}
+export interface OpenAPIDiscriminator {
+    propertyName: string;
+    mapping?: {
+        [name: string]: string;
+    };
+    'x-explicitMappingOnly'?: boolean;
+}
+export interface OpenAPIMediaType {
+    schema?: Referenced<OpenAPISchema>;
+    example?: any;
+    examples?: {
+        [name: string]: Referenced<OpenAPIExample>;
+    };
+    encoding?: {
+        [field: string]: OpenAPIEncoding;
+    };
+}
+export interface OpenAPIEncoding {
+    contentType: string;
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    style: OpenAPIParameterStyle;
+    explode: boolean;
+    allowReserved: boolean;
+}
+export type OpenAPIParameterLocation = 'query' | 'header' | 'path' | 'cookie';
+export type OpenAPIParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
+export interface OpenAPIRequestBody {
+    description?: string;
+    required?: boolean;
+    content: {
+        [mime: string]: OpenAPIMediaType;
+    };
+    'x-examples'?: {
+        [mime: string]: {
+            [name: string]: Referenced<OpenAPIExample>;
+        };
+    };
+    'x-example'?: {
+        [mime: string]: any;
+    };
+}
+export interface OpenAPIResponses {
+    [code: string]: OpenAPIResponse;
+}
+export interface OpenAPIResponse {
+    description?: string;
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    content?: {
+        [mime: string]: OpenAPIMediaType;
+    };
+    links?: {
+        [name: string]: Referenced<OpenAPILink>;
+    };
+    'x-examples'?: {
+        [mime: string]: {
+            [name: string]: Referenced<OpenAPIExample>;
+        };
+    };
+    'x-example'?: {
+        [mime: string]: any;
+    };
+}
+export interface OpenAPILink {
+    $ref?: string;
+}
+export type OpenAPIHeader = Omit<OpenAPIParameter, 'in' | 'name'>;
+export interface OpenAPICallback {
+    [name: string]: OpenAPIPath;
+}
+export interface OpenAPIComponents {
+    schemas?: {
+        [name: string]: Referenced<OpenAPISchema>;
+    };
+    responses?: {
+        [name: string]: Referenced<OpenAPIResponse>;
+    };
+    parameters?: {
+        [name: string]: Referenced<OpenAPIParameter>;
+    };
+    examples?: {
+        [name: string]: Referenced<OpenAPIExample>;
+    };
+    requestBodies?: {
+        [name: string]: Referenced<OpenAPIRequestBody>;
+    };
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    securitySchemes?: {
+        [name: string]: Referenced<OpenAPISecurityScheme>;
+    };
+    links?: {
+        [name: string]: Referenced<OpenAPILink>;
+    };
+    callbacks?: {
+        [name: string]: Referenced<OpenAPICallback>;
+    };
+}
+export interface OpenAPISecurityRequirement {
+    [name: string]: string[];
+}
+export interface OpenAPISecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat: string;
+    'x-defaultClientId'?: string;
+    flows: {
+        implicit?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            authorizationUrl: string;
+            'x-defaultClientId'?: string;
+            'x-tokenEndpointAuthMethod'?: string;
+        };
+        password?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+            'x-defaultClientId'?: string;
+        };
+        clientCredentials?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+            'x-defaultClientId'?: string;
+            'x-tokenEndpointAuthMethod'?: string;
+        };
+        authorizationCode?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            authorizationUrl: string;
+            tokenUrl: string;
+            'x-defaultClientId'?: string;
+            'x-tokenEndpointAuthMethod'?: string;
+        };
+    };
+    openIdConnectUrl?: string;
+}
+export interface OpenAPITag {
+    name: string;
+    description?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    'x-displayName'?: string;
+}
+export interface OpenAPIExternalDocumentation {
+    description?: string;
+    url: string;
+}
+export interface OpenAPIContact {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+export interface OpenAPILicense {
+    name: string;
+    url?: string;
+    identifier?: string;
+}
+export interface ParsedDocument extends OpenAPIDefinition {
+    swagger: unknown;
+}

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

@@ -0,0 +1,11 @@
+export type SecurityDetails = {
+    password?: string;
+    username?: string;
+    token?: {
+        token_type?: string;
+        access_token: string;
+    };
+    client_id?: string;
+    client_secret?: string;
+    scopes?: string;
+};

package/lib-esm/types/security.js

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

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

@@ -0,0 +1,4 @@
+export declare function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean;
+export declare function argValueToNumber(value: number | string | undefined, defaultValue?: number): number;
+export declare function argValueToInt(value: number | string | undefined, defaultValue?: number): number;
+export declare function argValueToExpandLevel(value?: number | string | undefined, defaultValue?: number): number;

package/lib-esm/utils/argValuesHelpers.js

@@ -0,0 +1,2 @@
+export function argValueToBoolean(e,r){return void 0===e?r||!1:"string"==typeof e?"false"!==e:e}export function argValueToNumber(e,r=0){return"string"==typeof e?parseInt(e,10):"number"==typeof e?e:r}export function argValueToInt(e,r=0){return"string"==typeof e?parseInt(e,10):"number"==typeof e?Math.ceil(e):r}export function argValueToExpandLevel(e,r=0){return"all"===e?1/0:argValueToInt(e,r)}
+//# sourceMappingURL=argValuesHelpers.js.map

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

@@ -0,0 +1 @@
+export declare function debounce<T>(fn: (...args: T[]) => void, threshold: number, leading?: boolean): (...args: T[]) => void;

package/lib-esm/utils/debounce.js

@@ -0,0 +1,2 @@
+export function debounce(e,n,t){let u,o=0;return function(...c){o++,u?clearTimeout(u):t&&e(...c),u=setTimeout((function(){o>1&&e(...c),o=0,u=null}),n)}}
+//# sourceMappingURL=debounce.js.map

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

@@ -0,0 +1,51 @@
+/**
+ * Maps over array passing `isLast` bool to iterator as the second argument
+ */
+export declare function mapWithLast<T, P>(array: T[], iteratee: (item: T, isLast: boolean) => P): P[];
+/**
+ * Creates an object with the same keys as object and values generated by running each
+ * own enumerable string keyed property of object thru iteratee.
+ * The iteratee is invoked with three arguments: (value, key, object).
+ *
+ * @param object the object to iterate over
+ * @param iteratee the function invoked per iteration.
+ */
+export declare function mapValues<T, P>(object: Record<string, T>, iteratee: (val: T, key: string, obj: Record<string, T>) => P): Record<string, P>;
+/**
+ * flattens collection using `prop` field as a children
+ * @param collectionItems collection items
+ * @param prop item property with child elements
+ */
+export declare function flattenByProp<T extends GenericObject, P extends keyof T>(collectionItems: T[], prop: P): T[];
+export declare function stripTrailingSlash(path: string): string;
+export declare function isNumeric(value: unknown): value is number;
+export declare function appendToMdHeading(md: string, heading: string, content: string): string;
+export declare const mergeObjects: (target: GenericObject, ...sources: GenericObject[]) => GenericObject;
+export declare const isObject: (item: unknown) => item is "object";
+export declare const isArrayOfObjects: (items: unknown) => items is [];
+export declare const deleteEmptyArrayItem: (items: unknown[]) => unknown[];
+export declare const isMergeableObject: (item: unknown) => boolean;
+/**
+ * slugify() returns empty string when failed to slugify.
+ * so try to return minimum slugified-string with failed one which keeps original value
+ * the regex codes are referenced with https://gist.github.com/mathewbyrne/1280286
+ */
+export declare function safeSlugify(value: string): string;
+export declare function isAbsoluteUrl(url: string): boolean;
+/**
+ * simple resolve URL which doesn't break on strings with url fragments
+ * e.g. resolveUrl('http://test.com:{port}', 'path') results in http://test.com:{port}/path
+ */
+export declare function resolveUrl(url: string, to: string): string;
+export declare function getBasePath(serverUrl: string): string;
+export declare function titleize(text: string): string;
+export declare function removeQueryStringAndHash(serverUrl: string): string;
+export declare function escapeHTMLAttrChars(str: string): string;
+export declare function unescapeHTMLChars(str: string): string;
+export declare function sanitizeItemId(id: string): string;
+export declare function getSchemaTitle(pointer: string, title?: string): string;
+export declare function get<T>(object: GenericObject | undefined, path: string | Array<string>, defval?: T): GenericObject;
+export declare function joinStringFactory(separator: string): (...args: (string | undefined)[]) => string;
+export declare const dottedString: (...args: (string | undefined)[]) => string;
+export declare function getWindowReferenceOptions<T>(option: string): T | null;
+export declare function getJsUrl(): string;

package/lib-esm/utils/helpers.js

@@ -0,0 +1,2 @@
+import slugify from"slugify";import{format,parse}from"url";import{ZERO_BREAKPOINT}from"./media-css";import{isNamedDefinition}from"./openapi";import{JsonPointer}from"./JsonPointer";import{IS_BROWSER}from"./dom";export function mapWithLast(e,t){const r=[];for(let n=0;n<e.length-1;n++)r.push(t(e[n],!1));return 0!==e.length&&r.push(t(e[e.length-1],!0)),r}export function mapValues(e,t){const r={};for(const n in e)Object.prototype.hasOwnProperty.call(e,n)&&(r[n]=t(e[n],n,e));return r}export function flattenByProp(e,t){const r=[],n=e=>{for(const o of e)r.push(o),o[t]&&n(o[t])};return n(e),r}export function stripTrailingSlash(e){return e.endsWith("/")?e.substring(0,e.length-1):e}export function isNumeric(e){return!isNaN(parseFloat(e))&&isFinite(e)}export function appendToMdHeading(e,t,r){const n=new RegExp(`(^|\\n)#\\s?${t}\\s*\\n`,"i"),o=new RegExp(`((\\n|^)#\\s*${t}\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)`,"i");if(n.test(e))return e.replace(o,`$1\n\n${r}\n$4`);{const n=""===e||e.endsWith("\n\n")?"":e.endsWith("\n")?"\n":"\n\n";return`${e}${n}# ${t}\n\n${r}`}}export const mergeObjects=(e,...t)=>{if(!t.length)return e;const r=t.shift();return void 0===r?e:(isMergeableObject(e)&&isMergeableObject(r)&&Object.keys(r).forEach((t=>{isMergeableObject(r[t])?(e[t]||(e[t]={}),["string","number"].includes(typeof e[t])&&(r[t][ZERO_BREAKPOINT]||0===r[t][ZERO_BREAKPOINT]||console.warn(`Theme resolver: using default value of "${e[t]}" for "${t}". This is not recommended. Prefer adding default value by providing "${ZERO_BREAKPOINT}" property to ${JSON.stringify(r[t])}.`),e[t]={[ZERO_BREAKPOINT]:e[t]}),mergeObjects(e[t],r[t])):e[t]=r[t]})),mergeObjects(e,...t))};export const isObject=e=>null!==e&&"object"==typeof e;export const isArrayOfObjects=e=>Array.isArray(e)&&e.some((e=>isObject(e)));export const deleteEmptyArrayItem=e=>e.filter((e=>!!e));export const isMergeableObject=e=>isObject(e)&&!Array.isArray(e);export function safeSlugify(e){return slugify(e)||e.toString().toLowerCase().replace(/\s+/g,"-").replace(/&/g,"-and-").replace(/--+/g,"-").replace(/^-+/,"").replace(/-+$/,"")}export function isAbsoluteUrl(e){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(e)}export function resolveUrl(e,t){let r;if(t.startsWith("//")){const{protocol:n}=parse(e);r=`${n||"https:"}${t}`}else if(isAbsoluteUrl(t))r=t;else if(t.startsWith("/")){const n=parse(e);r=format(Object.assign(Object.assign({},n),{pathname:t}))}else r=stripTrailingSlash(e)+"/"+t;return stripTrailingSlash(r)}export function getBasePath(e){try{return parseURL(e).pathname}catch(t){return e}}export function titleize(e){return e.charAt(0).toUpperCase()+e.slice(1)}export function removeQueryStringAndHash(e){try{const t=parseURL(e);return t.search="",t.hash="",t.toString()}catch(t){return e}}function parseURL(e){return"undefined"==typeof URL?new(require("url").URL)(e):new URL(e)}export function escapeHTMLAttrChars(e){return e.replace(/["\\]/g,"\\$&")}export function unescapeHTMLChars(e){return e.replace(/&#(\d+);/g,((e,t)=>String.fromCharCode(parseInt(t,10)))).replace(/&amp;/g,"&").replace(/&quot;/g,'"')}export function sanitizeItemId(e){return e&&e.replace(/#/g,"_")}export function getSchemaTitle(e,t){return t||isNamedDefinition(e)&&JsonPointer.baseName(e)||""}export function get(e={},t,r){return"string"==typeof t&&(t=t.split(".")),t.reduce(((e,t)=>e&&e[t]?e[t]:r),e)}export function joinStringFactory(e){return(...t)=>t.filter(Boolean).join(e)}export const dottedString=joinStringFactory(".");export function getWindowReferenceOptions(e){var t;return IS_BROWSER?null===(t=null===window||void 0===window?void 0:window.REFERENCE_DOCS_OPTIONS)||void 0===t?void 0:t[e]:null}export function getJsUrl(){var e;if(!IS_BROWSER)return"";const t=+new Date+Math.random();try{return document.currentScript&&(document.currentScript.async||document.currentScript.defer)||document.write(`<script id="dummy${t}"><\/script>`),(null===(e=document.getElementById("dummy"+t))||void 0===e?void 0:e.previousSibling).src}catch(e){return""}}
+//# sourceMappingURL=helpers.js.map

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

@@ -0,0 +1,21 @@
+export * from './JsonPointer';
+export * from './openapi';
+export * from './helpers';
+export * from './highlight';
+export * from './loadAndBundleSpec';
+export * from './dom';
+export * from './decorators';
+export * from './debug';
+export * from './memoize';
+export * from './sort';
+export * from './argValuesHelpers';
+export * from './media-css';
+export * from './theme-helpers';
+export * from './debounce';
+export * from './security-details';
+export * from './session-storage';
+export * from './local-storage';
+export * from './parameters';
+export * from './store';
+export * from './string';
+export * from './test-utils';

package/lib-esm/utils/index.js

@@ -0,0 +1,2 @@
+export*from"./JsonPointer";export*from"./openapi";export*from"./helpers";export*from"./highlight";export*from"./loadAndBundleSpec";export*from"./dom";export*from"./decorators";export*from"./debug";export*from"./memoize";export*from"./sort";export*from"./argValuesHelpers";export*from"./media-css";export*from"./theme-helpers";export*from"./debounce";export*from"./security-details";export*from"./session-storage";export*from"./local-storage";export*from"./parameters";export*from"./store";export*from"./string";export*from"./test-utils";
+//# sourceMappingURL=index.js.map

package/lib-esm/utils/loadAndBundleSpec.js

@@ -0,0 +1,2 @@
+var __awaiter=this&&this.__awaiter||function(e,n,o,t){return new(o||(o=Promise))((function(r,i){function c(e){try{u(t.next(e))}catch(e){i(e)}}function a(e){try{u(t.throw(e))}catch(e){i(e)}}function u(e){var n;e.done?r(e.value):(n=e.value,n instanceof o?n:new o((function(e){e(n)}))).then(c,a)}u((t=t.apply(e,n||[])).next())}))};import{bundle}from"@redocly/openapi-core/lib/bundle";import{Config}from"@redocly/openapi-core/lib/config/config";import{convertObj}from"swagger2openapi";import{IS_BROWSER}from"./dom";export function loadAndBundleDefinition(e){return __awaiter(this,void 0,void 0,(function*(){const n=new Config({}),o={config:n,base:IS_BROWSER?window.location.href:process.cwd()};IS_BROWSER&&(n.resolve.http.customFetch=global.fetch),"object"==typeof e&&null!==e?o.doc=createParsedDocument(e):o.ref=e;const{bundle:{parsed:t}}=yield bundle(o);return void 0!==t.swagger?convertSwagger2OpenAPI(t):t}))}export function createParsedDocument(e){return{source:{absoluteRef:""},parsed:e}}export function convertSwagger2OpenAPI(e){return e.paths||(e.paths={}),new Promise(((n,o)=>convertObj(e,{patch:!0,warnOnly:!0,text:"{}",anchors:!0},((e,t)=>{if(e)return o(e);n(null==t?void 0:t.openapi)}))))}
+//# sourceMappingURL=loadAndBundleSpec.js.map

package/lib-esm/utils/local-storage.d.ts

@@ -0,0 +1,2 @@
+export declare function toLocalStorage(key: string, value: string): void;
+export declare function fromLocalStorage<T extends string>(key: string): T;

package/lib-esm/utils/local-storage.js

@@ -0,0 +1,2 @@
+import{IS_BROWSER}from"./dom";export function toLocalStorage(o,t){window.localStorage.setItem("redoc."+o,t)}export function fromLocalStorage(o){return IS_BROWSER&&window.localStorage.getItem("redoc."+o)||""}
+//# sourceMappingURL=local-storage.js.map

package/lib-esm/utils/media-css.d.ts

@@ -0,0 +1,8 @@
+export type MediaQueries = {
+    print: string;
+    small: string;
+    medium: string;
+    large: string;
+};
+export declare const ZERO_BREAKPOINT = "_";
+export declare function generateMediaQueries(breakpoints: Omit<MediaQueries, 'print'>): MediaQueries;

package/lib-esm/utils/media-css.js

@@ -0,0 +1,2 @@
+export const ZERO_BREAKPOINT="_";export function generateMediaQueries(e){const n={print:"@media print"};for(const[t,r]of Object.entries(e))n[t]=`@media screen and (min-width: ${r})`;return n}
+//# sourceMappingURL=media-css.js.map

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

@@ -0,0 +1,41 @@
+import type { OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterStyle, OpenAPIRequestBody, OpenAPIResponse, OpenAPISchema, OpenAPIServer, Referenced } from '../types';
+import type { ExtendedOpenAPIOperation, OpenAPIParser } from '../services';
+import type { FieldModel } from '../models';
+import { OpenAPIParameter } from '../types';
+export declare function isStatusCode(statusCode: string): boolean;
+export declare function getStatusCodeType(statusCode: string | number, defaultAsError?: boolean): string;
+export declare function isOperationName(key: string): boolean;
+export declare function getOperationSummary(operation: ExtendedOpenAPIOperation): string;
+export declare function detectType(schema: OpenAPISchema): string;
+export declare function isPrimitiveType(schema: OpenAPISchema, type?: string | string[] | undefined): boolean;
+export declare function isJsonLike(contentType: string): boolean;
+export declare function isFormUrlEncoded(contentType: string): boolean;
+export declare function urlFormEncodePayload(payload: GenericObject, encoding?: {
+    [field: string]: OpenAPIEncoding;
+}): string;
+export declare function serializeQueryParameter(name: string, style: OpenAPIParameterStyle | undefined, explode: boolean, value: unknown): string;
+export declare function serializeParameterValueWithMime(value: unknown, mime: string): string;
+export declare function serializeParameterValue(parameter: OpenAPIParameter & {
+    serializationMime?: string;
+}, value: unknown): string;
+export declare function langFromMime(contentType: string): string;
+export declare function isNamedDefinition(pointer?: string): boolean;
+export declare function getDefinitionName(pointer?: string): string | undefined;
+export declare function humanizeNumberRange(schema: OpenAPISchema): string | undefined;
+export declare function humanizeConstraints(schema: OpenAPISchema): string[];
+export declare function sortByRequired(fields: FieldModel[], order?: string[]): Array<FieldModel>;
+export declare function sortByField(fields: FieldModel[], param: keyof Pick<FieldModel, 'name' | 'description' | 'kind'>): Array<FieldModel>;
+export declare function mergeParams(parser: OpenAPIParser, pathParams?: Array<Referenced<OpenAPIParameter>>, operationParams?: Array<Referenced<OpenAPIParameter>>): Array<Referenced<OpenAPIParameter>>;
+export declare function mergeSimilarMediaTypes(types: Record<string, OpenAPIMediaType>): Record<string, OpenAPIMediaType>;
+export declare function expandDefaultServerVariables(url: string, variables?: GenericObject): string;
+export declare function normalizeServers(specUrl: string | undefined, servers: OpenAPIServer[]): OpenAPIServer[];
+export declare const SECURITY_DEFINITIONS_COMPONENT_NAME = "security-definitions";
+export declare const SECURITY_DEFINITIONS_JSX_NAME = "SecurityDefinitions";
+export declare const SCHEMA_DEFINITION_JSX_NAME = "SchemaDefinition";
+export declare const shortenHTTPVerb: (verb: string) => string;
+export declare function isRedocExtension(key: string): boolean;
+export declare function extractExtensions(obj: GenericObject, showExtensions: string[] | true): GenericObject;
+export declare function pluralizeType(displayType: string): string;
+export declare function getContentWithLegacyExamples(info: OpenAPIRequestBody | OpenAPIResponse): {
+    [mime: string]: OpenAPIMediaType;
+} | undefined;

package/lib-esm/utils/openapi.js

@@ -0,0 +1,2 @@
+import{dirname}from"path";import UrlTemplate from"url-template";import{IS_BROWSER}from"./dom";import{deleteEmptyArrayItem,isArrayOfObjects,isNumeric,removeQueryStringAndHash,resolveUrl}from"./helpers";import{MediaTypes}from"../constants";function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}export function isStatusCode(e){return"default"===e||isNumeric(e)||isWildcardStatusCode(e)}export function getStatusCodeType(e,r=!1){if("default"===e)return r?"error":"success";let t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}const operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};export function isOperationName(e){return e in operationNames}export function getOperationSummary(e){return e.summary||e.operationId||e.description&&e.description.substring(0,50)||e.pathName||"<no summary>"}const schemaKeywordTypes={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",unevaluatedProperties:"object",patternProperties:"object",properties:"object"};export function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;const r=Object.keys(schemaKeywordTypes);for(const t of r){const r=schemaKeywordTypes[t];if(void 0!==e[t])return r}return"any"}export function isPrimitiveType(e,r=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let t=!0;const i=Array.isArray(r);return("object"===r||i&&(null==r?void 0:r.includes("object")))&&(t=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties&&void 0===e.patternProperties),!Array.isArray(e.items)&&!Array.isArray(e.prefixItems)&&(void 0!==e.items&&"boolean"!=typeof e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t)}export function isJsonLike(e){return-1!==e.search(/json/i)}export function isFormUrlEncoded(e){return e===MediaTypes.URL_ENCODED}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((e=>e.toString())).join(t):"object"==typeof e?Object.keys(e).map((r=>`${r}${t}${e[r]}`)).join(t):r+"="+e.toString()}function deepObjectEncodeField(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?Object.keys(e).map((t=>e[t]?`${r}[${t}]=${e[t]}`:void 0)).filter(Boolean).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function serializeFormValue(e,r,t){const i="__redoc_param_name__",n=r?"*":"";return UrlTemplate.parse(`{?${i}${n}}`).expand({[i]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function serializeSimpleValue(e,r){const t=e?"*":"",i="__redoc_param_name__",n=UrlTemplate.parse(`{${i}${t}}`);return decodeURIComponent(n.expand({[i]:r}))}export function urlFormEncodePayload(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((t=>{const i=e[t],{style:n="form",explode:o=!0}=r[t]||{};switch(n){case"form":return serializeFormValue(t,o,i);case"spaceDelimited":return delimitedEncodeField(i,t,"%20");case"pipeDelimited":return delimitedEncodeField(i,t,"|");case"deepObject":return deepObjectEncodeField(i,t);default:return console.warn("Incorrect or unsupported encoding style: "+n),""}})).join("&")}function serializePathParameter(e,r,t,i){const n=t?"*":"";let o="";"label"===r?o=".":"matrix"===r&&(o=";");const a="__redoc_param_name__";return UrlTemplate.parse(`{${o}${a}${n}}`).expand({[a]:i}).replace(/__redoc_param_name__/g,e)}export function serializeQueryParameter(e,r,t,i){const n=n=>{switch(r){case"form":return serializeFormValue(e,t,n);case"spaceDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("%20")}`:(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("|")}`:(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!t||Array.isArray(n)||"object"!=typeof n?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(n,e);case"simple":return serializeSimpleValue(t,i);default:return console.warn("Unexpected style for query: "+r),""}};return isArrayOfObjects(i)&&(i=deleteEmptyArrayItem(i).map((e=>n(e)))),n(i)}function serializeHeaderParameter(e,r,t){return"simple"===e?serializeSimpleValue(r,t):(console.warn("Unexpected style for header: "+e),"")}function serializeCookieParameter(e,r,t,i){return"form"===r?serializeFormValue(e,t,i):(console.warn("Unexpected style for cookie: "+r),"")}export function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}export function serializeParameterValue(e,r){const{name:t,style:i,explode:n=!1,serializationMime:o}=e;if(o)switch(e.in){case"path":case"header":return serializeParameterValueWithMime(r,o);case"cookie":case"query":return`${t}=${serializeParameterValueWithMime(r,o)}`;default:return console.warn("Unexpected parameter location: "+e.in),""}if(!i)return console.warn(`Missing style attribute or content for parameter ${t}`),"";switch(e.in){case"path":return serializePathParameter(t,i,n,r);case"query":return serializeQueryParameter(t,i,n,r);case"header":return serializeHeaderParameter(i,n,r);case"cookie":return serializeCookieParameter(t,i,n,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}export function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}const DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;export function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}export function getDefinitionName(e){var r;return null===(r=null==e?void 0:e.match(DEFINITION_NAME_REGEX))||void 0===r?void 0:r.pop()}function humanizeMultipleOfConstraint(e){if(void 0===e)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function humanizeRangeConstraint(e,r,t){let i;return void 0!==r&&void 0!==t?i=r===t?`= ${r} ${e}`:`[ ${r} .. ${t} ] ${e}`:void 0!==t?i=`<= ${t} ${e}`:void 0!==r&&(i=1===r?"non-empty":`>= ${r} ${e}`),i}export function humanizeNumberRange(e){var r,t;const i="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!==(r=e.minimum)&&void 0!==r?r:1/0):e.minimum,n="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!==(t=e.maximum)&&void 0!==t?t:-1/0):e.maximum,o="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,a="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?`${o?"( ":"[ "}${i} .. ${n}${a?" )":" ]"}`:void 0!==n?`${a?"< ":"<= "}${n}`:void 0!==i?`${o?"> ":">= "}${i}`:void 0}export function humanizeConstraints(e){const r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);const i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);const n=humanizeRangeConstraint("properties",e.minProperties,e.maxProperties);void 0!==n&&r.push(n);const o=humanizeMultipleOfConstraint(e.multipleOf);void 0!==o&&r.push(o);const a=humanizeNumberRange(e);return void 0!==a&&r.push(a),e.uniqueItems&&r.push("unique"),r}export function sortByRequired(e,r=[]){const t=[],i=[],n=[];return e.forEach((e=>{e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort(((e,t)=>r.indexOf(e.name)-r.indexOf(t.name))),[...i,...n,...t]}export function sortByField(e,r){return[...e].sort(((e,t)=>e[r].localeCompare(t[r])))}export function mergeParams(e,r=[],t=[]){const i={};return t.forEach((r=>{({resolved:r}=e.deref(r)),i[r.name+"_"+r.in]=!0})),(r=r.filter((r=>(({resolved:r}=e.deref(r)),!i[r.name+"_"+r.in])))).concat(t)}export function mergeSimilarMediaTypes(e){const r={};return Object.keys(e).forEach((t=>{const i=e[t],n=t.split(";")[0].trim();r[n]?r[n]=Object.assign(Object.assign({},r[n]),i):r[n]=i})),r}export function expandDefaultServerVariables(e,r={}){return e.replace(/(?:{)([\w-.]+)(?:})/g,((e,t)=>r[t]&&r[t].default||e))}export function normalizeServers(e,r){const t=void 0===e?removeQueryStringAndHash((()=>{if(!IS_BROWSER)return"";const e=window.location.href;return e.endsWith(".html")?dirname(e):e})()):dirname(e);return 0===r.length&&(r=[{url:"/"}]),r.map((e=>{return Object.assign(Object.assign({},e),{url:(r=e.url,resolveUrl(t,r)),description:e.description||""});var r}))}export const SECURITY_DEFINITIONS_COMPONENT_NAME="security-definitions";export const SECURITY_DEFINITIONS_JSX_NAME="SecurityDefinitions";export const SCHEMA_DEFINITION_JSX_NAME="SchemaDefinition";export const shortenHTTPVerb=e=>({delete:"del",options:"opts"}[e]||e);export function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-hideTryItPanel":!0,"x-tokenEndpointAuthMethod":!0}}export function extractExtensions(e,r){return Object.keys(e).filter((e=>!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1)).reduce(((r,t)=>(r[t]=e[t],r)),{})}export function pluralizeType(e){return e.split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or ")}export function getContentWithLegacyExamples(e){let r=e.content;const t=e["x-examples"],i=e["x-example"];if(t){r=Object.assign({},r);for(const e of Object.keys(t)){const i=t[e];r[e]=Object.assign(Object.assign({},r[e]),{examples:i})}}else if(i){r=Object.assign({},r);for(const e of Object.keys(i)){const t=i[e];r[e]=Object.assign(Object.assign({},r[e]),{example:t})}}return r}
+//# sourceMappingURL=openapi.js.map

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

@@ -0,0 +1,2 @@
+export declare function getParameterValue(_in: string, name: string): string | null;
+export declare function setParameterValue(_in: string, name: string, value: GenericObject): void;

package/lib-esm/utils/parameters.js

@@ -0,0 +1,2 @@
+import{fromSessionStorage,toSessionStorage}from"./session-storage";export function getParameterValue(e,r){try{return JSON.parse(fromSessionStorage(`${e}.${r}`))}catch(e){return null}}export function setParameterValue(e,r,t){toSessionStorage(`${e}.${r}`,JSON.stringify(t))}
+//# sourceMappingURL=parameters.js.map

package/lib-esm/utils/security-details.d.ts

@@ -0,0 +1,13 @@
+import type { SecurityDetails } from '../types';
+export declare function setSecurityDetailsVariants(name: string, variants: {
+    label: string;
+    details: SecurityDetails | string;
+}[]): void;
+export declare function getSecurityDetails(name: string): SecurityDetails & {
+    raw: string;
+};
+export declare function setSecurityDetails(name: string, details: SecurityDetails | string): void;
+export declare function getSecurityDetailsOptions(name: string, fieldName: string): Array<{
+    label: string;
+    value: string;
+}> | null;

package/lib-esm/utils/security-details.js

@@ -0,0 +1,2 @@
+import{escapeFormId}from"./string";import{fromSessionStorage,toSessionStorage}from"./session-storage";export function setSecurityDetailsVariants(e,t){e=escapeFormId(e),toSessionStorage(`auth.${e}.variants`,JSON.stringify(t))}export function getSecurityDetails(e){e=escapeFormId(e);const t=fromSessionStorage(`auth.${e}`),s=fromSessionStorage(`auth.${e}.token`);return{raw:t,password:fromSessionStorage(`auth.${e}.password`),username:fromSessionStorage(`auth.${e}.username`),token:s&&JSON.parse(s)||null,client_id:fromSessionStorage(`auth.${e}.client_id`),client_secret:fromSessionStorage(`auth.${e}.client_secret`),scopes:fromSessionStorage(`auth.${e}.scopes`)}}export function setSecurityDetails(e,t){e=escapeFormId(e),"string"==typeof t?toSessionStorage("auth."+e,t):t&&(toSessionStorage(`auth.${e}.password`,t.password||""),toSessionStorage(`auth.${e}.username`,t.username||""),toSessionStorage(`auth.${e}.token`,t.token&&JSON.stringify(t.token)||""),toSessionStorage(`auth.${e}.client_id`,t.client_id||""),toSessionStorage(`auth.${e}.client_secret`,t.client_secret||""),toSessionStorage(`auth.${e}.scopes`,t.scopes&&JSON.stringify(t.scopes)||""))}export function getSecurityDetailsOptions(e,t){e=escapeFormId(e);const s=fromSessionStorage(`auth.${e}.variants`);if(!s)return null;const o=JSON.parse(s);return o&&Array.isArray(o)?o.map((e=>e.details?""===t&&e.details&&"string"==typeof e.details?{label:e.label,value:e.details}:"object"==typeof e.details?{label:e.label,value:e.details[t]}:null:null)).filter(notNull):null}function notNull(e){return null!==e}
+//# sourceMappingURL=security-details.js.map

package/lib-esm/utils/session-storage.d.ts

@@ -0,0 +1,2 @@
+export declare function toSessionStorage(key: string, value: string): void;
+export declare function fromSessionStorage<T extends string>(key: string): T;

package/lib-esm/utils/session-storage.js

@@ -0,0 +1,2 @@
+import{IS_BROWSER}from"./dom";export function toSessionStorage(o,e){IS_BROWSER&&window.sessionStorage.setItem("redoc."+o,e)}export function fromSessionStorage(o){return IS_BROWSER&&window.sessionStorage.getItem("redoc."+o)||""}
+//# sourceMappingURL=session-storage.js.map