@redocly/openapi-docs 0.0.0-new-redoc-20240202162301

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

@@ -0,0 +1,353 @@
+import type { Sample } from '../models';
+export interface OpenAPIDefinition {
+    openapi: string;
+    info: OpenAPIInfo;
+    servers?: OpenAPIServer[];
+    paths: OpenAPIPaths;
+    components?: OpenAPIComponents;
+    security?: OpenAPISecurityRequirement[];
+    tags?: OpenAPITag[];
+    externalDocs?: OpenAPIExternalDocumentation;
+    webhooks?: OpenAPIPaths;
+    'x-webhooks'?: OpenAPIPaths;
+    'x-tagGroups'?: Array<{
+        name: string;
+        tags: Array<string>;
+    }>;
+    'x-feedback'?: any;
+}
+export interface OpenAPIInfo extends ParsedDescriptionWithSummary {
+    title: string;
+    version: string;
+    description?: string;
+    summary?: string;
+    termsOfService?: string;
+    contact?: OpenAPIContact;
+    license?: OpenAPILicense;
+    'x-logo'?: XLogo;
+    'x-metadata'?: XMetadata;
+    'x-seo'?: XSEO;
+}
+export interface XLogo {
+    url?: string;
+    backgroundColor?: string;
+    altText?: string;
+    href?: string;
+}
+export interface XMetadata {
+    apiId?: string;
+    [key: string]: unknown;
+}
+export interface XSEO {
+    title?: string;
+}
+export interface OpenAPIServer extends ParsedDescription {
+    url: string;
+    description?: string;
+    variables?: {
+        [name: string]: OpenAPIServerVariable;
+    };
+}
+export interface OpenAPIServerVariable extends ParsedDescription {
+    enum?: string[];
+    default: string;
+    description?: string;
+}
+export interface OpenAPIPaths {
+    [path: string]: OpenAPIPath;
+}
+export interface OpenAPIRef extends ParsedDescriptionWithSummary {
+    $ref: string;
+    'x-refsStack'?: string[];
+    summary?: string;
+    description?: string;
+}
+export type Referenced<T> = T | OpenAPIRef;
+export interface OpenAPIPath extends Partial<OpenAPIRef>, ParsedDescriptionWithSummary {
+    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 extends ParsedDescriptionWithSummary {
+    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 extends ParsedDescription {
+    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 extends ParsedDescriptionWithSummary {
+    value: any;
+    summary?: string;
+    description?: string;
+    externalValue?: string;
+}
+export interface OpenAPISchema extends ParsedDescription {
+    $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 extends ParsedDescription {
+    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 extends ParsedDescription {
+    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 extends ParsedDescription {
+    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 extends ParsedDescription {
+    name: string;
+    description?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    'x-displayName'?: string;
+}
+export interface OpenAPIExternalDocumentation extends ParsedDescription {
+    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;
+}
+export interface ParsedDescription {
+    'x-parsed-md-description'?: GenericObject;
+}
+export interface ParsedDescriptionWithSummary extends ParsedDescription {
+    'x-parsed-md-summary'?: GenericObject;
+}

package/lib/types/open-api.js

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

package/lib/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/types/security.js

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

package/lib/types/server.d.ts

@@ -0,0 +1,7 @@
+export interface ServerVariables {
+    [name: string]: string;
+}
+export interface Server {
+    url: string;
+    variables: ServerVariables;
+}

package/lib/types/server.js

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

package/lib/utils/JsonPointer.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Wrapper for JsonPointer. Provides common operations
+ */
+export declare class JsonPointer {
+    /**
+     * returns last JsonPointer token
+     * if level > 1 returns levels last (second last/third last)
+     * @example
+     * // returns subpath
+     * JsonPointerHelper.baseName('/path/0/subpath')
+     * // returns foo
+     * JsonPointerHelper.baseName('/path/foo/subpath', 2)
+     */
+    static baseName(pointer?: string, level?: number): string;
+    /**
+     * returns dirname of pointer
+     * if level > 1 returns corresponding dirname in the hierarchy
+     * @example
+     * // returns /path/0
+     * JsonPointerHelper.dirName('/path/0/subpath')
+     * // returns /path
+     * JsonPointerHelper.dirName('/path/foo/subpath', 2)
+     */
+    static dirName(pointer: string, level?: number): string;
+    /**
+     * returns relative path tokens
+     * @example
+     * // returns ['subpath']
+     * JsonPointerHelper.relative('/path/0', '/path/0/subpath')
+     * // returns ['foo', 'subpath']
+     * JsonPointerHelper.relative('/path', '/path/foo/subpath')
+     */
+    static relative(from: string, to: string): string[];
+    /**
+     * overridden JsonPointer original parse to take care of prefixing '#' symbol
+     * that is not valid JsonPointer
+     */
+    static parse(pointer?: string): string[];
+    /**
+     * Creates a JSON pointer path, by joining one or more tokens to a base path.
+     *
+     * @param {string} base - The base path
+     * @param {string|string[]} tokens - The token(s) to append (e.g. ["name", "first"])
+     * @returns {string}
+     */
+    static join(base: string, tokens: string | string[]): string;
+    static get<T>(object: GenericObject, pointer: string): T;
+    static compile(tokens: string[]): string;
+    static escape(pointer: string): string;
+}
+export default JsonPointer;

package/lib/utils/JsonPointer.js

@@ -0,0 +1,2 @@
+"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.JsonPointer=void 0;const json_pointer_1=__importDefault(require("json-pointer")),origParse=json_pointer_1.default.parse;class JsonPointer{static baseName(e="",t=1){const r=JsonPointer.parse(e);return r[r.length-t]}static dirName(e,t=1){const r=JsonPointer.parse(e);return json_pointer_1.default.compile(r.slice(0,r.length-t))}static relative(e,t){const r=JsonPointer.parse(e);return JsonPointer.parse(t).slice(r.length)}static parse(e=""){let t=e;return"#"===t.charAt(0)&&(t=t.substring(1)),origParse(t)}static join(e,t){const r=JsonPointer.parse(e).concat(t);return json_pointer_1.default.compile(r)}static get(e,t){return json_pointer_1.default.get(e,t)}static compile(e){return json_pointer_1.default.compile(e)}static escape(e){return json_pointer_1.default.escape(e)}}exports.JsonPointer=JsonPointer,json_pointer_1.default.parse=JsonPointer.parse,Object.assign(JsonPointer,json_pointer_1.default),exports.default=JsonPointer;
+//# sourceMappingURL=JsonPointer.js.map

package/lib/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/utils/argValuesHelpers.js

@@ -0,0 +1,2 @@
+"use strict";function argValueToBoolean(e,a){return void 0===e?a||!1:"string"==typeof e?"false"!==e:e}function argValueToNumber(e,a=0){return"string"==typeof e?parseInt(e,10):"number"==typeof e?e:a}function argValueToInt(e,a=0){return"string"==typeof e?parseInt(e,10):"number"==typeof e?Math.ceil(e):a}function argValueToExpandLevel(e,a=0){return"all"===e?1/0:argValueToInt(e,a)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.argValueToExpandLevel=exports.argValueToInt=exports.argValueToNumber=exports.argValueToBoolean=void 0,exports.argValueToBoolean=argValueToBoolean,exports.argValueToNumber=argValueToNumber,exports.argValueToInt=argValueToInt,exports.argValueToExpandLevel=argValueToExpandLevel;
+//# sourceMappingURL=argValuesHelpers.js.map

package/lib/utils/compose.d.ts

@@ -0,0 +1 @@
+export declare const compose: <T>(fn1: (a: T) => T, ...fns: ((a: T) => T)[]) => (a: T) => T;

package/lib/utils/compose.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.compose=void 0;const compose=(e,...o)=>o.reduce(((e,o)=>s=>e(o(s))),e);exports.compose=compose;
+//# sourceMappingURL=compose.js.map

package/lib/utils/createParsedDocument.d.ts

@@ -0,0 +1,2 @@
+import type { Document } from '@redocly/openapi-core';
+export declare function createParsedDocument(specUrlOrObject: GenericObject | string): Document;

package/lib/utils/createParsedDocument.js

@@ -0,0 +1,2 @@
+"use strict";function createParsedDocument(e){return{source:{absoluteRef:""},parsed:e}}Object.defineProperty(exports,"__esModule",{value:!0}),exports.createParsedDocument=void 0,exports.createParsedDocument=createParsedDocument;
+//# sourceMappingURL=createParsedDocument.js.map

package/lib/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/utils/debounce.js

@@ -0,0 +1,2 @@
+"use strict";function debounce(e,o,t){let u,n=0;return function(...c){n++,u?clearTimeout(u):t&&e(...c),u=setTimeout((function(){n>1&&e(...c),n=0,u=null}),o)}}Object.defineProperty(exports,"__esModule",{value:!0}),exports.debounce=void 0,exports.debounce=debounce;
+//# sourceMappingURL=debounce.js.map

package/lib/utils/debug.d.ts

@@ -0,0 +1,2 @@
+export declare function debugTime(label: string): void;
+export declare function debugTimeEnd(label: string): void;

package/lib/utils/debug.js

@@ -0,0 +1,2 @@
+"use strict";function debugTime(e){"production"!==process.env.NODE_ENV&&console.time(e)}function debugTimeEnd(e){"production"!==process.env.NODE_ENV&&console.timeEnd(e)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.debugTimeEnd=exports.debugTime=void 0,exports.debugTime=debugTime,exports.debugTimeEnd=debugTimeEnd;
+//# sourceMappingURL=debug.js.map

package/lib/utils/dom.d.ts

@@ -0,0 +1,7 @@
+export declare function querySelector(selector: string): Element | null;
+/**
+ * Drop everything inside <...> (i.e., tags/elements), and keep the text.
+ * Unlike browser innerText, this removes newlines; it also doesn't handle
+ * un-encoded `<` or `>` characters very well, so don't feed it malformed HTML
+ */
+export declare function html2Str(html: string): string;

package/lib/utils/dom.js

@@ -0,0 +1,2 @@
+"use strict";function querySelector(t){return"undefined"!=typeof document?document.querySelector(t):null}function html2Str(t){return t.split(/<[^>]+>/).map((t=>t.trim())).filter((t=>t.length>0)).join(" ")}Object.defineProperty(exports,"__esModule",{value:!0}),exports.html2Str=exports.querySelector=void 0,exports.querySelector=querySelector,exports.html2Str=html2Str,"undefined"==typeof Element||Element.prototype.scrollIntoViewIfNeeded||(Element.prototype.scrollIntoViewIfNeeded=function(t){t=0===arguments.length||!!t;const e=this.parentNode,o=window.getComputedStyle(e,void 0),l=parseInt(o.getPropertyValue("border-top-width"),10),r=parseInt(o.getPropertyValue("border-left-width"),10),i=this.offsetTop-e.offsetTop<e.scrollTop,f=this.offsetTop-e.offsetTop+this.clientHeight-l>e.scrollTop+e.clientHeight,s=this.offsetLeft-e.offsetLeft<e.scrollLeft,n=this.offsetLeft-e.offsetLeft+this.clientWidth-r>e.scrollLeft+e.clientWidth,c=i&&!f;(i||f)&&t&&(e.scrollTop=this.offsetTop-e.offsetTop-e.clientHeight/2-l+this.clientHeight/2),(s||n)&&t&&(e.scrollLeft=this.offsetLeft-e.offsetLeft-e.clientWidth/2-r+this.clientWidth/2),(i||f||s||n)&&!t&&this.scrollIntoView(c)});
+//# sourceMappingURL=dom.js.map

package/lib/utils/getInitialServerWithVariables.d.ts

@@ -0,0 +1,2 @@
+import type { OpenAPIServer, Server } from '../types';
+export declare function getInitialServerWithVariables(operationServers: OpenAPIServer[]): Server;

package/lib/utils/getInitialServerWithVariables.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getInitialServerWithVariables=void 0;const session_storage_1=require("./session-storage");function getInitialServerWithVariables(e){const r=(0,session_storage_1.fromSessionStorage)("serverUrl"),s=e.find((e=>e.url===r))||e[0],t=getDefaultOrStoredVariables(s);return Object.assign(Object.assign({},s),{variables:t})}function getDefaultOrStoredVariables(e){if(!(null==e?void 0:e.variables))return{};const r=(0,session_storage_1.fromSessionStorage)("variables"),s=r&&JSON.parse(r)||{},t={};return Object.entries(e.variables||{}).forEach((([e,r])=>{t[e]=s[e]||r.default||""})),t}exports.getInitialServerWithVariables=getInitialServerWithVariables;
+//# sourceMappingURL=getInitialServerWithVariables.js.map

package/lib/utils/helpers.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 isArrayOfObjects: (items: unknown) => items is [];
+export declare const deleteEmptyArrayItem: (items: unknown[]) => unknown[];
+export declare const isMergeableObject: (item: unknown) => boolean;
+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 useSchemaTitle(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;
+export declare const normalizeText: (text?: string | GenericObject) => string;
+export declare const getValueFromMdParsedExtension: (item: GenericObject, key: 'description' | 'summary' | 'x-summary' | 'x-enumDescriptions') => any;
+export declare function isLastInArray(arr: Array<unknown>, index: number): boolean;
+export declare function isLastProperty(obj: Object, key: string): boolean;

package/lib/utils/helpers.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.isLastProperty=exports.isLastInArray=exports.getValueFromMdParsedExtension=exports.normalizeText=exports.getJsUrl=exports.getWindowReferenceOptions=exports.dottedString=exports.joinStringFactory=exports.get=exports.useSchemaTitle=exports.sanitizeItemId=exports.unescapeHTMLChars=exports.escapeHTMLAttrChars=exports.removeQueryStringAndHash=exports.titleize=exports.getBasePath=exports.resolveUrl=exports.isAbsoluteUrl=exports.isMergeableObject=exports.deleteEmptyArrayItem=exports.isArrayOfObjects=exports.appendToMdHeading=exports.isNumeric=exports.stripTrailingSlash=exports.flattenByProp=exports.mapValues=exports.mapWithLast=void 0;const url_1=require("url"),theme_1=require("@redocly/theme"),openapi_1=require("./openapi"),JsonPointer_1=require("./JsonPointer");function mapWithLast(e,t){const r=[];for(let s=0;s<e.length-1;s++)r.push(t(e[s],!1));return 0!==e.length&&r.push(t(e[e.length-1],!0)),r}function mapValues(e,t){const r={};for(const s in e)Object.prototype.hasOwnProperty.call(e,s)&&(r[s]=t(e[s],s,e));return r}function flattenByProp(e,t){const r=[],s=e=>{for(const n of e)r.push(n),n[t]&&s(n[t])};return s(e),r}function stripTrailingSlash(e){return e.endsWith("/")?e.substring(0,e.length-1):e}function isNumeric(e){return!isNaN(parseFloat(e))&&isFinite(e)}function appendToMdHeading(e,t,r){const s=new RegExp(`(^|\\n)#\\s?${t}\\s*\\n`,"i"),n=new RegExp(`((\\n|^)#\\s*${t}\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)`,"i");if(s.test(e))return e.replace(n,`$1\n\n${r}\n$4`);{const s=""===e||e.endsWith("\n\n")?"":e.endsWith("\n")?"\n":"\n\n";return`${e}${s}# ${t}\n\n${r}`}}exports.mapWithLast=mapWithLast,exports.mapValues=mapValues,exports.flattenByProp=flattenByProp,exports.stripTrailingSlash=stripTrailingSlash,exports.isNumeric=isNumeric,exports.appendToMdHeading=appendToMdHeading;const isArrayOfObjects=e=>Array.isArray(e)&&e.some((e=>(0,theme_1.isObject)(e)));exports.isArrayOfObjects=isArrayOfObjects;const deleteEmptyArrayItem=e=>e.filter((e=>!!e));exports.deleteEmptyArrayItem=deleteEmptyArrayItem;const isMergeableObject=e=>(0,theme_1.isObject)(e)&&!Array.isArray(e);function isAbsoluteUrl(e){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(e)}function resolveUrl(e,t){let r;if(t.startsWith("//")){const{protocol:s}=(0,url_1.parse)(e);r=`${s||"https:"}${t}`}else if(isAbsoluteUrl(t))r=t;else if(t.startsWith("/")){const s=(0,url_1.parse)(e);r=(0,url_1.format)(Object.assign(Object.assign({},s),{pathname:t}))}else r=stripTrailingSlash(e)+"/"+t;return stripTrailingSlash(r)}function getBasePath(e){try{return parseURL(e).pathname}catch(t){return e}}function titleize(e){return e.charAt(0).toUpperCase()+e.slice(1)}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)}function escapeHTMLAttrChars(e){return e.replace(/["\\]/g,"\\$&")}function unescapeHTMLChars(e){return e.replace(/&#(\d+);/g,((e,t)=>String.fromCharCode(parseInt(t,10)))).replace(/&amp;/g,"&").replace(/&quot;/g,'"')}function sanitizeItemId(e){return e&&e.replace(/#/g,"_")}function useSchemaTitle(e,t){return t||(0,openapi_1.isNamedDefinition)(e)&&JsonPointer_1.JsonPointer.baseName(e)||""}function get(e={},t,r){return"string"==typeof t&&(t=t.split(".")),t.reduce(((e,t)=>e&&e[t]?e[t]:r),e)}function joinStringFactory(e){return(...t)=>t.filter(Boolean).join(e)}function getWindowReferenceOptions(e){var t;return theme_1.IS_BROWSER?null===(t=null===window||void 0===window?void 0:window.REFERENCE_DOCS_OPTIONS)||void 0===t?void 0:t[e]:null}function getJsUrl(){var e;if(!theme_1.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""}}exports.isMergeableObject=isMergeableObject,exports.isAbsoluteUrl=isAbsoluteUrl,exports.resolveUrl=resolveUrl,exports.getBasePath=getBasePath,exports.titleize=titleize,exports.removeQueryStringAndHash=removeQueryStringAndHash,exports.escapeHTMLAttrChars=escapeHTMLAttrChars,exports.unescapeHTMLChars=unescapeHTMLChars,exports.sanitizeItemId=sanitizeItemId,exports.useSchemaTitle=useSchemaTitle,exports.get=get,exports.joinStringFactory=joinStringFactory,exports.dottedString=joinStringFactory("."),exports.getWindowReferenceOptions=getWindowReferenceOptions,exports.getJsUrl=getJsUrl;const normalizeText=e=>(0,theme_1.isString)(e)?e:null==e?void 0:e.raw;exports.normalizeText=normalizeText;const getValueFromMdParsedExtension=(e,t)=>{const r=e[`x-parsed-md-${t}`]||e[t];if("x-enumDescriptions"!==t)return r;let s={};for(const e in r)e.startsWith("x-parsed-md")||(s[e]=r[`x-parsed-md-${e}`]||r[e]);return Object.keys(s).length?s:r};function isLastInArray(e,t){return t===e.length-1}function isLastProperty(e,t){const r=Object.keys(e);return r.indexOf(t)===r.length-1}exports.getValueFromMdParsedExtension=getValueFromMdParsedExtension,exports.isLastInArray=isLastInArray,exports.isLastProperty=isLastProperty;
+//# sourceMappingURL=helpers.js.map

package/lib/utils/highlight.d.ts

@@ -0,0 +1,31 @@
+import 'prismjs/components/prism-bash.js';
+import 'prismjs/components/prism-c.js';
+import 'prismjs/components/prism-clike.js';
+import 'prismjs/components/prism-coffeescript.js';
+import 'prismjs/components/prism-cpp.js';
+import 'prismjs/components/prism-csharp.js';
+import 'prismjs/components/prism-go.js';
+import 'prismjs/components/prism-http.js';
+import 'prismjs/components/prism-java.js';
+import 'prismjs/components/prism-lua.js';
+import 'prismjs/components/prism-markup-templating.js';
+import 'prismjs/components/prism-markup.js';
+import 'prismjs/components/prism-objectivec.js';
+import 'prismjs/components/prism-perl.js';
+import 'prismjs/components/prism-php.js';
+import 'prismjs/components/prism-python.js';
+import 'prismjs/components/prism-ruby.js';
+import 'prismjs/components/prism-scala.js';
+import 'prismjs/components/prism-sql.js';
+import 'prismjs/components/prism-swift.js';
+/**
+ * map language names to Prism.js names
+ */
+export declare function mapLang(lang: string): string;
+/**
+ * Highlight source code string using Prism.js
+ * @param source source code to highlight
+ * @param lang highlight language
+ * @return highlighted source code as **html string**
+ */
+export declare function highlight(source: string | number | boolean, lang?: string): string;

package/lib/utils/highlight.js

@@ -0,0 +1,2 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,s,i){void 0===i&&(i=s);var t=Object.getOwnPropertyDescriptor(r,s);t&&!("get"in t?!r.__esModule:t.writable||t.configurable)||(t={enumerable:!0,get:function(){return r[s]}}),Object.defineProperty(e,i,t)}:function(e,r,s,i){void 0===i&&(i=s),e[i]=r[s]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,r){Object.defineProperty(e,"default",{enumerable:!0,value:r})}:function(e,r){e.default=r}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var r={};if(null!=e)for(var s in e)"default"!==s&&Object.prototype.hasOwnProperty.call(e,s)&&__createBinding(r,e,s);return __setModuleDefault(r,e),r};Object.defineProperty(exports,"__esModule",{value:!0}),exports.highlight=exports.mapLang=void 0;const Prism=__importStar(require("prismjs"));require("prismjs/components/prism-bash.js"),require("prismjs/components/prism-c.js"),require("prismjs/components/prism-clike.js"),require("prismjs/components/prism-coffeescript.js"),require("prismjs/components/prism-cpp.js"),require("prismjs/components/prism-csharp.js"),require("prismjs/components/prism-go.js"),require("prismjs/components/prism-http.js"),require("prismjs/components/prism-java.js"),require("prismjs/components/prism-lua.js"),require("prismjs/components/prism-markup-templating.js"),require("prismjs/components/prism-markup.js"),require("prismjs/components/prism-objectivec.js"),require("prismjs/components/prism-perl.js"),require("prismjs/components/prism-php.js"),require("prismjs/components/prism-python.js"),require("prismjs/components/prism-ruby.js"),require("prismjs/components/prism-scala.js"),require("prismjs/components/prism-sql.js"),require("prismjs/components/prism-swift.js");const DEFAULT_LANG="clike";function mapLang(e){return{json:"js","c++":"cpp","c#":"csharp","objective-c":"objectivec",shell:"bash",viml:"vim",curl:"bash","node.js":"js"}[e]||DEFAULT_LANG}function highlight(e,r=DEFAULT_LANG){r=r.toLowerCase();let s=Prism.languages[r];return s||(s=Prism.languages[mapLang(r)]),Prism.highlight(e.toString(),s,r)}Prism.languages.insertBefore("javascript","string",{"property string":{pattern:/([{,]\s*)"(?:\\.|[^\\"\r\n])*"(?=\s*:)/i,lookbehind:!0}},void 0),Prism.languages.insertBefore("javascript","punctuation",{property:{pattern:/([{,]\s*)[a-z]\w*(?=\s*:)/i,lookbehind:!0}},void 0),exports.mapLang=mapLang,exports.highlight=highlight;
+//# sourceMappingURL=highlight.js.map

package/lib/utils/index.d.ts

@@ -0,0 +1,21 @@
+export * from './JsonPointer';
+export * from './openapi';
+export * from './helpers';
+export * from './highlight';
+export * from './dom';
+export * from './debug';
+export * from './sort';
+export * from './argValuesHelpers';
+export * from './theme-helpers';
+export * from './debounce';
+export * from './security-details';
+export * from './session-storage';
+export * from './local-storage';
+export * from './parameters';
+export * from './string';
+export * from './test-utils';
+export * from './compose';
+export * from './saveTextBeforeHeading';
+export * from './path';
+export * from './queryString';
+export * from './getInitialServerWithVariables';

package/lib/utils/index.js

@@ -0,0 +1,2 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var i=Object.getOwnPropertyDescriptor(r,t);i&&!("get"in i?!r.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,i)}: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("./JsonPointer"),exports),__exportStar(require("./openapi"),exports),__exportStar(require("./helpers"),exports),__exportStar(require("./highlight"),exports),__exportStar(require("./dom"),exports),__exportStar(require("./debug"),exports),__exportStar(require("./sort"),exports),__exportStar(require("./argValuesHelpers"),exports),__exportStar(require("./theme-helpers"),exports),__exportStar(require("./debounce"),exports),__exportStar(require("./security-details"),exports),__exportStar(require("./session-storage"),exports),__exportStar(require("./local-storage"),exports),__exportStar(require("./parameters"),exports),__exportStar(require("./string"),exports),__exportStar(require("./test-utils"),exports),__exportStar(require("./compose"),exports),__exportStar(require("./saveTextBeforeHeading"),exports),__exportStar(require("./path"),exports),__exportStar(require("./queryString"),exports),__exportStar(require("./getInitialServerWithVariables"),exports);
+//# sourceMappingURL=index.js.map

package/lib/utils/loadAndBundleSpec.d.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIDefinition } from '../types';
+export declare function loadAndBundleDefinition(specUrlOrObject: GenericObject | string): Promise<OpenAPIDefinition>;
+export declare function convertSwagger2OpenAPI(spec: GenericObject): Promise<OpenAPIDefinition>;

package/lib/utils/loadAndBundleSpec.js

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