redoc 2.5.1 → 3.0.0-rc.0

package/typings/utils/helpers.d.ts

@@ -1,43 +0,0 @@
-/**
- * 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 object, P extends keyof T>(collectionItems: T[], prop: P): T[];
-export declare function stripTrailingSlash(path: string): string;
-export declare function isNumeric(n: any): n is number;
-export declare function appendToMdHeading(md: string, heading: string, content: string): string;
-export declare const mergeObjects: (target: any, ...sources: any[]) => any;
-export declare const isObject: (item: unknown) => item is Record<string, unknown>;
-/**
- * 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 isArray(value: unknown): value is any[];
-export declare function isBoolean(value: unknown): value is boolean;

package/typings/utils/highlight.d.ts

@@ -1,34 +0,0 @@
-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-q.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';
-import 'prismjs/components/prism-yaml.js';
-import 'prismjs/components/prism-csv.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/typings/utils/index.d.ts

@@ -1,10 +0,0 @@
-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';

package/typings/utils/jsonToHtml.d.ts

@@ -1 +0,0 @@
-export declare function jsonToHTML(json: any, maxExpandLevel: any): string;

package/typings/utils/loadAndBundleSpec.d.ts

@@ -1,3 +0,0 @@
-import { OpenAPISpec } from '../types';
-export declare function loadAndBundleSpec(specUrlOrObject: object | string): Promise<OpenAPISpec>;
-export declare function convertSwagger2OpenAPI(spec: any): Promise<OpenAPISpec>;

package/typings/utils/memoize.d.ts

@@ -1 +0,0 @@
-export declare function memoize<T>(target: any, name: string, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T>;

package/typings/utils/openapi.d.ts

@@ -1,43 +0,0 @@
-import { ExtendedOpenAPIOperation } from '../services';
-import { FieldModel } from '../services/models';
-import { OpenAPIParser } from '../services/OpenAPIParser';
-import { OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameter, OpenAPIRequestBody, OpenAPIResponse, OpenAPISchema, OpenAPIServer, Referenced } 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): any;
-export declare function isJsonLike(contentType: string): boolean;
-export declare function isFormUrlEncoded(contentType: string): boolean;
-export declare function urlFormEncodePayload(payload: object, encoding?: {
-    [field: string]: OpenAPIEncoding;
-}): string;
-export declare function serializeParameterValueWithMime(value: any, mime: string): string;
-export declare function serializeParameterValue(parameter: (OpenAPIParameter & {
-    serializationMime?: string;
-}) | FieldModel, value: any): string;
-export declare function getSerializedValue(field: FieldModel, example: any): any;
-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[]): FieldModel[];
-export declare function sortByField(fields: FieldModel[], param: keyof Pick<FieldModel, 'name' | 'description' | 'kind'>): 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?: object): string;
-export declare function normalizeServers(specUrl: string | undefined, servers: OpenAPIServer[]): OpenAPIServer[];
-export declare const SECURITY_DEFINITIONS_JSX_NAME = "SecurityDefinitions";
-export declare const OLD_SECURITY_DEFINITIONS_JSX_NAME = "security-definitions";
-export declare const SCHEMA_DEFINITION_JSX_NAME = "SchemaDefinition";
-export declare let SECURITY_SCHEMES_SECTION_PREFIX: string;
-export declare function setSecuritySchemePrefix(prefix: string): void;
-export declare const shortenHTTPVerb: (verb: any) => any;
-export declare function isRedocExtension(key: string): boolean;
-export declare function extractExtensions(obj: object, showExtensions: string[] | true): Record<string, any>;
-export declare function pluralizeType(displayType: string): string;
-export declare function getContentWithLegacyExamples(info: OpenAPIRequestBody | OpenAPIResponse): {
-    [mime: string]: OpenAPIMediaType;
-} | undefined;

package/typings/utils/sort.d.ts

@@ -1,6 +0,0 @@
-/**
- * Function that returns a comparator for sorting objects by some specific key alphabetically.
- *
- * @param {String} property key of the object to sort, if starts from `-` - reverse
- */
-export declare function alphabeticallyByProp<T>(property: string): (a: T, b: T) => number;