beam-cli/dist/configuration/types.d.ts

A beautifully simple CLI for running Lighthouse audits on a statically generated (SSG) website

import type { PartialDeep } from 'type-fest';
import { Options } from '../options/types.js';
export declare type ConfigurationOptions = PartialDeep<Options>;
/** JSON Schema for the Configuration File,
 * `required`'s should be empty because it represents a 'partial'.
 * Can generate a similar schema using: `npm run generate-schema`
 */
export declare const configurationJSONSchema: {
    $ref: string;
    $schema: string;
    definitions: {
        JsonArray: {
            description: string;
            items: {
                $ref: string;
            };
            type: string;
        };
        JsonObject: {
            additionalProperties: {
                $ref: string;
            };
            description: string;
            type: string;
        };
        JsonPrimitive: {
            description: string;
            type: string[];
        };
        JsonValue: {
            anyOf: {
                $ref: string;
            }[];
            description: string;
        };
        LighthouseCategories: {
            enum: string[];
            type: string;
        };
        LighthouseOptions: {
            additionalProperties: boolean;
            description: string;
            properties: {
                categories: {
                    anyOf: ({
                        items: {
                            $ref: string;
                        };
                        type: string;
                        const?: undefined;
                    } | {
                        const: string;
                        type: string;
                        items?: undefined;
                    })[];
                    description: string;
                };
                desktop: {
                    description: string;
                    type: string;
                };
                mediaFeatures: {
                    description: string;
                    items: {
                        $ref: string;
                    };
                    type: string;
                };
                mobile: {
                    description: string;
                    type: string;
                };
                pageWindowFlags: {
                    $ref: string;
                    description: string;
                };
                targets: {
                    items: {
                        type: string;
                    };
                    type: string;
                };
            };
            required: never[];
            type: string;
        };
        MediaFeature: {
            additionalProperties: boolean;
            properties: {
                name: {
                    type: string;
                };
                value: {
                    type: string;
                };
            };
            required: never[];
            type: string;
        };
        Options: {
            additionalProperties: boolean;
            properties: {
                alwaysInclude: {
                    description: string;
                    items: {
                        type: string;
                    };
                    type: string;
                };
                dist: {
                    description: string;
                    type: string;
                };
                exclude: {
                    description: string;
                    items: {
                        type: string;
                    };
                    type: string;
                };
                include: {
                    description: string;
                    items: {
                        type: string;
                    };
                    type: string;
                };
                lighthouse: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        items: {
                            $ref: string;
                        };
                        type: string;
                        $ref?: undefined;
                    })[];
                    description: string;
                };
                output: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        folder: {
                            description: string;
                            type: string;
                        };
                        html: {
                            description: string;
                            type: string;
                        };
                        json: {
                            description: string;
                            type: string;
                        };
                    };
                    required: never[];
                    type: string;
                };
                server: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        brotliCompressionLevel: {
                            description: string;
                            maximum: number;
                            minimum: number;
                            type: string;
                        };
                        port: {
                            description: string;
                            maximum: number;
                            minimum: number;
                            type: string;
                        };
                    };
                    required: never[];
                    type: string;
                };
                static: {
                    description: string;
                    type: string;
                };
                urls: {
                    description: string;
                    items: {
                        type: string;
                    };
                    type: string;
                };
            };
            required: never[];
            type: string;
        };
    };
};