lighthouse 10.4.0-dev.20230713 → 10.4.0-dev.20230714

package/core/gather/gatherers/gatherer.d.ts

@@ -1,46 +0,0 @@
-/**
- * @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.
- */
-/**
- * Base class for all gatherers; defines pass lifecycle methods. The artifact
- * from the gatherer is the last not-undefined value returned by a lifecycle
- * method. All methods can return the artifact value directly or return a
- * Promise that resolves to that value.
- *
- * If an Error is thrown (or a Promise that rejects on an Error),
- * the runner will treat it as an error internal to the gatherer and
- * continue execution of any remaining gatherers.
- *
- * @implements {LH.Gatherer.GathererInstance}
- */
-export class Gatherer implements LH.Gatherer.GathererInstance {
-    /**
-     * @return {keyof LH.GathererArtifacts}
-     */
-    get name(): keyof import("../..").GathererArtifacts;
-    /**
-     * Called before navigation to target url.
-     * @param {LH.Gatherer.PassContext} passContext
-     * @return {LH.Gatherer.PhaseResult}
-     */
-    beforePass(passContext: LH.Gatherer.PassContext): LH.Gatherer.PhaseResult;
-    /**
-     * Called after target page is loaded. If a trace is enabled for this pass,
-     * the trace is still being recorded.
-     * @param {LH.Gatherer.PassContext} passContext
-     * @return {LH.Gatherer.PhaseResult}
-     */
-    pass(passContext: LH.Gatherer.PassContext): LH.Gatherer.PhaseResult;
-    /**
-     * Called after target page is loaded, all gatherer `pass` methods have been
-     * executed, and — if generated in this pass — the trace is ended. The trace
-     * and record of network activity are provided in `loadData`.
-     * @param {LH.Gatherer.PassContext} passContext
-     * @param {LH.Gatherer.LoadData} loadData
-     * @return {LH.Gatherer.PhaseResult}
-     */
-    afterPass(passContext: LH.Gatherer.PassContext, loadData: LH.Gatherer.LoadData): LH.Gatherer.PhaseResult;
-}
-//# sourceMappingURL=gatherer.d.ts.map

package/core/gather/gatherers/gatherer.js

@@ -1,58 +0,0 @@
-/**
- * @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.
- */
-
-/**
- * Base class for all gatherers; defines pass lifecycle methods. The artifact
- * from the gatherer is the last not-undefined value returned by a lifecycle
- * method. All methods can return the artifact value directly or return a
- * Promise that resolves to that value.
- *
- * If an Error is thrown (or a Promise that rejects on an Error),
- * the runner will treat it as an error internal to the gatherer and
- * continue execution of any remaining gatherers.
- *
- * @implements {LH.Gatherer.GathererInstance}
- */
-class Gatherer {
-  /**
-   * @return {keyof LH.GathererArtifacts}
-   */
-  get name() {
-    // @ts-expect-error - assume that class name has been added to LH.GathererArtifacts.
-    return this.constructor.name;
-  }
-
-  /* eslint-disable no-unused-vars */
-
-  /**
-   * Called before navigation to target url.
-   * @param {LH.Gatherer.PassContext} passContext
-   * @return {LH.Gatherer.PhaseResult}
-   */
-  beforePass(passContext) { }
-
-  /**
-   * Called after target page is loaded. If a trace is enabled for this pass,
-   * the trace is still being recorded.
-   * @param {LH.Gatherer.PassContext} passContext
-   * @return {LH.Gatherer.PhaseResult}
-   */
-  pass(passContext) { }
-
-  /**
-   * Called after target page is loaded, all gatherer `pass` methods have been
-   * executed, and — if generated in this pass — the trace is ended. The trace
-   * and record of network activity are provided in `loadData`.
-   * @param {LH.Gatherer.PassContext} passContext
-   * @param {LH.Gatherer.LoadData} loadData
-   * @return {LH.Gatherer.PhaseResult}
-   */
-  afterPass(passContext, loadData) { }
-
-  /* eslint-enable no-unused-vars */
-}
-
-export {Gatherer};

package/core/legacy/config/config.d.ts

@@ -1,107 +0,0 @@
-export type GathererConstructor = typeof import('../../gather/gatherers/gatherer.js').Gatherer;
-export type Gatherer = InstanceType<GathererConstructor>;
-/**
- * @implements {LH.Config.LegacyResolvedConfig}
- */
-export class LegacyResolvedConfig implements LH.Config.LegacyResolvedConfig {
-    /**
-     * Resolves the provided config (inherits from extended config, if set), resolves
-     * all referenced modules, and validates.
-     * @param {LH.Config=} config If not provided, uses the default config.
-     * @param {LH.Flags=} flags
-     * @return {Promise<LegacyResolvedConfig>}
-     */
-    static fromJson(config?: LH.Config | undefined, flags?: LH.Flags | undefined): Promise<LegacyResolvedConfig>;
-    /**
-     * @param {LH.Config} baseJSON The JSON of the configuration to extend
-     * @param {LH.Config} extendJSON The JSON of the extensions
-     * @return {LH.Config}
-     */
-    static extendConfigJSON(baseJSON: LH.Config, extendJSON: LH.Config): LH.Config;
-    /**
-     * @param {LH.Config['passes']} passes
-     * @return {?Array<Required<LH.Config.PassJson>>}
-     */
-    static augmentPassesWithDefaults(passes: LH.Config['passes']): Array<Required<LH.Config.PassJson>> | null;
-    /**
-     * Observed throttling methods (devtools/provided) require at least 5s of quiet for the metrics to
-     * be computed. This method adjusts the quiet thresholds to the required minimums if necessary.
-     * @param {LH.Config.Settings} settings
-     * @param {?Array<Required<LH.Config.PassJson>>} passes
-     */
-    static adjustDefaultPassForThrottling(settings: LH.Config.Settings, passes: Array<Required<LH.Config.PassJson>> | null): void;
-    /**
-     * Filter out any unrequested items from the config, based on requested categories or audits.
-     * @param {LegacyResolvedConfig} config
-     */
-    static filterConfigIfNeeded(config: LegacyResolvedConfig): void;
-    /**
-     * Filter out any unrequested categories or audits from the categories object.
-     * @param {LegacyResolvedConfig['categories']} oldCategories
-     * @param {LH.Config.Settings} settings
-     * @return {{categories: LegacyResolvedConfig['categories'], requestedAuditNames: Set<string>}}
-     */
-    static filterCategoriesAndAudits(oldCategories: LegacyResolvedConfig['categories'], settings: LH.Config.Settings): {
-        categories: LegacyResolvedConfig['categories'];
-        requestedAuditNames: Set<string>;
-    };
-    /**
-     * From some requested audits, return names of all required and optional artifacts
-     * @param {LegacyResolvedConfig['audits']} audits
-     * @return {Set<string>}
-     */
-    static getGatherersRequestedByAudits(audits: LegacyResolvedConfig['audits']): Set<string>;
-    /**
-     * Filters to only requested passes and gatherers, returning a new passes array.
-     * @param {LegacyResolvedConfig['passes']} passes
-     * @param {Set<string>} requestedGatherers
-     * @return {LegacyResolvedConfig['passes']}
-     */
-    static generatePassesNeededByGatherers(passes: LegacyResolvedConfig['passes'], requestedGatherers: Set<string>): LegacyResolvedConfig['passes'];
-    /**
-     * Take an array of audits and audit paths and require any paths (possibly
-     * relative to the optional `configDir`) using `resolveModulePath`,
-     * leaving only an array of AuditDefns.
-     * @param {LH.Config['audits']} audits
-     * @param {string=} configDir
-     * @return {Promise<LegacyResolvedConfig['audits']>}
-     */
-    static requireAudits(audits: LH.Config['audits'], configDir?: string | undefined): Promise<LegacyResolvedConfig['audits']>;
-    /**
-     * Takes an array of passes with every property now initialized except the
-     * gatherers and requires them, (relative to the optional `configDir` if
-     * provided) using `resolveModulePath`, returning an array of full Passes.
-     * @param {?Array<Required<LH.Config.PassJson>>} passes
-     * @param {string=} configDir
-     * @return {Promise<LegacyResolvedConfig['passes']>}
-     */
-    static requireGatherers(passes: Array<Required<LH.Config.PassJson>> | null, configDir?: string | undefined): Promise<LegacyResolvedConfig['passes']>;
-    /**
-     * @deprecated `LegacyResolvedConfig.fromJson` should be used instead.
-     * @constructor
-     * @param {LH.Config} config
-     * @param {{settings: LH.Config.Settings, passes: ?LH.Config.Pass[], audits: ?LH.Config.AuditDefn[]}} opts
-     */
-    constructor(config: LH.Config, opts: {
-        settings: LH.Config.Settings;
-        passes: LH.Config.Pass[] | null;
-        audits: LH.Config.AuditDefn[] | null;
-    });
-    /** @type {LH.Config.Settings} */
-    settings: LH.Config.Settings;
-    /** @type {?Array<LH.Config.Pass>} */
-    passes: Array<LH.Config.Pass> | null;
-    /** @type {?Array<LH.Config.AuditDefn>} */
-    audits: Array<LH.Config.AuditDefn> | null;
-    /** @type {?Record<string, LH.Config.Category>} */
-    categories: Record<string, LH.Config.Category> | null;
-    /** @type {?Record<string, LH.Config.Group>} */
-    groups: Record<string, LH.Config.Group> | null;
-    /**
-     * Provides a cleaned-up, stringified version of this config. Gatherer and
-     * Audit `implementation` and `instance` do not survive this process.
-     * @return {string}
-     */
-    getPrintString(): string;
-}
-//# sourceMappingURL=config.d.ts.map