types.d.ts

/**
 * The different kind of stages when crawling a schema.
 * @property NEW_SCHEMA - The crawler just started crawling a schema.
 * @property END_SCHEMA - The crawler just finished crawling a schema.
 */
declare type SchemaIteratorCallbackType = {
    NEW_SCHEMA: string;
    END_SCHEMA: string;
};

/**
 * The different types of schemas you can iterate
 * @property parameters - Crawl all schemas in parameters
 * @property payloads - Crawl all schemas in payloads
 * @property headers - Crawl all schemas in headers
 * @property components - Crawl all schemas in components
 * @property objects - Crawl all schemas of type object
 * @property arrays - Crawl all schemas of type array
 * @property oneOfs - Crawl all schemas in oneOf's
 * @property allOfs - Crawl all schemas in allOf's
 * @property anyOfs - Crawl all schemas in anyOf's
 * @property nots - Crawl all schemas in not field
 * @property propertyNames - Crawl all schemas in propertyNames field
 * @property patternProperties - Crawl all schemas in patternProperties field
 * @property contains - Crawl all schemas in contains field
 * @property ifs - Crawl all schemas in if field
 * @property thenes - Crawl all schemas in then field
 * @property elses - Crawl all schemas in else field
 * @property dependencies - Crawl all schemas in dependencies field
 * @property definitions - Crawl all schemas in definitions field
 */
declare type SchemaTypesToIterate = {
    parameters: string;
    payloads: string;
    headers: string;
    components: string;
    objects: string;
    arrays: string;
    oneOfs: string;
    allOfs: string;
    anyOfs: string;
    nots: string;
    propertyNames: string;
    patternProperties: string;
    contains: string;
    ifs: string;
    thenes: string;
    elses: string;
    dependencies: string;
    definitions: string;
};



/**
 * Implements functions to deal with the common Bindings object.
 */
declare interface MixinBindings {
}



/**
 * Implements functions to deal with the description field.
 */
declare interface MixinDescription {
}



/**
 * Implements functions to deal with the ExternalDocs object.
 */
declare interface MixinExternalDocs {
}



/**
 * Implements functions to deal with the SpecificationExtensions object.
 */
declare interface MixinSpecificationExtensions {
}



/**
 * Implements functions to deal with the Tags object.
 */
declare interface MixinTags {
}

declare module "@asyncapi/parser" {
    /**
     * Instantiates an error
     * @param definition.type - The type of the error.
     * @param definition.title - The message of the error.
     * @param [definition.detail] - A string containing more detailed information about the error.
     * @param [definition.parsedJSON] - The resulting JSON after YAML transformation. Or the JSON object if the this was the initial format.
     * @param [definition.validationErrors] - The errors resulting from the validation. For more information, see https://www.npmjs.com/package/better-ajv-errors.
     * @param definition.validationErrors.title - A validation error message.
     * @param definition.validationErrors.jsonPointer - The path to the field that contains the error. Uses JSON Pointer format.
     * @param definition.validationErrors.startLine - The line where the error starts in the AsyncAPI document.
     * @param definition.validationErrors.startColumn - The column where the error starts in the AsyncAPI document.
     * @param definition.validationErrors.startOffset - The offset (starting from the beginning of the document) where the error starts in the AsyncAPI document.
     * @param definition.validationErrors.endLine - The line where the error ends in the AsyncAPI document.
     * @param definition.validationErrors.endColumn - The column where the error ends in the AsyncAPI document.
     * @param definition.validationErrors.endOffset - The offset (starting from the beginning of the document) where the error ends in the AsyncAPI document.
     * @param [definition.location] - Error location details after trying to parse an invalid JSON or YAML document.
     * @param definition.location.startLine - The line of the YAML/JSON document where the error starts.
     * @param definition.location.startColumn - The column of the YAML/JSON document where the error starts.
     * @param definition.location.startOffset - The offset (starting from the beginning of the document) where the error starts in the YAML/JSON AsyncAPI document.
     * @param [definition.refs] - Error details after trying to resolve $ref's.
     * @param definition.refs.title - A validation error message.
     * @param definition.refs.jsonPointer - The path to the field that contains the error. Uses JSON Pointer format.
     * @param definition.refs.startLine - The line where the error starts in the AsyncAPI document.
     * @param definition.refs.startColumn - The column where the error starts in the AsyncAPI document.
     * @param definition.refs.startOffset - The offset (starting from the beginning of the document) where the error starts in the AsyncAPI document.
     * @param definition.refs.endLine - The line where the error ends in the AsyncAPI document.
     * @param definition.refs.endColumn - The column where the error ends in the AsyncAPI document.
     * @param definition.refs.endOffset - The offset (starting from the beginning of the document) where the error ends in the AsyncAPI document.
     */
    class ParserError extends Error {
        constructor(definition: {
            type: string;
            title: string;
            detail?: string;
            parsedJSON?: any;
            validationErrors?: {
                title: string;
                jsonPointer: string;
                startLine: number;
                startColumn: number;
                startOffset: number;
                endLine: number;
                endColumn: number;
                endOffset: number;
            }[];
            location?: {
                startLine: number;
                startColumn: number;
                startOffset: number;
            };
            refs?: {
                title: string;
                jsonPointer: string;
                startLine: number;
                startColumn: number;
                startOffset: number;
                endLine: number;
                endColumn: number;
                endOffset: number;
            }[];
        });
        /**
         * Returns a JS object representation of the error.
         */
        toJS(): void;
    }
    interface AsyncAPIDocument extends MixinTags, MixinExternalDocs, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with the AsyncAPI document.
     */
    class AsyncAPIDocument extends Base implements MixinTags, MixinExternalDocs, MixinSpecificationExtensions {
        version(): string;
        info(): Info;
        id(): string;
        hasServers(): boolean;
        servers(): {
            [key: string]: Server;
        };
        serverNames(): string[];
        /**
         * @param name - Name of the server.
         */
        server(name: string): Server;
        hasDefaultContentType(): boolean;
        defaultContentType(): string | null;
        hasChannels(): boolean;
        channels(): {
            [key: string]: Channel;
        };
        channelNames(): string[];
        /**
         * @param name - Name of the channel.
         */
        channel(name: string): Channel;
        hasComponents(): boolean;
        components(): Components;
        hasMessages(): boolean;
        allMessages(): Map<string, Message>;
        allSchemas(): Map<string, Schema>;
        hasCircular(): boolean;
        /**
         * Traverse schemas in the document and select which types of schemas to include.
         * By default all schemas are iterated
         */
        traverseSchemas(callback: TraverseSchemas, schemaTypesToIterate: SchemaTypesToIterate[]): void;
        /**
         * Converts a valid AsyncAPI document to a JavaScript Object Notation (JSON) string.
         * A stringified AsyncAPI document using this function should be parsed via the AsyncAPIDocument.parse() function - the JSON.parse() function is not compatible.
         * @param doc - A valid AsyncAPIDocument instance.
         * @param [space] - Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
         */
        static stringify(doc: AsyncAPIDocument, space?: number | string): string;
        /**
         * Converts a valid stringified AsyncAPIDocument instance into an AsyncAPIDocument instance.
         * @param doc - A valid stringified AsyncAPIDocument instance.
         */
        static parse(doc: string): AsyncAPIDocument;
        hasTags(): boolean;
        tags(): Tag[];
        tagNames(): string[];
        /**
         * @param name - Name of the tag.
         */
        hasTag(name: string): boolean;
        /**
         * @param name - Name of the tag.
         */
        tag(name: string): Tag | null;
        hasExternalDocs(): boolean;
        externalDocs(): ExternalDocs | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
        hasTags(): boolean;
        tags(): Tag[];
        tagNames(): string[];
        /**
         * @param name - Name of the tag.
         */
        hasTag(name: string): boolean;
        /**
         * @param name - Name of the tag.
         */
        tag(name: string): Tag | null;
        hasExternalDocs(): boolean;
        externalDocs(): ExternalDocs | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    /**
     * Callback used when crawling a schema.
     * @param schema - which is being crawled
     * @param propName - if the schema is from a property get the name of such
     * @param callbackType - is the schema a new one or is the crawler finishing one.
     */
    type TraverseSchemas = (schema: Schema, propName: string, callbackType: SchemaIteratorCallbackType) => boolean;
    /**
     * Implements common functionality for all the models.
     */
    class Base {
        /**
         * @param [key] - A key to retrieve from the JSON object.
         */
        json(key?: string): any;
    }
    interface ChannelParameter extends MixinDescription, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a ChannelParameter object.
     */
    class ChannelParameter extends Base implements MixinDescription, MixinSpecificationExtensions {
        location(): string;
        schema(): Schema;
        hasDescription(): boolean;
        description(): string | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface Channel extends MixinDescription, MixinBindings, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a Channel object.
     */
    class Channel extends Base implements MixinDescription, MixinBindings, MixinSpecificationExtensions {
        parameters(): {
            [key: string]: ChannelParameter;
        };
        /**
         * @param name - Name of the parameter.
         */
        parameter(name: string): ChannelParameter;
        hasParameters(): boolean;
        hasServers(): boolean;
        servers(): String[];
        /**
         * @param index - Index of the server.
         */
        server(index: number): string;
        publish(): PublishOperation;
        subscribe(): SubscribeOperation;
        hasPublish(): boolean;
        hasSubscribe(): boolean;
        hasDescription(): boolean;
        description(): string | null;
        hasBindings(): boolean;
        bindings(): any;
        bindingProtocols(): string[];
        /**
         * @param name - Name of the binding.
         */
        hasBinding(name: string): boolean;
        /**
         * @param name - Name of the binding.
         */
        binding(name: string): any | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface Components extends MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a Components object.
     */
    class Components extends Base implements MixinSpecificationExtensions {
        channels(): {
            [key: string]: Channel;
        };
        hasChannels(): boolean;
        /**
         * @param name - Name of the channel.
         */
        channel(name: string): Channel;
        messages(): {
            [key: string]: Message;
        };
        hasMessages(): boolean;
        /**
         * @param name - Name of the message.
         */
        message(name: string): Message;
        schemas(): {
            [key: string]: Schema;
        };
        hasSchemas(): boolean;
        /**
         * @param name - Name of the schema.
         */
        schema(name: string): Schema;
        securitySchemes(): {
            [key: string]: SecurityScheme;
        };
        hasSecuritySchemes(): boolean;
        /**
         * @param name - Name of the security schema.
         */
        securityScheme(name: string): SecurityScheme;
        servers(): {
            [key: string]: Server;
        };
        hasServers(): boolean;
        /**
         * @param name - Name of the server.
         */
        server(name: string): Server;
        parameters(): {
            [key: string]: ChannelParameter;
        };
        hasParameters(): boolean;
        /**
         * @param name - Name of the channel parameter.
         */
        parameter(name: string): ChannelParameter;
        correlationIds(): {
            [key: string]: CorrelationId;
        };
        hasCorrelationIds(): boolean;
        /**
         * @param name - Name of the correlationId.
         */
        correlationId(name: string): CorrelationId;
        operationTraits(): {
            [key: string]: OperationTrait;
        };
        hasOperationTraits(): boolean;
        /**
         * @param name - Name of the operation trait.
         */
        operationTrait(name: string): OperationTrait;
        messageTraits(): {
            [key: string]: MessageTrait;
        };
        hasMessageTraits(): boolean;
        /**
         * @param name - Name of the message trait.
         */
        messageTrait(name: string): MessageTrait;
        serverVariables(): {
            [key: string]: ServerVariable;
        };
        hasServerVariables(): boolean;
        /**
         * @param name - Name of the server variable.
         */
        serverVariable(name: string): ServerVariable;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface Contact extends MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with the Contact object.
     */
    class Contact extends Base implements MixinSpecificationExtensions {
        name(): string;
        url(): string;
        email(): string;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface CorrelationId extends MixinDescription, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a CorrelationId object.
     */
    class CorrelationId extends Base implements MixinDescription, MixinSpecificationExtensions {
        location(): string;
        hasDescription(): boolean;
        description(): string | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface ExternalDocs extends MixinDescription, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with an ExternalDocs object.
     */
    class ExternalDocs extends Base implements MixinDescription, MixinSpecificationExtensions {
        url(): string;
        hasDescription(): boolean;
        description(): string | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface Info extends MixinDescription, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with the Info object.
     */
    class Info extends Base implements MixinDescription, MixinSpecificationExtensions {
        title(): string;
        version(): string;
        termsOfService(): string | undefined;
        license(): License;
        contact(): Contact;
        hasDescription(): boolean;
        description(): string | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface License extends MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with the License object.
     */
    class License extends Base implements MixinSpecificationExtensions {
        name(): string;
        url(): string;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    /**
     * Implements functions to deal with a MessageTrait object.
     */
    class MessageTrait extends MessageTraitable {
    }
    interface MessageTraitable extends MixinDescription, MixinTags, MixinExternalDocs, MixinBindings, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a the common properties that Message and MessageTrait objects have.
     */
    class MessageTraitable extends Base implements MixinDescription, MixinTags, MixinExternalDocs, MixinBindings, MixinSpecificationExtensions {
        headers(): Schema;
        /**
         * @param name - Name of the header.
         */
        header(name: string): Schema;
        id(): string;
        correlationId(): CorrelationId;
        schemaFormat(): string;
        contentType(): string;
        name(): string;
        title(): string;
        summary(): string;
        examples(): any[];
        hasDescription(): boolean;
        description(): string | null;
        hasTags(): boolean;
        tags(): Tag[];
        tagNames(): string[];
        /**
         * @param name - Name of the tag.
         */
        hasTag(name: string): boolean;
        /**
         * @param name - Name of the tag.
         */
        tag(name: string): Tag | null;
        hasExternalDocs(): boolean;
        externalDocs(): ExternalDocs | null;
        hasBindings(): boolean;
        bindings(): any;
        bindingProtocols(): string[];
        /**
         * @param name - Name of the binding.
         */
        hasBinding(name: string): boolean;
        /**
         * @param name - Name of the binding.
         */
        binding(name: string): any | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    /**
     * Implements functions to deal with a Message object.
     */
    class Message extends MessageTraitable {
        uid(): string;
        payload(): Schema;
        traits(): MessageTrait[];
        hasTraits(): boolean;
        originalPayload(): any;
        originalSchemaFormat(): string;
    }
    interface OAuthFlow extends MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a OAuthFlow object.
     */
    class OAuthFlow extends Base implements MixinSpecificationExtensions {
        authorizationUrl(): string;
        tokenUrl(): string;
        refreshUrl(): string;
        scopes(): {
            [key: string]: string;
        };
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    /**
     * Implements functions to deal with a OperationSecurityRequirement object.
     */
    class OperationSecurityRequirement extends Base {
    }
    /**
     * Implements functions to deal with a OperationTrait object.
     */
    class OperationTrait extends OperationTraitable {
    }
    interface OperationTraitable extends MixinDescription, MixinTags, MixinExternalDocs, MixinBindings, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with the common properties Operation and OperationTrait object have.
     */
    class OperationTraitable extends Base implements MixinDescription, MixinTags, MixinExternalDocs, MixinBindings, MixinSpecificationExtensions {
        id(): string;
        summary(): string;
        hasDescription(): boolean;
        description(): string | null;
        hasTags(): boolean;
        tags(): Tag[];
        tagNames(): string[];
        /**
         * @param name - Name of the tag.
         */
        hasTag(name: string): boolean;
        /**
         * @param name - Name of the tag.
         */
        tag(name: string): Tag | null;
        hasExternalDocs(): boolean;
        externalDocs(): ExternalDocs | null;
        hasBindings(): boolean;
        bindings(): any;
        bindingProtocols(): string[];
        /**
         * @param name - Name of the binding.
         */
        hasBinding(name: string): boolean;
        /**
         * @param name - Name of the binding.
         */
        binding(name: string): any | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    /**
     * Implements functions to deal with an Operation object.
     */
    class Operation extends OperationTraitable {
        hasMultipleMessages(): boolean;
        traits(): OperationTrait[];
        hasTraits(): boolean;
        messages(): Message[];
        message(): Message;
        security(): OperationSecurityRequirement[];
    }
    /**
     * Implements functions to deal with a PublishOperation object.
     */
    class PublishOperation extends Operation {
        isPublish(): boolean;
        isSubscribe(): boolean;
        kind(): string;
    }
    interface Schema extends MixinDescription, MixinExternalDocs, MixinSpecificationExtensions {
    }
    /**
     * Instantiates a schema object
     * @param json - Schema definition
     * @param [options.parent] - Parent schema definition
     */
    class Schema extends Base implements MixinDescription, MixinExternalDocs, MixinSpecificationExtensions {
        constructor(json: any, options?: {
            parent?: Schema;
        });
        uid(): string;
        $id(): string;
        multipleOf(): number;
        maximum(): number;
        exclusiveMaximum(): number;
        minimum(): number;
        exclusiveMinimum(): number;
        maxLength(): number;
        minLength(): number;
        pattern(): string;
        maxItems(): number;
        minItems(): number;
        uniqueItems(): boolean;
        maxProperties(): number;
        minProperties(): number;
        required(): string[];
        enum(): any[];
        type(): string | string[];
        allOf(): Schema[];
        oneOf(): Schema[];
        anyOf(): Schema[];
        not(): Schema;
        items(): Schema | Schema[];
        properties(): {
            [key: string]: Schema;
        };
        /**
         * @param name - Name of the property.
         */
        property(name: string): Schema;
        additionalProperties(): boolean | Schema;
        additionalItems(): Schema;
        patternProperties(): {
            [key: string]: Schema;
        };
        const(): any;
        contains(): Schema;
        dependencies(): {
            [key: string]: Schema | string[];
        };
        propertyNames(): Schema;
        if(): Schema;
        then(): Schema;
        else(): Schema;
        format(): string;
        contentEncoding(): string;
        contentMediaType(): string;
        definitions(): {
            [key: string]: Schema;
        };
        title(): string;
        default(): any;
        deprecated(): boolean;
        discriminator(): string;
        readOnly(): boolean;
        writeOnly(): boolean;
        examples(): any[];
        isBooleanSchema(): boolean;
        isCircular(): boolean;
        circularSchema(): Schema;
        hasCircularProps(): boolean;
        circularProps(): string[];
        hasDescription(): boolean;
        description(): string | null;
        hasExternalDocs(): boolean;
        externalDocs(): ExternalDocs | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
        hasDescription(): boolean;
        description(): string | null;
        hasExternalDocs(): boolean;
        externalDocs(): ExternalDocs | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface SecurityScheme extends MixinDescription, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a SecurityScheme object.
     */
    class SecurityScheme extends Base implements MixinDescription, MixinSpecificationExtensions {
        type(): string;
        name(): string;
        in(): string;
        scheme(): string;
        bearerFormat(): string;
        openIdConnectUrl(): string;
        flows(): {
            [key: string]: OAuthFlow;
        };
        hasDescription(): boolean;
        description(): string | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    /**
     * Implements functions to deal with a ServerSecurityRequirement object.
     */
    class ServerSecurityRequirement extends Base {
    }
    interface ServerVariable extends MixinDescription, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a ServerVariable object.
     */
    class ServerVariable extends Base implements MixinDescription, MixinSpecificationExtensions {
        allowedValues(): any[];
        /**
         * @param name - Name of the variable.
         */
        allows(name: string): boolean;
        hasAllowedValues(): boolean;
        defaultValue(): string;
        hasDefaultValue(): boolean;
        examples(): string[];
        hasDescription(): boolean;
        description(): string | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    interface Server extends MixinDescription, MixinBindings, MixinSpecificationExtensions, MixinTags {
    }
    /**
     * Implements functions to deal with a Server object.
     */
    class Server extends Base implements MixinDescription, MixinBindings, MixinSpecificationExtensions, MixinTags {
        url(): string;
        protocol(): string;
        protocolVersion(): string;
        variables(): {
            [key: string]: ServerVariable;
        };
        /**
         * @param name - Name of the server variable.
         */
        variable(name: string): ServerVariable;
        hasVariables(): boolean;
        security(): ServerSecurityRequirement[];
        hasDescription(): boolean;
        description(): string | null;
        hasBindings(): boolean;
        bindings(): any;
        bindingProtocols(): string[];
        /**
         * @param name - Name of the binding.
         */
        hasBinding(name: string): boolean;
        /**
         * @param name - Name of the binding.
         */
        binding(name: string): any | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
        hasTags(): boolean;
        tags(): Tag[];
        tagNames(): string[];
        /**
         * @param name - Name of the tag.
         */
        hasTag(name: string): boolean;
        /**
         * @param name - Name of the tag.
         */
        tag(name: string): Tag | null;
    }
    /**
     * Implements functions to deal with a SubscribeOperation object.
     */
    class SubscribeOperation extends Operation {
        isPublish(): boolean;
        isSubscribe(): boolean;
        kind(): string;
    }
    interface Tag extends MixinDescription, MixinExternalDocs, MixinSpecificationExtensions {
    }
    /**
     * Implements functions to deal with a Tag object.
     */
    class Tag extends Base implements MixinDescription, MixinExternalDocs, MixinSpecificationExtensions {
        name(): string;
        hasDescription(): boolean;
        description(): string | null;
        hasExternalDocs(): boolean;
        externalDocs(): ExternalDocs | null;
        hasExtensions(): boolean;
        extensions(): {
            [key: string]: any;
        };
        extensionKeys(): string[];
        extKeys(): string[];
        /**
         * @param key - Extension key.
         */
        hasExtension(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        extension(key: string): any;
        /**
         * @param key - Extension key.
         */
        hasExt(key: string): boolean;
        /**
         * @param key - Extension key.
         */
        ext(key: string): any;
    }
    /**
     * The complete list of parse configuration options used to parse the given data.
     * @property [path] - Path to the AsyncAPI document. It will be used to resolve relative references. Defaults to current working dir.
     * @property [parse] - Options object to pass to {@link https://apitools.dev/json-schema-ref-parser/docs/options.html|json-schema-ref-parser}.
     * @property [resolve] - Options object to pass to {@link https://apitools.dev/json-schema-ref-parser/docs/options.html|json-schema-ref-parser}.
     * @property [applyTraits] - Whether to resolve and apply traits or not. Defaults to true.
     */
    type ParserOptions = {
        path?: string;
        parse?: any;
        resolve?: any;
        applyTraits?: boolean;
    };
    /**
     * Parses and validate an AsyncAPI document from YAML or JSON.
     * @param asyncapiYAMLorJSON - An AsyncAPI document in JSON or YAML format.
     * @param [options] - Configuration options object {@link #asyncapiparserparseroptions--object|ParserOptions}
     * @returns The parsed AsyncAPI document.
     */
    function parse(asyncapiYAMLorJSON: string | any, options?: ParserOptions): Promise<AsyncAPIDocument>;
    /**
     * Fetches an AsyncAPI document from the given URL and passes its content to the `parse` method.
     * @param url - URL where the AsyncAPI document is located.
     * @param [fetchOptions] - Configuration to pass to the {@link https://developer.mozilla.org/en-US/docs/Web/API/Request|fetch} call.
     * @param [options] - Configuration to pass to the {@link #asyncapiparserparseroptions--object|ParserOptions} method.
     * @returns The parsed AsyncAPI document.
     */
    function parseFromUrl(url: string, fetchOptions?: any, options?: ParserOptions): Promise<AsyncAPIDocument>;
    /**
     * Registers a new schema parser. Schema parsers are in charge of parsing and transforming payloads to AsyncAPI Schema format.
     * @param parserModule - The schema parser module containing parse() and getMimeTypes() functions.
     */
    function registerSchemaParser(parserModule: any): void;
}