lighthouse 9.6.8 → 10.0.0-dev.20230210

package/core/audits/maskable-icon.d.ts

@@ -0,0 +1,25 @@
+export default MaskableIcon;
+/**
+ * @fileoverview
+ * Audits if a manifest contains at least one icon that is maskable
+ *
+ * Requirements:
+ *    * manifest is not empty
+ *    * manifest has valid icons
+ *    * at least one of the icons has a purpose of 'maskable'
+ */
+declare class MaskableIcon extends Audit {
+    /**
+     * @param {LH.Artifacts} artifacts
+     * @param {LH.Audit.Context} context
+     * @return {Promise<LH.Audit.Product>}
+     */
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
+}
+export namespace UIStrings {
+    const title: string;
+    const failureTitle: string;
+    const description: string;
+}
+import { Audit } from "./audit.js";
+//# sourceMappingURL=maskable-icon.d.ts.map

package/core/audits/maskable-icon.js

@@ -0,0 +1,70 @@
+/**
+ * @license Copyright 2020 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Audit} from './audit.js';
+import {ManifestValues} from '../computed/manifest-values.js';
+import * as i18n from '../lib/i18n/i18n.js';
+
+const UIStrings = {
+  /** Title of a Lighthouse audit that provides detail on if the manifest contains a maskable icon. This descriptive title is shown to users when the manifest contains at least one maskable icon. */
+  title: 'Manifest has a maskable icon',
+  /** Title of a Lighthouse audit that provides detial on if the manifest contains a maskable icon. this descriptive title is shown to users when the manifest contains no icons that are maskable. */
+  failureTitle: 'Manifest doesn\'t have a maskable icon',
+  /** Description of a Lighthouse audit that tells the user why they their manifest should have at least one maskable icon. This is displayed after a user expands the section to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
+  description: 'A maskable icon ensures that the image fills the entire ' +
+    'shape without being letterboxed when installing ' +
+    'the app on a device. [Learn about maskable manifest icons](https://developer.chrome.com/docs/lighthouse/pwa/maskable-icon-audit/).',
+};
+
+const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
+
+/**
+ * @fileoverview
+ * Audits if a manifest contains at least one icon that is maskable
+ *
+ * Requirements:
+ *    * manifest is not empty
+ *    * manifest has valid icons
+ *    * at least one of the icons has a purpose of 'maskable'
+ */
+
+class MaskableIcon extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'maskable-icon',
+      title: str_(UIStrings.title),
+      failureTitle: str_(UIStrings.failureTitle),
+      description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
+      requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors'],
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    const manifestValues = await ManifestValues.request(artifacts, context);
+    if (manifestValues.isParseFailure) {
+      return {
+        score: 0,
+        explanation: manifestValues.parseFailureReason,
+      };
+    }
+    const maskableIconCheck = manifestValues.allChecks.find(i => i.id === 'hasMaskableIcon');
+    return {
+      score: maskableIconCheck?.passing ? 1 : 0,
+    };
+  }
+}
+
+export default MaskableIcon;
+export {UIStrings};

package/core/audits/metrics/cumulative-layout-shift.d.ts

@@ -0,0 +1,21 @@
+export default CumulativeLayoutShift;
+/**
+ * @fileoverview This metric represents the amount of visual shifting of DOM elements during page load.
+ */
+declare class CumulativeLayoutShift extends Audit {
+    /**
+     * @return {LH.Audit.ScoreOptions}
+     */
+    static get defaultOptions(): import("../../../types/audit.js").default.ScoreOptions;
+    /**
+     * @param {LH.Artifacts} artifacts
+     * @param {LH.Audit.Context} context
+     * @return {Promise<LH.Audit.Product>}
+     */
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
+}
+export namespace UIStrings {
+    const description: string;
+}
+import { Audit } from "../audit.js";
+//# sourceMappingURL=cumulative-layout-shift.d.ts.map

package/core/audits/metrics/cumulative-layout-shift.js

@@ -0,0 +1,79 @@
+/**
+ * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Audit} from '../audit.js';
+import {CumulativeLayoutShift as ComputedCLS} from '../../computed/metrics/cumulative-layout-shift.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+
+const UIStrings = {
+  /** Description of the Cumulative Layout Shift metric that indicates how much the page changes its layout while it loads. If big segments of the page shift their location during load, the Cumulative Layout Shift will be higher. This description is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
+  description: 'Cumulative Layout Shift measures the movement of visible ' +
+               'elements within the viewport. ' +
+               '[Learn more about the Cumulative Layout Shift metric](https://web.dev/cls/).',
+};
+
+const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
+
+/**
+ * @fileoverview This metric represents the amount of visual shifting of DOM elements during page load.
+ */
+class CumulativeLayoutShift extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'cumulative-layout-shift',
+      title: str_(i18n.UIStrings.cumulativeLayoutShiftMetric),
+      description: str_(UIStrings.description),
+      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      requiredArtifacts: ['traces'],
+    };
+  }
+
+  /**
+   * @return {LH.Audit.ScoreOptions}
+   */
+  static get defaultOptions() {
+    return {
+      // https://web.dev/cls/#what-is-a-good-cls-score
+      // This 0.1 target score was determined through both manual evaluation and large-scale analysis.
+      // see https://www.desmos.com/calculator/ksp7q91nop
+      p10: 0.1,
+      median: 0.25,
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    const trace = artifacts.traces[Audit.DEFAULT_PASS];
+    const {cumulativeLayoutShift, ...rest} = await ComputedCLS.request(trace, context);
+
+    /** @type {LH.Audit.Details.DebugData} */
+    const details = {
+      type: 'debugdata',
+      items: [rest],
+    };
+
+    return {
+      score: Audit.computeLogNormalScore(
+        {p10: context.options.p10, median: context.options.median},
+        cumulativeLayoutShift
+      ),
+      numericValue: cumulativeLayoutShift,
+      numericUnit: 'unitless',
+      displayValue: cumulativeLayoutShift.toLocaleString(context.settings.locale),
+      details,
+    };
+  }
+}
+
+export default CumulativeLayoutShift;
+export {UIStrings};

package/core/audits/metrics/experimental-interaction-to-next-paint.d.ts

@@ -0,0 +1,21 @@
+export default ExperimentalInteractionToNextPaint;
+/**
+ * @fileoverview This metric gives a high-percentile measure of responsiveness to input.
+ */
+declare class ExperimentalInteractionToNextPaint extends Audit {
+    /**
+     * @return {LH.Audit.ScoreOptions}
+     */
+    static get defaultOptions(): import("../../../types/audit.js").default.ScoreOptions;
+    /**
+     * @param {LH.Artifacts} artifacts
+     * @param {LH.Audit.Context} context
+     * @return {Promise<LH.Audit.Product>}
+     */
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
+}
+export namespace UIStrings {
+    const description: string;
+}
+import { Audit } from "../audit.js";
+//# sourceMappingURL=experimental-interaction-to-next-paint.d.ts.map

package/core/audits/metrics/experimental-interaction-to-next-paint.js

@@ -0,0 +1,88 @@
+/**
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Audit} from '../audit.js';
+import {Responsiveness as ComputedResponsivenes} from '../../computed/metrics/responsiveness.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+
+const UIStrings = {
+  /** Description of the Interaction to Next Paint metric. This description is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
+  description: 'Interaction to Next Paint measures page responsiveness, how long it ' +
+               'takes the page to visibly respond to user input. ' +
+               '[Learn more about the Interaction to Next Paint metric](https://web.dev/inp/).',
+};
+
+const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
+
+/**
+ * @fileoverview This metric gives a high-percentile measure of responsiveness to input.
+ */
+class ExperimentalInteractionToNextPaint extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'experimental-interaction-to-next-paint',
+      title: str_(i18n.UIStrings.interactionToNextPaint),
+      description: str_(UIStrings.description),
+      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      supportedModes: ['timespan'],
+      requiredArtifacts: ['traces'],
+    };
+  }
+
+  /**
+   * @return {LH.Audit.ScoreOptions}
+   */
+  static get defaultOptions() {
+    return {
+      // https://web.dev/inp/
+      // This is using the same threshold as field tools since only supported in
+      // unsimulated user flows for now.
+      // see https://www.desmos.com/calculator/4xtrhg51th
+      p10: 200,
+      median: 500,
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    const {settings} = context;
+    // TODO: responsiveness isn't yet supported by lantern.
+    if (settings.throttlingMethod === 'simulate') {
+      return {score: null, notApplicable: true};
+    }
+
+    const trace = artifacts.traces[Audit.DEFAULT_PASS];
+    const metricData = {trace, settings};
+    const interactionEvent = await ComputedResponsivenes.request(metricData, context);
+
+    // TODO: include the no-interaction state in the report instead of using n/a.
+    if (interactionEvent === null) {
+      return {score: null, notApplicable: true};
+    }
+
+    // TODO: remove workaround once 103.0.5052.0 is sufficiently released.
+    const timing = interactionEvent.name === 'FallbackTiming' ?
+        interactionEvent.duration : interactionEvent.args.data.duration;
+
+    return {
+      score: Audit.computeLogNormalScore({p10: context.options.p10, median: context.options.median},
+        timing),
+      numericValue: timing,
+      numericUnit: 'millisecond',
+      displayValue: str_(i18n.UIStrings.ms, {timeInMs: timing}),
+    };
+  }
+}
+
+export default ExperimentalInteractionToNextPaint;
+export {UIStrings};

package/core/audits/metrics/first-contentful-paint-3g.d.ts

@@ -0,0 +1,15 @@
+export default FirstContentfulPaint3G;
+declare class FirstContentfulPaint3G extends Audit {
+    /**
+     * @return {LH.Audit.ScoreOptions}
+     */
+    static get defaultOptions(): import("../../../types/audit.js").default.ScoreOptions;
+    /**
+     * @param {LH.Artifacts} artifacts
+     * @param {LH.Audit.Context} context
+     * @return {Promise<LH.Audit.Product>}
+     */
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
+}
+import { Audit } from "../audit.js";
+//# sourceMappingURL=first-contentful-paint-3g.d.ts.map

package/core/audits/metrics/first-contentful-paint-3g.js

@@ -0,0 +1,69 @@
+/**
+ * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Audit} from '../audit.js';
+import {FirstContentfulPaint as ComputedFcp} from '../../computed/metrics/first-contentful-paint.js';
+import * as constants from '../../config/constants.js';
+
+const regular3G = constants.throttling.mobileRegular3G;
+
+class FirstContentfulPaint3G extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'first-contentful-paint-3g',
+      title: 'First Contentful Paint (3G)',
+      description: 'First Contentful Paint 3G marks the time at which the first text or image is ' +
+        'painted while on a 3G network. ' +
+        '[Learn more about the First Contentful Paint (3G) metric](https://developers.google.com/web/tools/lighthouse/audits/first-contentful-paint).',
+      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      supportedModes: ['navigation'],
+      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext', 'URL'],
+    };
+  }
+
+  /**
+   * @return {LH.Audit.ScoreOptions}
+   */
+  static get defaultOptions() {
+    return {
+      // 25th and 8th percentiles HTTPArchive on Slow 4G -> multiply by 1.5 for RTT differential -> median and p10.
+      // https://bigquery.cloud.google.com/table/httparchive:lighthouse.2021_05_01_mobile
+      // https://www.desmos.com/calculator/xi5oympawp
+      p10: 2700,
+      median: 4500,
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    const gatherContext = artifacts.GatherContext;
+    const trace = artifacts.traces[Audit.DEFAULT_PASS];
+    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+    /** @type {LH.Audit.Context['settings']} */
+    const settings = {...context.settings, throttlingMethod: 'simulate', throttling: regular3G};
+    const metricComputationData = {trace, devtoolsLog, gatherContext, settings, URL: artifacts.URL};
+    const metricResult = await ComputedFcp.request(metricComputationData, context);
+
+    return {
+      score: Audit.computeLogNormalScore(
+        {p10: context.options.p10, median: context.options.median},
+        metricResult.timing
+      ),
+      numericValue: metricResult.timing,
+      numericUnit: 'millisecond',
+      displayValue: `${metricResult.timing}\xa0ms`,
+    };
+  }
+}
+
+export default FirstContentfulPaint3G;

package/core/audits/metrics/first-contentful-paint.d.ts

@@ -0,0 +1,25 @@
+export default FirstContentfulPaint;
+declare class FirstContentfulPaint extends Audit {
+    /**
+     * @return {{mobile: {scoring: LH.Audit.ScoreOptions}, desktop: {scoring: LH.Audit.ScoreOptions}}}
+     */
+    static get defaultOptions(): {
+        mobile: {
+            scoring: LH.Audit.ScoreOptions;
+        };
+        desktop: {
+            scoring: LH.Audit.ScoreOptions;
+        };
+    };
+    /**
+     * @param {LH.Artifacts} artifacts
+     * @param {LH.Audit.Context} context
+     * @return {Promise<LH.Audit.Product>}
+     */
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
+}
+export namespace UIStrings {
+    const description: string;
+}
+import { Audit } from "../audit.js";
+//# sourceMappingURL=first-contentful-paint.d.ts.map

package/core/audits/metrics/first-contentful-paint.js

@@ -0,0 +1,85 @@
+/**
+ * @license Copyright 2018 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {FirstContentfulPaint as ComputedFcp} from '../../computed/metrics/first-contentful-paint.js';
+
+const UIStrings = {
+  /** Description of the First Contentful Paint (FCP) metric, which marks the time at which the first text or image is painted by the browser. This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
+  description: 'First Contentful Paint marks the time at which the first text or image is ' +
+      'painted. [Learn more about the First Contentful Paint metric](https://developer.chrome.com/docs/lighthouse/performance/first-contentful-paint/).',
+};
+
+const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
+
+class FirstContentfulPaint extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'first-contentful-paint',
+      title: str_(i18n.UIStrings.firstContentfulPaintMetric),
+      description: str_(UIStrings.description),
+      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      supportedModes: ['navigation'],
+      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext', 'URL'],
+    };
+  }
+
+  /**
+   * @return {{mobile: {scoring: LH.Audit.ScoreOptions}, desktop: {scoring: LH.Audit.ScoreOptions}}}
+   */
+  static get defaultOptions() {
+    return {
+      mobile: {
+        // 25th and 8th percentiles HTTPArchive -> median and p10.
+        // https://bigquery.cloud.google.com/table/httparchive:lighthouse.2021_05_01_mobile
+        // see https://www.desmos.com/calculator/6wi8rhipve
+        scoring: {
+          p10: 1800,
+          median: 3000,
+        },
+      },
+      desktop: {
+        // SELECT QUANTILES(renderStart, 21) FROM [httparchive:summary_pages.2020_07_01_desktop] LIMIT 1000
+        scoring: {
+          p10: 934,
+          median: 1600,
+        },
+      },
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    const trace = artifacts.traces[Audit.DEFAULT_PASS];
+    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+    const gatherContext = artifacts.GatherContext;
+    const metricComputationData = {trace, devtoolsLog, gatherContext,
+      settings: context.settings, URL: artifacts.URL};
+    const metricResult = await ComputedFcp.request(metricComputationData, context);
+    const options = context.options[context.settings.formFactor];
+
+    return {
+      score: Audit.computeLogNormalScore(
+        options.scoring,
+        metricResult.timing
+      ),
+      numericValue: metricResult.timing,
+      numericUnit: 'millisecond',
+      displayValue: str_(i18n.UIStrings.seconds, {timeInMs: metricResult.timing}),
+    };
+  }
+}
+
+export default FirstContentfulPaint;
+export {UIStrings};

package/core/audits/metrics/first-meaningful-paint.d.ts

@@ -0,0 +1,28 @@
+export default FirstMeaningfulPaint;
+declare class FirstMeaningfulPaint extends Audit {
+    /**
+     * @return {{mobile: {scoring: LH.Audit.ScoreOptions}, desktop: {scoring: LH.Audit.ScoreOptions}}}
+     */
+    static get defaultOptions(): {
+        mobile: {
+            scoring: LH.Audit.ScoreOptions;
+        };
+        desktop: {
+            scoring: LH.Audit.ScoreOptions;
+        };
+    };
+    /**
+     * Audits the page to give a score for First Meaningful Paint.
+     * @see https://github.com/GoogleChrome/lighthouse/issues/26
+     * @see https://docs.google.com/document/d/1BR94tJdZLsin5poeet0XoTW60M0SjvOJQttKT-JK8HI/view
+     * @param {LH.Artifacts} artifacts The artifacts from the gather phase.
+     * @param {LH.Audit.Context} context
+     * @return {Promise<LH.Audit.Product>}
+     */
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
+}
+export namespace UIStrings {
+    const description: string;
+}
+import { Audit } from "../audit.js";
+//# sourceMappingURL=first-meaningful-paint.d.ts.map

package/core/audits/metrics/first-meaningful-paint.js

@@ -0,0 +1,89 @@
+/**
+ * @license Copyright 2016 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Audit} from '../audit.js';
+import * as i18n from '../../lib/i18n/i18n.js';
+import {FirstMeaningfulPaint as ComputedFmp} from '../../computed/metrics/first-meaningful-paint.js';
+
+const UIStrings = {
+  /** Description of the First Meaningful Paint (FMP) metric, which marks the time at which a majority of the content has been painted by the browser. This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
+  description: 'First Meaningful Paint measures when the primary content of a page is ' +
+      'visible. [Learn more about the First Meaningful Paint metric](https://developer.chrome.com/docs/lighthouse/performance/first-meaningful-paint/).',
+};
+
+const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
+
+class FirstMeaningfulPaint extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'first-meaningful-paint',
+      title: str_(i18n.UIStrings.firstMeaningfulPaintMetric),
+      description: str_(UIStrings.description),
+      scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
+      supportedModes: ['navigation'],
+      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext', 'URL'],
+    };
+  }
+
+  /**
+   * @return {{mobile: {scoring: LH.Audit.ScoreOptions}, desktop: {scoring: LH.Audit.ScoreOptions}}}
+   */
+  static get defaultOptions() {
+    return {
+      mobile: {
+        // 25th and 5th percentiles HTTPArchive -> median and PODR, then p10 derived from them.
+        // https://bigquery.cloud.google.com/table/httparchive:lighthouse.2018_04_01_mobile?pli=1
+        // see https://www.desmos.com/calculator/i4znkdccut
+        scoring: {
+          p10: 2336,
+          median: 4000,
+        },
+      },
+      desktop: {
+        // SELECT QUANTILES(renderStart, 21) FROM [httparchive:summary_pages.2018_12_15_desktop] LIMIT 1000
+        scoring: {
+          p10: 934,
+          median: 1600,
+        },
+      },
+    };
+  }
+
+  /**
+   * Audits the page to give a score for First Meaningful Paint.
+   * @see https://github.com/GoogleChrome/lighthouse/issues/26
+   * @see https://docs.google.com/document/d/1BR94tJdZLsin5poeet0XoTW60M0SjvOJQttKT-JK8HI/view
+   * @param {LH.Artifacts} artifacts The artifacts from the gather phase.
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    const trace = artifacts.traces[Audit.DEFAULT_PASS];
+    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+    const gatherContext = artifacts.GatherContext;
+    const metricComputationData = {trace, devtoolsLog, gatherContext,
+      settings: context.settings, URL: artifacts.URL};
+    const metricResult = await ComputedFmp.request(metricComputationData, context);
+    const options = context.options[context.settings.formFactor];
+
+
+    return {
+      score: Audit.computeLogNormalScore(
+        options.scoring,
+        metricResult.timing
+      ),
+      numericValue: metricResult.timing,
+      numericUnit: 'millisecond',
+      displayValue: str_(i18n.UIStrings.seconds, {timeInMs: metricResult.timing}),
+    };
+  }
+}
+
+export default FirstMeaningfulPaint;
+export {UIStrings};

package/core/audits/metrics/interactive.d.ts

@@ -0,0 +1,31 @@
+export default InteractiveMetric;
+/**
+ * @fileoverview This audit identifies the time the page is "consistently interactive".
+ * Looks for the first period of at least 5 seconds after FMP where both CPU and network were quiet,
+ * and returns the timestamp of the beginning of the CPU quiet period.
+ * @see https://docs.google.com/document/d/1GGiI9-7KeY3TPqS3YT271upUVimo-XiL5mwWorDUD4c/edit#
+ */
+declare class InteractiveMetric extends Audit {
+    /**
+     * @return {{mobile: {scoring: LH.Audit.ScoreOptions}, desktop: {scoring: LH.Audit.ScoreOptions}}}
+     */
+    static get defaultOptions(): {
+        mobile: {
+            scoring: LH.Audit.ScoreOptions;
+        };
+        desktop: {
+            scoring: LH.Audit.ScoreOptions;
+        };
+    };
+    /**
+     * @param {LH.Artifacts} artifacts
+     * @param {LH.Audit.Context} context
+     * @return {Promise<LH.Audit.Product>}
+     */
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
+}
+export namespace UIStrings {
+    const description: string;
+}
+import { Audit } from "../audit.js";
+//# sourceMappingURL=interactive.d.ts.map