lighthouse 8.3.0-dev.20210904 → 8.3.0

package/types/lhr/audit-result.d.ts

@@ -1,59 +0,0 @@
-/**
- * @license Copyright 2021 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 {FormattedIcu} from './i18n';
-import AuditDetails from './audit-details';
-
-interface ScoreDisplayModes {
-  /** Scores of 0-1 (map to displayed scores of 0-100). */
-  NUMERIC: 'numeric';
-  /** Pass/fail audit (0 and 1 are only possible scores). */
-  BINARY: 'binary';
-  /** The audit exists only to tell you to review something yourself. Score is null and should be ignored. */
-  MANUAL: 'manual';
-  /** The audit is an FYI only, and can't be interpreted as pass/fail. Score is null and should be ignored. */
-  INFORMATIVE: 'informative';
-  /** The audit turned out to not apply to the page. Score is null and should be ignored. */
-  NOT_APPLICABLE: 'notApplicable';
-  /** There was an error while running the audit (check `errorMessage` for details). Score is null and should be ignored. */
-  ERROR: 'error';
-}
-
-type ScoreDisplayMode = ScoreDisplayModes[keyof ScoreDisplayModes];
-
-/** Audit result returned in Lighthouse report. All audits offer a description and score of 0-1. */
-export interface Result {
-  displayValue?: string;
-  /** An explanation of why the audit failed on the test page. */
-  explanation?: string;
-  /** Error message from any exception thrown while running this audit. */
-  errorMessage?: string;
-  warnings?: string[];
-  /** The scored value of the audit, provided in the range `0-1`, or null if `scoreDisplayMode` indicates not scored. */
-  score: number|null;
-  /**
-   * A string identifying how the score should be interpreted:
-   * - 'binary': pass/fail audit (0 and 1 are only possible scores).
-   * - 'numeric': scores of 0-1 (map to displayed scores of 0-100).
-   * - 'informative': the audit is an FYI only, and can't be interpreted as pass/fail. Score is null and should be ignored.
-   * - 'notApplicable': the audit turned out to not apply to the page. Score is null and should be ignored.
-   * - 'manual': The audit exists only to tell you to review something yourself. Score is null and should be ignored.
-   * - 'error': There was an error while running the audit (check `errorMessage` for details). Score is null and should be ignored.
-   */
-  scoreDisplayMode: ScoreDisplayMode;
-  /** Short, user-visible title for the audit. The text can change depending on if the audit passed or failed. */
-  title: string;
-  /** The string identifier of the audit, in kebab case. */
-  id: string;
-  /** A more detailed description that describes why the audit is important and links to Lighthouse documentation on the audit; markdown links supported. */
-  description: string;
-  /** A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present. */
-  numericValue?: number;
-  /** The unit of `numericValue`, used when the consumer wishes to convert numericValue to a display string. */
-  numericUnit?: string;
-  /** Extra information about the page provided by some types of audits, in one of several possible forms that can be rendered in the HTML report. */
-  details?: FormattedIcu<AuditDetails>;
-}

package/types/lhr/flow.d.ts

@@ -1,16 +0,0 @@
-/**
- * @license Copyright 2021 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 Result from './lhr';
-
-/**
- * The full output of a Lighthouse flow. Includes a series of Lighthouse runs.
- * TODO(FR-COMPAT): Add flow specific metadata (e.g. interaction steps).
- */
-export default interface FlowResult {
-  /** Ordered list of lighthouse results corresponding to a navigation, timespan, or snapshot. */
-  lhrs: Result[];
-}

package/types/lhr/settings.d.ts

@@ -1,105 +0,0 @@
-/**
- * @license Copyright 2021 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 Budget from './budget';
-
-export type Locale = 'en-US'|'en'|'en-AU'|'en-GB'|'en-IE'|'en-SG'|'en-ZA'|'en-IN'|'ar-XB'|'ar'|'bg'|'ca'|'cs'|'da'|'de'|'el'|'en-XA'|'en-XL'|'es'|'es-419'|'es-AR'|'es-BO'|'es-BR'|'es-BZ'|'es-CL'|'es-CO'|'es-CR'|'es-CU'|'es-DO'|'es-EC'|'es-GT'|'es-HN'|'es-MX'|'es-NI'|'es-PA'|'es-PE'|'es-PR'|'es-PY'|'es-SV'|'es-US'|'es-UY'|'es-VE'|'fi'|'fil'|'fr'|'he'|'hi'|'hr'|'hu'|'gsw'|'id'|'in'|'it'|'iw'|'ja'|'ko'|'lt'|'lv'|'mo'|'nl'|'nb'|'no'|'pl'|'pt'|'pt-PT'|'ro'|'ru'|'sk'|'sl'|'sr'|'sr-Latn'|'sv'|'ta'|'te'|'th'|'tl'|'tr'|'uk'|'vi'|'zh'|'zh-HK'|'zh-TW';
-
-/** Simulation settings that control the amount of network & cpu throttling in the run. */
-export interface ThrottlingSettings {
-  /** The round trip time in milliseconds. */
-  rttMs?: number;
-  /** The network throughput in kilobits per second. */
-  throughputKbps?: number;
-  // devtools settings
-  /** The network request latency in milliseconds. */
-  requestLatencyMs?: number;
-  /** The network download throughput in kilobits per second. */
-  downloadThroughputKbps?: number;
-  /** The network upload throughput in kilobits per second. */
-  uploadThroughputKbps?: number;
-  // used by both
-  /** The amount of slowdown applied to the cpu (1/<cpuSlowdownMultiplier>). */
-  cpuSlowdownMultiplier?: number
-}
-
-export interface PrecomputedLanternData {
-  additionalRttByOrigin: {[origin: string]: number};
-  serverResponseTimeByOrigin: {[origin: string]: number};
-}
-
-export type OutputMode = 'json' | 'html' | 'csv';
-
-export type ScreenEmulationSettings = {
-  /** Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override. */
-  width: number;
-  /** Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override. */
-  height: number;
-  /** Overriding device scale factor value. 0 disables the override. */
-  deviceScaleFactor: number;
-  /** Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more. */
-  mobile: boolean;
-  /** Whether screen emulation is disabled. If true, the other emulation settings are ignored. */
-  disabled: boolean;
-};
-
-/**
- * Options that are found in both the flags used by the Lighthouse module
- * interface and the Config's `settings` object.
- */
- export interface SharedFlagsSettings {
-  /** The type(s) of report output to be produced. */
-  output?: OutputMode|OutputMode[];
-  /** The locale to use for the output. */
-  locale?: Locale;
-  /** The maximum amount of time to wait for a page content render, in ms. If no content is rendered within this limit, the run is aborted with an error. */
-  maxWaitForFcp?: number;
-  /** The maximum amount of time to wait for a page to load, in ms. */
-  maxWaitForLoad?: number;
-  /** List of URL patterns to block. */
-  blockedUrlPatterns?: string[] | null;
-  /** Comma-delimited list of trace categories to include. */
-  additionalTraceCategories?: string | null;
-  /** Flag indicating the run should only audit. */
-  auditMode?: boolean | string;
-  /** Flag indicating the run should only gather. */
-  gatherMode?: boolean | string;
-  /** Flag indicating that the browser storage should not be reset for the audit. */
-  disableStorageReset?: boolean;
-  /** Flag indicating that Lighthouse should pause after page load to wait for the user's permission to continue the audit. */
-  debugNavigation?: boolean;
-
-  /** How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop. Must be set even if throttling/emulation is being applied outside of Lighthouse. */
-  formFactor?: 'mobile'|'desktop';
-  /** Screen emulation properties (width, height, dpr, mobile viewport) to apply or an object of `{disabled: true}` if Lighthouse should avoid applying screen emulation. If either emulation is applied outside of Lighthouse, or it's being run on a mobile device, it typically should be set to disabled. For desktop, we recommend applying consistent desktop screen emulation. */
-  screenEmulation?: Partial<ScreenEmulationSettings>;
-  /** User Agent string to apply, `false` to not change the host's UA string, or `true` to use Lighthouse's default UA string. */
-  emulatedUserAgent?: string | boolean;
-
-  /** The method used to throttle the network. */
-  throttlingMethod?: 'devtools'|'simulate'|'provided';
-  /** The throttling config settings. */
-  throttling?: ThrottlingSettings;
-  /** If present, the run should only conduct this list of audits. */
-  onlyAudits?: string[] | null;
-  /** If present, the run should only conduct this list of categories. */
-  onlyCategories?: string[] | null;
-  /** If present, the run should skip this list of audits. */
-  skipAudits?: string[] | null;
-  /** List of extra HTTP Headers to include. */
-  extraHeaders?: Record<string, string> | null; // Matches `Protocol.Network.Headers`.
-  /** How Lighthouse was run, e.g. from the Chrome extension or from the npm module */
-  channel?: string
-  /** Precomputed lantern estimates to use instead of observed analysis. */
-  precomputedLanternData?: PrecomputedLanternData | null;
-  /** The budget.json object for LightWallet. */
-  budgets?: Array<Budget> | null;
-}
-
-export interface ConfigSettings extends Required<SharedFlagsSettings> {
-  throttling: Required<ThrottlingSettings>;
-  screenEmulation: ScreenEmulationSettings;
-}

package/types/lhr/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "esnext",
-    "target": "esnext",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-
-    "strict": true,
-    "extendedDiagnostics": true,
-
-    // We only need the base JS definitions, no libs in node_modules, no DOM, etc.
-    "lib": ["esnext"],
-    "types": [],
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-
-    "composite": true,
-    "outDir": "../../.tmp/tsbuildinfo/types/lhr",
-  },
-  "include": [
-    "*.d.ts",
-  ],
-}

package/types/query-selector.d.ts

@@ -1,36 +0,0 @@
-/**
- * @license Copyright 2021 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.
- */
-
-/**
- * @fileoverview Stricter querySelector/querySelectorAll using typed-query-selector.
- */
-
-import {ParseSelectorToTagNames} from 'typed-query-selector/parser';
-
-/** Merge properties of the types in union `T`. Where properties overlap, property types becomes the union of the two (or more) possible types. */
-type MergeTypes<T> = {
-  [K in (T extends unknown ? keyof T : never)]: T extends Record<K, infer U> ? U : never;
-};
-
-// Helper types for strict querySelector/querySelectorAll that includes the overlap
-// between HTML and SVG node names (<a>, <script>, etc).
-// see https://github.com/GoogleChrome/lighthouse/issues/12011
-type HtmlAndSvgElementTagNameMap = MergeTypes<HTMLElementTagNameMap|SVGElementTagNameMap> & {
-  // Fall back to Element (base of HTMLElement and SVGElement) if no specific tag name matches.
-  [id: string]: Element;
-};
-type QuerySelectorParse<I extends string> = ParseSelectorToTagNames<I> extends infer TagNames ?
-  TagNames extends Array<string> ?
-    HtmlAndSvgElementTagNameMap[TagNames[number]] :
-    Element: // Fall back for queries typed-query-selector fails to parse, e.g. `'[alt], [aria-label]'`.
-  never;
-
-declare global {
-  interface ParentNode {
-    querySelector<S extends string>(selector: S): QuerySelectorParse<S> | null;
-    querySelectorAll<S extends string>(selector: S): NodeListOf<QuerySelectorParse<S>>;
-  }
-}