lighthouse 9.5.0-dev.20230117 → 9.5.0-dev.20230119

package/types/{lookup-closest-locale/index.d.ts → internal/lookup-closest-locale.d.ts}

@@ -4,8 +4,10 @@
  * 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.
  */
 
+type Locale = import('../lhr/settings.js').Locale;
+
 declare module 'lookup-closest-locale' {
-  function lookupClosestLocale(locale: string[]|string|undefined, available: Record<LH.Locale, any>): LH.Locale|undefined;
+  function lookupClosestLocale(locale: string[]|string|undefined, available: Record<Locale, any>): Locale|undefined;
 
   export = lookupClosestLocale;
 }

package/types/{query-selector.d.ts → internal/query-selector.d.ts}

@@ -8,7 +8,7 @@
  * @fileoverview Stricter querySelector/querySelectorAll using typed-query-selector.
  */
 
-import {ParseSelectorToTagNames} from 'typed-query-selector/parser';
+import {ParseSelectorToTagNames} from 'typed-query-selector/parser.js';
 
 /** 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> = {

package/types/{smokehouse.d.ts → internal/smokehouse.d.ts}

@@ -4,9 +4,9 @@
  * 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 {Artifacts} from './artifacts';
-import Config from './config';
-import LHResult from './lhr/lhr';
+import {Artifacts} from '../artifacts.js';
+import Config from '../config.js';
+import LHResult from '../lhr/lhr.js';
 
 declare global {
   module Smokehouse {

package/types/lh.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @license Copyright 2023 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 {ArbitraryEqualityMap as ArbitraryEqualityMap_} from '../core/lib/arbitrary-equality-map.js';
+import * as Artifacts_ from './artifacts.js';
+import Audit_ from './audit.js';
+import Budget_ from './lhr/budget.js';
+import Config_ from './config.js';
+import {Protocol as _Crdp} from 'devtools-protocol/types/protocol.js';
+import {ProtocolMapping as _CrdpMappings} from 'devtools-protocol/types/protocol-mapping.js';
+import * as Externs from './externs.js';
+import Gatherer_ from './gatherer.js';
+import * as I18n from './lhr/i18n.js';
+import {LighthouseError as LighthouseError_} from '../core/lib/lh-error.js';
+import LHResult from './lhr/lhr.js';
+import FlowResult_ from './lhr/flow-result.js';
+import Protocol_ from './protocol.js';
+import * as Settings from './lhr/settings.js';
+import Treemap_ from './lhr/treemap.js';
+import UserFlow_ from './user-flow.js';
+import Puppeteer_ from './puppeteer.js';
+import Util_ from './utility-types.js';
+
+// Construct hierarchy of global types under the LH namespace.
+export type ArbitraryEqualityMap = ArbitraryEqualityMap_;
+export type NavigationRequestor = string | (() => Promise<void> | void);
+
+export import Util = Util_;
+
+export import Puppeteer = Puppeteer_;
+
+// artifacts.d.ts
+export import Artifacts = Artifacts_.Artifacts;
+export import BaseArtifacts = Artifacts_.BaseArtifacts;
+export import FRArtifacts = Artifacts_.FRArtifacts;
+export import FRBaseArtifacts = Artifacts_.FRBaseArtifacts;
+export import GathererArtifacts = Artifacts_.GathererArtifacts;
+export import DevtoolsLog = Artifacts_.DevtoolsLog;
+export import Trace = Artifacts_.Trace;
+export import TraceCpuProfile = Artifacts_.TraceCpuProfile;
+export import TraceEvent = Artifacts_.TraceEvent;
+
+export import Audit = Audit_;
+export import Budget = Budget_;
+export import Config = Config_;
+export import Crdp = _Crdp;
+export import CrdpEvents = _CrdpMappings.Events;
+export import CrdpCommands = _CrdpMappings.Commands;
+
+export import UserFlow = UserFlow_;
+
+// externs.d.ts
+export import Flags = Externs.Flags;
+export import CliFlags = Externs.CliFlags;
+export import RunnerResult = Externs.RunnerResult;
+export import DevToolsJsonTarget = Externs.DevToolsJsonTarget;
+
+export import Gatherer = Gatherer_;
+export import LighthouseError = LighthouseError_;
+export import Result = LHResult;
+export import FlowResult = FlowResult_;
+
+// lhr/i18n.d.ts
+export import IcuMessage = I18n.IcuMessage;
+export import RawIcu = I18n.RawIcu;
+export import FormattedIcu = I18n.FormattedIcu;
+
+export import Protocol = Protocol_;
+
+// lhr/settings.d.ts
+export import Locale = Settings.Locale;
+export import ThrottlingSettings = Settings.ThrottlingSettings;
+export import ScreenEmulationSettings = Settings.ScreenEmulationSettings;
+export import SharedFlagsSettings = Settings.SharedFlagsSettings;
+export import OutputMode = Settings.OutputMode;
+export import PrecomputedLanternData = Settings.PrecomputedLanternData;
+
+export import Treemap = Treemap_;

package/types/lh.js

@@ -0,0 +1,13 @@
+
+/**
+ * @license Copyright 2023 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 Typescript does not allow us to import an entire module via JSDOC so we need to import type modules via regular imports.
+ * This empty module will be served to any JS file that needs to import our global type module.
+ */
+
+export {};

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

@@ -4,8 +4,8 @@
  * 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 {IcuMessage} from './i18n';
-import Treemap from './treemap';
+import {IcuMessage} from './i18n.js';
+import Treemap from './treemap.js';
 
 type Details =
   Details.CriticalRequestChain |

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

@@ -4,8 +4,8 @@
  * 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';
+import {FormattedIcu} from './i18n.js';
+import AuditDetails from './audit-details.js';
 
 interface ScoreDisplayModes {
   /** Scores of 0-1 (map to displayed scores of 0-100). */

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

@@ -4,7 +4,7 @@
  * 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';
+import Result from './lhr.js';
 
 declare module FlowResult {
   interface Step {

package/types/lhr/lhr.d.ts

@@ -4,9 +4,9 @@
  * 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 as AuditResult} from './audit-result';
+import {Result as AuditResult} from './audit-result.js';
 import AuditDetails from './audit-details.js';
-import {ConfigSettings} from './settings';
+import {ConfigSettings} from './settings.js';
 
 /**
  * The full output of a Lighthouse run.

package/types/lhr/settings.d.ts

@@ -4,7 +4,7 @@
  * 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';
+import Budget from './budget.js';
 
 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';
 

package/types/lhr/treemap.d.ts

@@ -4,8 +4,8 @@
  * 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 as AuditResult} from './audit-result';
-import {Locale} from './settings';
+import {Result as AuditResult} from './audit-result.js';
+import {Locale} from './settings.js';
 
 declare module Treemap {
   interface Options {

package/types/protocol.d.ts

@@ -4,6 +4,11 @@
  * 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 {ProtocolMapping as CrdpMappings} from 'devtools-protocol/types/protocol-mapping.js';
+
+type CrdpEvents = CrdpMappings.Events;
+type CrdpCommands = CrdpMappings.Commands;
+
 declare module Protocol {
   /**
    * An intermediate type, used to create a record of all possible Crdp raw event
@@ -13,10 +18,10 @@ declare module Protocol {
    * }
    */
   type RawEventMessageRecord = {
-    [K in keyof LH.CrdpEvents]: {
+    [K in keyof CrdpEvents]: {
       method: K,
       // Drop [] for `undefined` (so a JS value is valid).
-      params: LH.CrdpEvents[K] extends [] ? undefined: LH.CrdpEvents[K][number]
+      params: CrdpEvents[K] extends [] ? undefined: CrdpEvents[K][number]
       // If sessionId is not set, it means the event was from the root target.
       sessionId?: string;
     };
@@ -33,7 +38,7 @@ declare module Protocol {
    */
   type RawCommandMessage = {
     id: number;
-    result: LH.CrdpCommands[keyof LH.CrdpCommands]['returnType'];
+    result: CrdpCommands[keyof CrdpCommands]['returnType'];
     error: {
       code: number,
       message: string

package/types/puppeteer.d.ts

@@ -4,19 +4,24 @@
  * 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 puppeteer from 'puppeteer';
-import puppeteerCore from 'puppeteer-core';
+import * as puppeteerCore from 'puppeteer-core';
 
 /**
  * @fileoverview Lighthouse should be compatible with puppeteer and puppeteer-core even though the types can be slightly different between the two packages.
  * Anytime we want to use a Puppeteer type within Lighthouse, we should pull the union type from here rather than one of the packages directly.
  */
 
+type IfNotAny<T> = [T & 0] extends [1] ? never : T;
+
 declare module Puppeteer {
-  export type Browser = puppeteerCore.Browser | puppeteer.Browser;
-  export type Page = puppeteerCore.Page | puppeteer.Page;
-  export type CDPSession = puppeteerCore.CDPSession | puppeteer.CDPSession;
-  export type Connection = puppeteerCore.Connection | puppeteer.Connection;
+  // @ts-ignore Puppeteer is an optional dependency. `IfNotAny` will handle the `any` type if it's not installed.
+  export type Browser = puppeteerCore.Browser | IfNotAny<import('puppeteer').Browser>;
+  // @ts-ignore Puppeteer is an optional dependency. `IfNotAny` will handle the `any` type if it's not installed.
+  export type Page = puppeteerCore.Page | IfNotAny<import('puppeteer').Page>;
+  // @ts-ignore Puppeteer is an optional dependency. `IfNotAny` will handle the `any` type if it's not installed.
+  export type CDPSession = puppeteerCore.CDPSession | IfNotAny<import('puppeteer').CDPSession>;
+  // @ts-ignore Puppeteer is an optional dependency. `IfNotAny` will handle the `any` type if it's not installed.
+  export type Connection = puppeteerCore.Connection | IfNotAny<import('puppeteer').Connection>;
 }
 
 export default Puppeteer;

package/types/user-flow.d.ts

@@ -1,4 +1,13 @@
-import {UserFlow as UserFlow_} from '../core/user-flow';
+/**
+ * @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 {UserFlow as UserFlow_} from '../core/user-flow.js';
+import Config from './config.js';
+import {Flags} from './externs.js';
+import {Artifacts} from './artifacts.js';
 
 declare module UserFlow {
   export interface FlowArtifacts {
@@ -8,20 +17,20 @@ declare module UserFlow {
 
   export interface Options {
     /** Config to use for each flow step. */
-    config?: LH.Config;
+    config?: Config;
     /** Base flags to use for each flow step. Step specific flags will override these flags. */
-    flags?: LH.Flags;
+    flags?: Flags;
     /** Display name for this user flow. */
     name?: string;
   }
 
-  export interface StepFlags extends LH.Flags {
+  export interface StepFlags extends Flags {
     /** Display name for this flow step. */
     name?: string;
   }
 
   export interface GatherStep {
-    artifacts: LH.Artifacts;
+    artifacts: Artifacts;
     flags?: StepFlags;
   }
 }

package/types/global-lh.d.ts

@@ -1,85 +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 {ArbitraryEqualityMap as ArbitraryEqualityMap_} from '../core/lib/arbitrary-equality-map.js';
-import * as Artifacts_ from './artifacts';
-import Audit_ from './audit';
-import Budget_ from './lhr/budget';
-import Config_ from './config';
-import _Crdp from 'devtools-protocol/types/protocol';
-import _CrdpMappings from 'devtools-protocol/types/protocol-mapping';
-import * as Externs from './externs';
-import Gatherer_ from './gatherer';
-import * as I18n from './lhr/i18n';
-import {LighthouseError as LighthouseError_} from '../core/lib/lh-error.js';
-import LHResult from './lhr/lhr';
-import FlowResult_ from './lhr/flow-result';
-import Protocol_ from './protocol';
-import * as Settings from './lhr/settings';
-import Treemap_ from './lhr/treemap';
-import UserFlow_ from './user-flow';
-import Puppeteer_ from './puppeteer';
-import Util_ from './utility-types.js';
-
-// Construct hierarchy of global types under the LH namespace.
-declare global {
-  module LH {
-    export type ArbitraryEqualityMap = ArbitraryEqualityMap_;
-    export type NavigationRequestor = string | (() => Promise<void> | void);
-
-    export import Util = Util_;
-
-    export import Puppeteer = Puppeteer_;
-
-    // artifacts.d.ts
-    export import Artifacts = Artifacts_.Artifacts;
-    export import BaseArtifacts = Artifacts_.BaseArtifacts;
-    export import FRArtifacts = Artifacts_.FRArtifacts;
-    export import FRBaseArtifacts = Artifacts_.FRBaseArtifacts;
-    export import GathererArtifacts = Artifacts_.GathererArtifacts;
-    export import DevtoolsLog = Artifacts_.DevtoolsLog;
-    export import Trace = Artifacts_.Trace;
-    export import TraceCpuProfile = Artifacts_.TraceCpuProfile;
-    export import TraceEvent = Artifacts_.TraceEvent;
-
-    export import Audit = Audit_;
-    export import Budget = Budget_;
-    export import Config = Config_;
-    export import Crdp = _Crdp;
-    export import CrdpEvents = _CrdpMappings.Events;
-    export import CrdpCommands = _CrdpMappings.Commands;
-
-    export import UserFlow = UserFlow_;
-
-    // externs.d.ts
-    export import Flags = Externs.Flags;
-    export import CliFlags = Externs.CliFlags;
-    export import RunnerResult = Externs.RunnerResult;
-    export import DevToolsJsonTarget = Externs.DevToolsJsonTarget;
-
-    export import Gatherer = Gatherer_;
-    export import LighthouseError = LighthouseError_;
-    export import Result = LHResult;
-    export import FlowResult = FlowResult_;
-
-    // i18n.d.ts.
-    export import IcuMessage = I18n.IcuMessage;
-    export import RawIcu = I18n.RawIcu;
-    export import FormattedIcu = I18n.FormattedIcu;
-
-    export import Protocol = Protocol_;
-
-    // lhr/settings.d.ts
-    export import Locale = Settings.Locale;
-    export import ThrottlingSettings = Settings.ThrottlingSettings;
-    export import ScreenEmulationSettings = Settings.ScreenEmulationSettings;
-    export import SharedFlagsSettings = Settings.SharedFlagsSettings;
-    export import OutputMode = Settings.OutputMode;
-    export import PrecomputedLanternData = Settings.PrecomputedLanternData;
-
-    export import Treemap = Treemap_;
-  }
-}