lighthouse 9.5.0-dev.20230123 → 9.5.0-dev.20230124

package/report/renderer/util.d.ts

@@ -1,342 +0,0 @@
-export type I18nFormatter = import('./i18n-formatter').I18nFormatter;
-export class Util {
-    /** @type {I18nFormatter} */
-    static i18n: I18nFormatter;
-    static strings: {
-        /** Disclaimer shown to users below the metric values (First Contentful Paint, Time to Interactive, etc) to warn them that the numbers they see will likely change slightly the next time they run Lighthouse. */
-        varianceDisclaimer: string;
-        /** Text link pointing to an interactive calculator that explains Lighthouse scoring. The link text should be fairly short. */
-        calculatorLink: string;
-        /** Label preceding a radio control for filtering the list of audits. The radio choices are various performance metrics (FCP, LCP, TBT), and if chosen, the audits in the report are hidden if they are not relevant to the selected metric. */
-        showRelevantAudits: string;
-        /** Column heading label for the listing of opportunity audits. Each audit title represents an opportunity. There are only 2 columns, so no strict character limit.  */
-        opportunityResourceColumnLabel: string;
-        /** Column heading label for the estimated page load savings of opportunity audits. Estimated Savings is the total amount of time (in seconds) that Lighthouse computed could be reduced from the total page load time, if the suggested action is taken. There are only 2 columns, so no strict character limit. */
-        opportunitySavingsColumnLabel: string;
-        /** An error string displayed next to a particular audit when it has errored, but not provided any specific error message. */
-        errorMissingAuditInfo: string;
-        /** A label, shown next to an audit title or metric title, indicating that there was an error computing it. The user can hover on the label to reveal a tooltip with the extended error message. Translation should be short (< 20 characters). */
-        errorLabel: string;
-        /** This label is shown above a bulleted list of warnings. It is shown directly below an audit that produced warnings. Warnings describe situations the user should be aware of, as Lighthouse was unable to complete all the work required on this audit. For example, The 'Unable to decode image (biglogo.jpg)' warning may show up below an image encoding audit. */
-        warningHeader: string;
-        /** Section heading shown above a list of passed audits that contain warnings. Audits under this section do not negatively impact the score, but Lighthouse has generated some potentially actionable suggestions that should be reviewed. This section is expanded by default and displays after the failing audits. */
-        warningAuditsGroupTitle: string;
-        /** Section heading shown above a list of audits that are passing. 'Passed' here refers to a passing grade. This section is collapsed by default, as the user should be focusing on the failed audits instead. Users can click this heading to reveal the list. */
-        passedAuditsGroupTitle: string;
-        /** Section heading shown above a list of audits that do not apply to the page. For example, if an audit is 'Are images optimized?', but the page has no images on it, the audit will be marked as not applicable. This is neither passing or failing. This section is collapsed by default, as the user should be focusing on the failed audits instead. Users can click this heading to reveal the list. */
-        notApplicableAuditsGroupTitle: string;
-        /** Section heading shown above a list of audits that were not computed by Lighthouse. They serve as a list of suggestions for the user to go and manually check. For example, Lighthouse can't automate testing cross-browser compatibility, so that is listed within this section, so the user is reminded to test it themselves. This section is collapsed by default, as the user should be focusing on the failed audits instead. Users can click this heading to reveal the list. */
-        manualAuditsGroupTitle: string;
-        /** Label shown preceding any important warnings that may have invalidated the entire report. For example, if the user has Chrome extensions installed, they may add enough performance overhead that Lighthouse's performance metrics are unreliable. If shown, this will be displayed at the top of the report UI. */
-        toplevelWarningsMessage: string;
-        /** String of text shown in a graphical representation of the flow of network requests for the web page. This label represents the initial network request that fetches an HTML page. This navigation may be redirected (eg. Initial navigation to http://example.com redirects to https://www.example.com). */
-        crcInitialNavigation: string;
-        /** Label of value shown in the summary of critical request chains. Refers to the total amount of time (milliseconds) of the longest critical path chain/sequence of network requests. Example value: 2310 ms */
-        crcLongestDurationLabel: string;
-        /** Label for button that shows all lines of the snippet when clicked */
-        snippetExpandButtonLabel: string;
-        /** Label for button that only shows a few lines of the snippet when clicked */
-        snippetCollapseButtonLabel: string;
-        /** Explanation shown to users below performance results to inform them that the test was done with a 4G network connection and to warn them that the numbers they see will likely change slightly the next time they run Lighthouse. 'Lighthouse' becomes link text to additional documentation. */
-        lsPerformanceCategoryDescription: string;
-        /** Title of the lab data section of the Performance category. Within this section are various speed metrics which quantify the pageload performance into values presented in seconds and milliseconds. "Lab" is an abbreviated form of "laboratory", and refers to the fact that the data is from a controlled test of a website, not measurements from real users visiting that site.  */
-        labDataTitle: string;
-        /** This label is for a checkbox above a table of items loaded by a web page. The checkbox is used to show or hide third-party (or "3rd-party") resources in the table, where "third-party resources" refers to items loaded by a web page from URLs that aren't controlled by the owner of the web page. */
-        thirdPartyResourcesLabel: string;
-        /** This label is for a button that opens a new tab to a webapp called "Treemap", which is a nested visual representation of a heierarchy of data related to the reports (script bytes and coverage, resource breakdown, etc.) */
-        viewTreemapLabel: string;
-        /** This label is for a button that will show the user a trace of the page. */
-        viewTraceLabel: string;
-        /** This label is for a button that will show the user a trace of the page. */
-        viewOriginalTraceLabel: string;
-        /** Option in a dropdown menu that opens a small, summary report in a print dialog.  */
-        dropdownPrintSummary: string;
-        /** Option in a dropdown menu that opens a full Lighthouse report in a print dialog.  */
-        dropdownPrintExpanded: string;
-        /** Option in a dropdown menu that copies the Lighthouse JSON object to the system clipboard. */
-        dropdownCopyJSON: string;
-        /** Option in a dropdown menu that saves the Lighthouse report HTML locally to the system as a '.html' file. */
-        dropdownSaveHTML: string;
-        /** Option in a dropdown menu that saves the Lighthouse JSON object to the local system as a '.json' file. */
-        dropdownSaveJSON: string;
-        /** Option in a dropdown menu that opens the current report in the Lighthouse Viewer Application. */
-        dropdownViewer: string;
-        /** Option in a dropdown menu that saves the current report as a new GitHub Gist. */
-        dropdownSaveGist: string;
-        /** Option in a dropdown menu that toggles the themeing of the report between Light(default) and Dark themes. */
-        dropdownDarkTheme: string;
-        /** Label for a row in a table that describes the kind of device that was emulated for the Lighthouse run.  Example values for row elements: 'No Emulation', 'Emulated Desktop', etc. */
-        runtimeSettingsDevice: string;
-        /** Label for a row in a table that describes the network throttling conditions that were used during a Lighthouse run, if any. */
-        runtimeSettingsNetworkThrottling: string;
-        /** Label for a row in a table that describes the CPU throttling conditions that were used during a Lighthouse run, if any.*/
-        runtimeSettingsCPUThrottling: string;
-        /** Label for a row in a table that shows the User Agent that was used to send out all network requests during the Lighthouse run. */
-        runtimeSettingsUANetwork: string;
-        /** Label for a row in a table that shows the estimated CPU power of the machine running Lighthouse. Example row values: 532, 1492, 783. */
-        runtimeSettingsBenchmark: string;
-        /** Label for a row in a table that shows the version of the Axe library used. Example row values: 2.1.0, 3.2.3 */
-        runtimeSettingsAxeVersion: string;
-        /** Label for a row in a table that shows the screen resolution and DPR that was emulated for the Lighthouse run. Example values: '800x600, DPR: 3' */
-        runtimeSettingsScreenEmulation: string;
-        /** Label for button to create an issue against the Lighthouse GitHub project. */
-        footerIssue: string;
-        /** Descriptive explanation for emulation setting when no device emulation is set. */
-        runtimeNoEmulation: string;
-        /** Descriptive explanation for emulation setting when emulating a Moto G4 mobile device. */
-        runtimeMobileEmulation: string;
-        /** Descriptive explanation for emulation setting when emulating a generic desktop form factor, as opposed to a mobile-device like form factor. */
-        runtimeDesktopEmulation: string;
-        /** Descriptive explanation for a runtime setting that is set to an unknown value. */
-        runtimeUnknown: string;
-        /** Descriptive label that this analysis run was from a single pageload of a browser (not a summary of hundreds of loads) */
-        runtimeSingleLoad: string;
-        /** Descriptive label that this analysis only considers the initial load of the page, and no interaction beyond when the page had "fully loaded" */
-        runtimeAnalysisWindow: string;
-        /** Descriptive explanation that this analysis run was from a single pageload of a browser, whereas field data often summarizes hundreds+ of page loads */
-        runtimeSingleLoadTooltip: string;
-        /** Descriptive explanation for environment throttling that was provided by the runtime environment instead of provided by Lighthouse throttling. */
-        throttlingProvided: string;
-        /** Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Show' and 'Hide'. */
-        show: string;
-        /** Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Show' and 'Hide'. */
-        hide: string;
-        /** Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Expand view' and 'Collapse view'. */
-        expandView: string;
-        /** Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Expand view' and 'Collapse view'. */
-        collapseView: string;
-        /** Label indicating that Lighthouse throttled the page to emulate a slow 4G network connection. */
-        runtimeSlow4g: string;
-        /** Label indicating that Lighthouse throttled the page using custom throttling settings. */
-        runtimeCustom: string;
-    };
-    /**
-     * @param {Record<string, string>} providedStrings
-     */
-    static applyStrings(providedStrings: Record<string, string>): void;
-    static get PASS_THRESHOLD(): number;
-    static get MS_DISPLAY_VALUE(): string;
-    /**
-     * If LHR is older than 10.0 it will not have the `finalDisplayedUrl` property.
-     * Old LHRs should have the `finalUrl` property which will work fine for the report.
-     *
-     * @param {LH.Result} lhr
-     */
-    static getFinalDisplayedUrl(lhr: LH.Result): string;
-    /**
-     * If LHR is older than 10.0 it will not have the `mainDocumentUrl` property.
-     * Old LHRs should have the `finalUrl` property which is the same as `mainDocumentUrl`.
-     *
-     * @param {LH.Result} lhr
-     */
-    static getMainDocumentUrl(lhr: LH.Result): string | undefined;
-    /**
-     * Returns a new LHR that's reshaped for slightly better ergonomics within the report rendereer.
-     * Also, sets up the localized UI strings used within renderer and makes changes to old LHRs to be
-     * compatible with current renderer.
-     * The LHR passed in is not mutated.
-     * TODO(team): we all agree the LHR shape change is technical debt we should fix
-     * @param {LH.Result} result
-     * @return {LH.ReportResult}
-     */
-    static prepareReportResult(result: LH.Result): LH.ReportResult;
-    /**
-     * @param {LH.Result} lhr
-     * @return {LH.Result.FullPageScreenshot=}
-     */
-    static getFullPageScreenshot(lhr: LH.Result): LH.Result.FullPageScreenshot | undefined;
-    /**
-     * Used to determine if the "passed" for the purposes of showing up in the "failed" or "passed"
-     * sections of the report.
-     *
-     * @param {{score: (number|null), scoreDisplayMode: string}} audit
-     * @return {boolean}
-     */
-    static showAsPassed(audit: {
-        score: (number | null);
-        scoreDisplayMode: string;
-    }): boolean;
-    /**
-     * Convert a score to a rating label.
-     * TODO: Return `'error'` for `score === null && !scoreDisplayMode`.
-     *
-     * @param {number|null} score
-     * @param {string=} scoreDisplayMode
-     * @return {string}
-     */
-    static calculateRating(score: number | null, scoreDisplayMode?: string | undefined): string;
-    /**
-     * Split a string by markdown code spans (enclosed in `backticks`), splitting
-     * into segments that were enclosed in backticks (marked as `isCode === true`)
-     * and those that outside the backticks (`isCode === false`).
-     * @param {string} text
-     * @return {Array<{isCode: true, text: string}|{isCode: false, text: string}>}
-     */
-    static splitMarkdownCodeSpans(text: string): Array<{
-        isCode: true;
-        text: string;
-    } | {
-        isCode: false;
-        text: string;
-    }>;
-    /**
-     * Split a string on markdown links (e.g. [some link](https://...)) into
-     * segments of plain text that weren't part of a link (marked as
-     * `isLink === false`), and segments with text content and a URL that did make
-     * up a link (marked as `isLink === true`).
-     * @param {string} text
-     * @return {Array<{isLink: true, text: string, linkHref: string}|{isLink: false, text: string}>}
-     */
-    static splitMarkdownLink(text: string): Array<{
-        isLink: true;
-        text: string;
-        linkHref: string;
-    } | {
-        isLink: false;
-        text: string;
-    }>;
-    /**
-     * @param {URL} parsedUrl
-     * @param {{numPathParts?: number, preserveQuery?: boolean, preserveHost?: boolean}=} options
-     * @return {string}
-     */
-    static getURLDisplayName(parsedUrl: URL, options?: {
-        numPathParts?: number | undefined;
-        preserveQuery?: boolean | undefined;
-        preserveHost?: boolean | undefined;
-    } | undefined): string;
-    /**
-     * Split a URL into a file, hostname and origin for easy display.
-     * @param {string} url
-     * @return {{file: string, hostname: string, origin: string}}
-     */
-    static parseURL(url: string): {
-        file: string;
-        hostname: string;
-        origin: string;
-    };
-    /**
-     * @param {string|URL} value
-     * @return {!URL}
-     */
-    static createOrReturnURL(value: string | URL): URL;
-    /**
-     * Gets the tld of a domain
-     *
-     * @param {string} hostname
-     * @return {string} tld
-     */
-    static getTld(hostname: string): string;
-    /**
-     * Returns a primary domain for provided hostname (e.g. www.example.com -> example.com).
-     * @param {string|URL} url hostname or URL object
-     * @return {string}
-     */
-    static getRootDomain(url: string | URL): string;
-    /**
-     * @param {LH.Result['configSettings']} settings
-     * @return {!{deviceEmulation: string, screenEmulation?: string, networkThrottling: string, cpuThrottling: string, summary: string}}
-     */
-    static getEmulationDescriptions(settings: LH.Result['configSettings']): {
-        deviceEmulation: string;
-        screenEmulation?: string | undefined;
-        networkThrottling: string;
-        cpuThrottling: string;
-        summary: string;
-    };
-    /**
-     * Returns only lines that are near a message, or the first few lines if there are
-     * no line messages.
-     * @param {LH.Audit.Details.SnippetValue['lines']} lines
-     * @param {LH.Audit.Details.SnippetValue['lineMessages']} lineMessages
-     * @param {number} surroundingLineCount Number of lines to include before and after
-     * the message. If this is e.g. 2 this function might return 5 lines.
-     */
-    static filterRelevantLines(lines: LH.Audit.Details.SnippetValue['lines'], lineMessages: LH.Audit.Details.SnippetValue['lineMessages'], surroundingLineCount: number): {
-        content: string;
-        lineNumber: number;
-        truncated?: boolean | undefined;
-    }[];
-    /**
-     * @param {string} categoryId
-     */
-    static isPluginCategory(categoryId: string): boolean;
-    /**
-     * @param {LH.Result.GatherMode} gatherMode
-     */
-    static shouldDisplayAsFraction(gatherMode: LH.Result.GatherMode): boolean;
-    /**
-     * @param {LH.ReportResult.Category} category
-     */
-    static calculateCategoryFraction(category: LH.ReportResult.Category): {
-        numPassed: number;
-        numPassableAudits: number;
-        numInformative: number;
-        totalWeight: number;
-    };
-}
-export namespace Util {
-    export const reportJson: LH.ReportResult | null;
-    /**
-     * An always-increasing counter for making unique SVG ID suffixes.
-     */
-    export function getUniqueSuffix(): number;
-    export function resetUniqueSuffix(): void;
-    export { UIStrings };
-}
-export namespace UIStrings {
-    const varianceDisclaimer: string;
-    const calculatorLink: string;
-    const showRelevantAudits: string;
-    const opportunityResourceColumnLabel: string;
-    const opportunitySavingsColumnLabel: string;
-    const errorMissingAuditInfo: string;
-    const errorLabel: string;
-    const warningHeader: string;
-    const warningAuditsGroupTitle: string;
-    const passedAuditsGroupTitle: string;
-    const notApplicableAuditsGroupTitle: string;
-    const manualAuditsGroupTitle: string;
-    const toplevelWarningsMessage: string;
-    const crcInitialNavigation: string;
-    const crcLongestDurationLabel: string;
-    const snippetExpandButtonLabel: string;
-    const snippetCollapseButtonLabel: string;
-    const lsPerformanceCategoryDescription: string;
-    const labDataTitle: string;
-    const thirdPartyResourcesLabel: string;
-    const viewTreemapLabel: string;
-    const viewTraceLabel: string;
-    const viewOriginalTraceLabel: string;
-    const dropdownPrintSummary: string;
-    const dropdownPrintExpanded: string;
-    const dropdownCopyJSON: string;
-    const dropdownSaveHTML: string;
-    const dropdownSaveJSON: string;
-    const dropdownViewer: string;
-    const dropdownSaveGist: string;
-    const dropdownDarkTheme: string;
-    const runtimeSettingsDevice: string;
-    const runtimeSettingsNetworkThrottling: string;
-    const runtimeSettingsCPUThrottling: string;
-    const runtimeSettingsUANetwork: string;
-    const runtimeSettingsBenchmark: string;
-    const runtimeSettingsAxeVersion: string;
-    const runtimeSettingsScreenEmulation: string;
-    const footerIssue: string;
-    const runtimeNoEmulation: string;
-    const runtimeMobileEmulation: string;
-    const runtimeDesktopEmulation: string;
-    const runtimeUnknown: string;
-    const runtimeSingleLoad: string;
-    const runtimeAnalysisWindow: string;
-    const runtimeSingleLoadTooltip: string;
-    const throttlingProvided: string;
-    const show: string;
-    const hide: string;
-    const expandView: string;
-    const collapseView: string;
-    const runtimeSlow4g: string;
-    const runtimeCustom: string;
-}
-//# sourceMappingURL=util.d.ts.map