redoc 3.0.0-rc.3 → 3.0.0

package/bundles/redoc.d.ts

@@ -1,11 +1,8 @@
-import type { AdmonitionProps } from '@redocly/theme/components/Admonition/Admonition';
 import type { AsyncApiConfig } from '@redocly/config';
 import type { EventType } from '@redocly/redoc-opentelemetry';
 import { FC } from 'react';
 import type { GraphQLConfig } from '@redocly/config';
-import type { JSONSchema7 } from 'json-schema';
 import type { LayoutVariant } from '@redocly/config';
-import type { Node as Node_2 } from '@markdoc/markdoc';
 import type { ReactElement } from 'react';
 import type { ReactNode } from 'react';
 import type { RedocConfig } from '@redocly/config';
@@ -20,6 +17,17 @@ declare type AdmonitionNode = {
     content?: string | Node_2[] | Node_2;
 };
 
+declare type AdmonitionProps = Partial<AdmonitionTypeProps> & {
+    name?: string;
+    className?: string;
+    'data-source'?: string;
+    'data-hash'?: string;
+};
+
+declare type AdmonitionTypeProps = {
+    type: 'warning' | 'success' | 'danger' | 'info' | 'idea';
+};
+
 declare type AnalyticsEvent = {
     eventType: AnalyticsEventType;
     resource: 'Redocly_CodeSample' | 'Redocly_Operation';
@@ -105,8 +113,14 @@ declare type ApiStore = {
     /** From OpenAPI `info.x-logo`. Rendered by the standalone sidebar. */
     logo?: SidebarLogo;
     specType?: ApiSpecType;
+    convertedFrom?: string;
 };
 
+declare interface AstType {
+    readonly $$mdtype: 'Function' | 'Node' | 'Variable';
+    resolve(config: Config): any;
+}
+
 declare type AsyncApiExternalDocs = {
     description?: string | Node_2[] | Node_2;
     url: string;
@@ -148,6 +162,12 @@ declare type AsyncApiTag = {
     externalDocs?: AsyncApiExternalDocs;
 };
 
+declare type AttributeValue = {
+    type: string;
+    name: string;
+    value: any;
+};
+
 declare type AvroSchema = {
     type: string | string[] | AvroSchema[];
     name?: string;
@@ -347,6 +367,28 @@ declare type CodeSampleSource = {
     summary?: string;
 };
 
+declare type Config<R = string> = Readonly<ConfigType<R>>;
+
+declare type ConfigFunction = {
+    returns?: ValidationType | ValidationType[];
+    parameters?: Record<string, SchemaAttribute>;
+    transform?(parameters: Record<string, any>, config: Config): any;
+    validate?(fn: Function_2, config: Config): ValidationError[];
+};
+
+declare type ConfigType<R = string> = Partial<{
+    nodes: Partial<Record<NodeType, Schema<ConfigType, R>>>;
+    tags: Record<string, Schema>;
+    variables: Record<string, any>;
+    functions: Record<string, ConfigFunction>;
+    partials: Record<string, any>;
+    validation?: {
+        parents?: Node_2[];
+        validateFunctions?: boolean;
+        environment?: string;
+    };
+}>;
+
 declare type ConnectMcpButtonPanelItem = {
     kind: typeof panelKind.CONNECT_MCP_BUTTON;
     title?: string;
@@ -381,6 +423,16 @@ declare const contentType: {
 /** Promise form of `convertSwaggerToOpenApi`; rejects with the error it throws. */
 export declare const convertSwagger2OpenAPI: (document: Record<string, unknown>) => Promise<OpenAPIDefinition>;
 
+declare interface CustomAttributeType {
+    new (): CustomAttributeTypeInterface;
+    readonly prototype: CustomAttributeTypeInterface;
+}
+
+declare interface CustomAttributeTypeInterface {
+    transform?(value: any, config: Config): Scalar;
+    validate?(value: any, config: Config, name: string): ValidationError[];
+}
+
 declare type DefinitionCodeSample = {
     lang: string;
     label?: string;
@@ -431,7 +483,7 @@ declare type EmptyMessageNode = {
     labelTranslationKey?: string;
 };
 
-declare type EnterpriseOnlyOptionKey = 'licenseKey' | 'hideReplay' | 'mockServer' | 'corsProxyUrl' | 'oAuth2RedirectURI' | 'feedback' | 'hideInfoMetadata' | 'showSchemaCatalogLinks';
+declare type EnterpriseOnlyOptionKey = 'licenseKey' | 'hideReplay' | 'mockServer' | 'corsProxyUrl' | 'oAuth2RedirectURI' | 'feedback' | 'hideInfoMetadata' | 'showSchemaCatalogLinks' | 'servers';
 
 declare type Events = {
     codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
@@ -488,30 +540,24 @@ declare type FormFieldEncoding = {
     style?: string;
     explode?: boolean;
     allowReserved?: boolean;
+    headers?: Record<string, string>;
+    xmlName?: string;
 };
 
+declare class Function_2 implements AstType {
+    readonly $$mdtype = "Function";
+    name: string;
+    parameters: Record<string, any>;
+    constructor(name: string, parameters: Record<string, any>);
+    resolve(config?: Config): any;
+}
+
 declare type GraphQLContact = {
     name?: string;
     url?: string;
     email?: string;
 };
 
-declare type GraphqlFieldData = {
-    name: string;
-    type: string;
-    description?: string | Node_2[] | Node_2;
-    deprecated?: boolean;
-    deprecationReason?: string;
-    defaultValue?: unknown;
-    args?: Array<{
-        name: string;
-        type: string;
-        description?: string | Node_2[] | Node_2;
-        deprecationReason?: string;
-        defaultValue?: unknown;
-    }>;
-};
-
 declare type GraphQLInfo = {
     title?: string;
     version?: string;
@@ -549,12 +595,6 @@ declare type GraphQLResponsePanelItem = BaseExamplePanelItem & {
     graphqlOperationData?: GraphQLOperationData;
 };
 
-declare type GraphqlReturnTypeData = {
-    type: string;
-    description?: string | Node_2[] | Node_2;
-    fields?: GraphqlFieldData[];
-};
-
 declare type GraphqlStoreMeta = {
     rootTypes: {
         query?: string;
@@ -637,7 +677,6 @@ declare type ItemContentNode = {
     schemaId?: string;
     exampleIds?: string[];
     parameters?: ParameterData[];
-    graphqlSchema?: GraphqlFieldData[] | GraphqlReturnTypeData;
     required?: boolean;
     /** Webhook/callback body: the server sends it, so readOnly stays and writeOnly is dropped. */
     isEvent?: boolean;
@@ -756,6 +795,165 @@ declare const itemVariant: {
     readonly MARKDOWN: 'markdown';
 };
 
+declare interface JSONSchema7 {
+    $id?: string | undefined;
+    $ref?: string | undefined;
+    $schema?: JSONSchema7Version | undefined;
+    $comment?: string | undefined;
+
+    /**
+     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.4
+     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#appendix-A
+     */
+    $defs?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
+     */
+    type?: JSONSchema7TypeName | JSONSchema7TypeName[] | undefined;
+    enum?: JSONSchema7Type[] | undefined;
+    const?: JSONSchema7Type | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
+     */
+    multipleOf?: number | undefined;
+    maximum?: number | undefined;
+    exclusiveMaximum?: number | undefined;
+    minimum?: number | undefined;
+    exclusiveMinimum?: number | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
+     */
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
+     */
+    items?: JSONSchema7Definition | JSONSchema7Definition[] | undefined;
+    additionalItems?: JSONSchema7Definition | undefined;
+    maxItems?: number | undefined;
+    minItems?: number | undefined;
+    uniqueItems?: boolean | undefined;
+    contains?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
+     */
+    maxProperties?: number | undefined;
+    minProperties?: number | undefined;
+    required?: string[] | undefined;
+    properties?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    patternProperties?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    additionalProperties?: JSONSchema7Definition | undefined;
+    dependencies?: {
+        [key: string]: JSONSchema7Definition | string[];
+    } | undefined;
+    propertyNames?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
+     */
+    if?: JSONSchema7Definition | undefined;
+    then?: JSONSchema7Definition | undefined;
+    else?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
+     */
+    allOf?: JSONSchema7Definition[] | undefined;
+    anyOf?: JSONSchema7Definition[] | undefined;
+    oneOf?: JSONSchema7Definition[] | undefined;
+    not?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
+     */
+    format?: string | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8
+     */
+    contentMediaType?: string | undefined;
+    contentEncoding?: string | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9
+     */
+    definitions?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
+     */
+    title?: string | undefined;
+    description?: string | undefined;
+    default?: JSONSchema7Type | undefined;
+    readOnly?: boolean | undefined;
+    writeOnly?: boolean | undefined;
+    examples?: JSONSchema7Type | undefined;
+}
+
+declare interface JSONSchema7Array extends Array<JSONSchema7Type> {}
+
+/**
+ * JSON Schema v7
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
+ */
+declare type JSONSchema7Definition = JSONSchema7 | boolean;
+
+declare interface JSONSchema7Object {
+    [key: string]: JSONSchema7Type;
+}
+
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+declare type JSONSchema7Type =
+| string //
+| number
+| boolean
+| JSONSchema7Object
+| JSONSchema7Array
+| null;
+
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+declare type JSONSchema7TypeName =
+| "string" //
+| "number"
+| "integer"
+| "boolean"
+| "object"
+| "array"
+| "null";
+
+/**
+ * Meta schema
+ *
+ * Recommended values:
+ * - 'http://json-schema.org/schema#'
+ * - 'http://json-schema.org/hyper-schema#'
+ * - 'http://json-schema.org/draft-07/schema#'
+ * - 'http://json-schema.org/draft-07/hyper-schema#'
+ *
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
+ */
+declare type JSONSchema7Version = string;
+
 declare type KeyValuePanelItem = {
     kind: typeof panelKind.ATTRIBUTE;
     title?: string;
@@ -767,6 +965,17 @@ declare type KeyValuePanelItem = {
     copyContent?: string;
 };
 
+declare type Location_2 = {
+    file?: string;
+    start: LocationEdge;
+    end: LocationEdge;
+};
+
+declare type LocationEdge = {
+    line: number;
+    character?: number;
+};
+
 declare type LocationsPanelItem = {
     kind: typeof panelKind.LOCATIONS;
     locations: string[];
@@ -815,6 +1024,8 @@ declare type MarkdownParser = (markdown: string, sanitizeOptions?: {
  */
 declare type MarkdownRenderer = (parsed: unknown) => ReactNode;
 
+declare type MaybePromise<T> = T | Promise<T>;
+
 declare type McpCapabilities = {
     [key: string]: boolean | {
         listChanged?: boolean;
@@ -892,6 +1103,7 @@ declare type MediaTypeContent = {
 declare type MediaTypeEntry = {
     schemaId?: string;
     exampleIds?: string[];
+    encoding?: Record<string, FormFieldEncoding>;
 };
 
 declare type MessageBindingData = {
@@ -947,6 +1159,30 @@ declare type MultiFormatSchemaObject = {
     schemaFormat: string;
 };
 
+declare class Node_2 implements AstType {
+    readonly $$mdtype = "Node";
+    attributes: Record<string, any>;
+    slots: Record<string, Node_2>;
+    children: Node_2[];
+    errors: ValidationError[];
+    lines: number[];
+    type: NodeType;
+    tag?: string;
+    annotations: AttributeValue[];
+    inline: boolean;
+    location?: Location_2;
+    constructor(type?: NodeType, attributes?: Record<string, any>, children?: Node_2[], tag?: string);
+    walk(): Generator<Node_2, void, unknown>;
+    push(node: Node_2): void;
+    resolve(config?: Config): Node_2;
+    findSchema(config?: Config): Schema | undefined;
+    transformAttributes(config?: Config): Record<string, any>;
+    transformChildren(config: Config): RenderableTreeNode[];
+    transform(config: Config): MaybePromise<RenderableTreeNodes>;
+}
+
+declare type NodeType = 'blockquote' | 'code' | 'comment' | 'document' | 'em' | 'error' | 'fence' | 'hardbreak' | 'heading' | 'hr' | 'image' | 'inline' | 'item' | 'link' | 'list' | 'node' | 'paragraph' | 's' | 'softbreak' | 'strong' | 'table' | 'tag' | 'tbody' | 'td' | 'text' | 'th' | 'thead' | 'tr';
+
 declare const nodeTypes: {
     readonly CONTAINER: 'container';
     readonly HEADER: 'header';
@@ -1072,13 +1308,13 @@ declare type OpenAPIDiscriminator = {
 };
 
 declare type OpenAPIEncoding = {
-    contentType: string;
+    contentType?: string;
     headers?: {
         [name: string]: Referenced<OpenAPIHeader>;
     };
-    style: OpenAPIParameterStyle;
-    explode: boolean;
-    allowReserved: boolean;
+    style?: OpenAPIParameterStyle;
+    explode?: boolean;
+    allowReserved?: boolean;
 };
 
 declare type OpenAPIExample = {
@@ -1462,6 +1698,8 @@ declare type PanelTag = {
 declare type ParameterData = {
     name: string;
     in?: string;
+    style?: string;
+    explode?: boolean;
     schemaId: string;
     description?: string | Node_2 | Node_2[];
     required?: boolean;
@@ -1524,6 +1762,8 @@ declare type PreparedApiDocs = {
     timings: BuildTimings;
 };
 
+declare type Primitive = null | boolean | number | string;
+
 declare type ProtocolVariant = ObjectValues<typeof CONST_PROTOCOL_VARIANT>;
 
 declare type RawApiDocsOptions = EditionRedocConfig & EditionAsyncApiConfig & EditionGraphQLConfig & {
@@ -1551,6 +1791,7 @@ declare type RedoclyApiDocsInnerProps = {
     items: ApiItem[];
     basePath: string;
     markdownAdapter: MarkdownAdapter;
+    options?: RawApiDocsOptions;
     telemetryConfig?: Partial<RedocTelemetryConfig>;
     initialTelemetry?: InitialTelemetryContext;
 };
@@ -1617,6 +1858,10 @@ declare type ReferencesPanelItem = {
     }[];
 };
 
+declare type RenderableTreeNode = Tag | Scalar;
+
+declare type RenderableTreeNodes = RenderableTreeNode | RenderableTreeNode[];
+
 declare type ResponseCodeEntry = {
     code: string;
     schemaId?: string;
@@ -1639,6 +1884,33 @@ declare type Sample = {
     label?: string;
 };
 
+declare type Scalar = Primitive | Scalar[] | {
+    [key: string]: Scalar;
+};
+
+declare type Schema<C extends Config = Config, R = string> = {
+    render?: R;
+    children?: string[];
+    attributes?: Record<string, SchemaAttribute>;
+    slots?: Record<string, SchemaSlot>;
+    selfClosing?: boolean;
+    inline?: boolean;
+    transform?(node: Node_2, config: C): MaybePromise<RenderableTreeNodes>;
+    validate?(node: Node_2, config: C): MaybePromise<ValidationError[]>;
+    description?: string;
+};
+
+declare type SchemaAttribute = {
+    type?: ValidationType | ValidationType[];
+    render?: boolean | string;
+    default?: any;
+    required?: boolean;
+    matches?: SchemaMatches | ((config: Config) => SchemaMatches);
+    validate?(value: any, config: Config, name: string): ValidationError[];
+    errorLevel?: ValidationError['level'];
+    description?: string;
+};
+
 declare type SchemaEntry = {
     id: string;
     kind: SchemaKind;
@@ -1653,6 +1925,13 @@ declare const schemaKind: {
     readonly GRAPHQL_TYPE: 'graphql-type';
 };
 
+declare type SchemaMatches = RegExp | string[] | null;
+
+declare type SchemaSlot = {
+    render?: boolean | string;
+    required?: boolean;
+};
+
 declare type SecurityNode = {
     nodeType: typeof nodeTypes.SECURITY;
     requirements: SecurityRequirementDetail[];
@@ -1783,6 +2062,15 @@ declare type SingleChildPanelBase<TKind extends PanelItem['kind']> = {
 
 declare type SpecType = 'openapi' | 'asyncapi' | 'graphql';
 
+declare class Tag<N extends string = string, A extends Record<string, any> = Record<string, any>> {
+    readonly $$mdtype: "Tag";
+    static isTag: (tag: any) => tag is Tag<string, Record<string, any>>;
+    name: N;
+    attributes: A;
+    children: RenderableTreeNode[];
+    constructor(name?: N, attributes?: A, children?: RenderableTreeNode[]);
+}
+
 declare type TagsPanelItem = {
     kind: typeof panelKind.TAGS;
     title?: string;
@@ -1798,6 +2086,15 @@ declare type TelemetryOptionValue = string | number | boolean;
 
 declare type TypeOfUsage = 'html' | 'cli' | 'react' | 'init' | 'docker';
 
+declare type ValidationError = {
+    id: string;
+    level: 'debug' | 'info' | 'warning' | 'error' | 'critical';
+    message: string;
+    location?: Location_2;
+};
+
+declare type ValidationType = CustomAttributeType | typeof String | typeof Number | typeof Boolean | typeof Object | typeof Array | 'String' | 'Number' | 'Boolean' | 'Object' | 'Array';
+
 declare type WithRequired<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };