@bluejeans/flexdoc-backend/dist/interfaces.d.ts

FlexDoc backend integration for NestJS and other frameworks

export interface LogoOptions {
    url: string;
    backgroundColor?: string;
    padding?: string | {
        vertical?: string | number;
        horizontal?: string | number;
    };
    maxHeight?: string | number;
    maxWidth?: string | number;
    alt?: string;
    containerClass?: string;
    clickable?: boolean;
}
export interface ThemeColors {
    primary?: {
        main?: string;
        light?: string;
        dark?: string;
    };
    success?: {
        main?: string;
        light?: string;
        dark?: string;
    };
    error?: {
        main?: string;
        light?: string;
        dark?: string;
    };
    text?: {
        primary?: string;
        secondary?: string;
    };
    gray?: {
        50?: string;
        100?: string;
    };
    border?: {
        dark?: string;
        light?: string;
    };
}
export interface ThemeTypography {
    fontSize?: string;
    lineHeight?: string;
    fontFamily?: string;
    headings?: {
        fontFamily?: string;
        fontWeight?: string;
    };
    code?: {
        fontSize?: string;
        fontFamily?: string;
        lineHeight?: string;
        color?: string;
        backgroundColor?: string;
        wrap?: boolean;
    };
}
export interface ThemeSidebar {
    backgroundColor?: string;
    backgroundColorDark?: string;
    textColor?: string;
    textColorDark?: string;
    activeTextColor?: string;
    activeTextColorDark?: string;
    borderColor?: string;
    borderColorDark?: string;
    groupItems?: {
        textTransform?: string;
    };
}
export interface MethodColors {
    get?: {
        bg?: string;
        border?: string;
    };
    post?: {
        bg?: string;
        border?: string;
    };
    put?: {
        bg?: string;
        border?: string;
    };
    delete?: {
        bg?: string;
        border?: string;
    };
    patch?: {
        bg?: string;
        border?: string;
    };
    options?: {
        bg?: string;
        border?: string;
    };
    head?: {
        bg?: string;
        border?: string;
    };
}
export interface ThemeConfig {
    colors?: ThemeColors;
    typography?: ThemeTypography;
    sidebar?: ThemeSidebar;
    methodColors?: MethodColors;
}
export interface FlexDocOptions {
    title?: string;
    description?: string;
    altDescription?: string;
    version?: string;
    tagGroups?: {
        name: string;
        tags: string[];
    }[];
    theme?: 'light' | 'dark' | ThemeConfig;
    customCss?: string;
    customJs?: string;
    favicon?: string;
    logo?: string | LogoOptions;
    hideDownloadButton?: boolean;
    hideTopbar?: boolean;
    expandResponses?: string;
    defaultModelsExpandDepth?: number;
    showExtensions?: boolean;
    showCommonExtensions?: boolean;
    hideHostname?: boolean;
    hideLoading?: boolean;
    nativeScrollbars?: boolean;
    pathInMiddlePanel?: boolean;
    requiredPropsFirst?: boolean;
    sortPropsAlphabetically?: boolean;
    showRequestHeaders?: boolean;
    noAutoAuth?: boolean;
    lazyRendering?: boolean;
    scrollYOffset?: number | string;
    suppressWarnings?: boolean;
    payloadSampleIdx?: number;
    auth?: {
        type: 'basic' | 'bearer';
        secretKey: string;
    };
    footer?: {
        copyright?: string;
        link?: Array<{
            text: string;
            url: string;
            icon?: string;
        }>;
    };
}
export interface FlexDocModuleOptions {
    path: string;
    specUrl?: string;
    spec?: object;
    options?: FlexDocOptions;
}