lighthouse 9.5.0-dev.20230122 → 9.5.0-dev.20230124

package/types/lhr/lhr.d.ts

@@ -56,6 +56,8 @@ interface Result {
   };
   /** An array containing the result of all stack packs. */
   stackPacks?: Result.StackPack[];
+  /** All the origins encountered during this Lighthouse run, and information about what web property (aka "entity") they belong to. Won't be present for snapshot mode. */
+  entities?: Result.Entities;
   /** Screenshot taken of the full page, with node rects referencing audit results. If there was an error with collection, this is null. If disabled via the disableFullPageScreenshot setting, this is undefined. */
   fullPageScreenshot?: Result.FullPageScreenshot | null;
 }
@@ -151,6 +153,37 @@ declare module Result {
     nodes: Record<string, AuditDetails.Rect>;
   }
 
+  /**
+   * Entity classification for the run, for resolving URLs/items to entities in report.
+   * The two lookup tables (LUT) below provide space-optimized, O(1) index lookup into entities.list.
+   */
+  interface Entities {
+    /** All entities (1st and 3rd party) discovered during the run */
+    list: Array<LhrEntity>;
+    /** Name of the first-party entity */
+    firstParty?: string;
+    /** Entity-name to entity index lookup table  */
+    entityIndexByName: Record<string, number>;
+    /** URL origin to entity index lookup table */
+    entityIndexByOrigin: Record<string, number>;
+  }
+
+  /**
+   * An entity that's either recognized by third-party-web or made up by Lighthouse.
+   */
+  interface LhrEntity {
+    /** Name of the entity. Maps to third-party-web unique name for recognized entities and a root domain name for the unrecognized. */
+    name: string;
+    /** Homepage URL for a recognized entity, if available in third-party-web. */
+    homepage?: string;
+    /** Category name that the entity belongs to, if available. */
+    category?: string;
+    /** Is this entity the first party? */
+    isFirstParty?: boolean;
+    /** Is this entity recognized by third-party-web? */
+    isUnrecognized?: boolean;
+  }
+
   /**
    * Info about an `LH.IcuMessage` value that was localized to a string when
    * included in the LHR. Value is either a

package/report/renderer/util.d.ts

@@ -1,230 +0,0 @@
-export type I18n<T> = import('./i18n').I18n<T>;
-export class Util {
-    /** @type {I18n<typeof UIStrings>} */
-    static i18n: I18n<typeof UIStrings>;
-    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