import { YAMLError } from 'yaml';

type IDescription = string | Array<unknown>;
interface IModuleDocumentation {
    module: string;
    shortDescription?: IDescription;
    description?: IDescription;
    versionAdded?: string;
    author?: IDescription;
    deprecated: boolean;
    options: Map<string, IOption>;
    requirements?: IDescription;
    seealso?: Record<string, unknown>;
    notes?: IDescription;
}
interface IModuleMetadata {
    source: string;
    sourceLineRange: [number, number];
    fqcn: string;
    namespace: string;
    collection: string;
    name: string;
    rawDocumentationFragments: Map<string, Record<string, unknown>>;
    documentation?: IModuleDocumentation;
    fragments?: IModuleMetadata[];
    errors: YAMLError[];
}
interface IOption {
    name: string;
    description?: IDescription;
    required: boolean;
    default?: unknown;
    choices?: Array<unknown>;
    type?: string;
    elements?: string;
    aliases?: Array<string>;
    versionAdded?: string;
    suboptions?: Map<string, IOption>;
}

export type { IDescription, IModuleDocumentation, IModuleMetadata, IOption };