core(user-flow): cleanup types

flow-report/src/app.tsx

@@ -16,7 +16,7 @@ import {Header} from './header';
 import {I18nProvider} from './i18n/i18n';
 import {Styles} from './wrappers/styles';
 
-function getAnchorElement(hashState: LH.FlowResult.HashState|null) {
+function getAnchorElement(hashState: LH.HashState|null) {
   if (!hashState || !hashState.anchor) return null;
   return document.getElementById(hashState.anchor);
 }

flow-report/src/header.tsx

@@ -29,7 +29,7 @@ const HeaderThumbnail: FunctionComponent<{
   );
 };
 
-export const Header: FunctionComponent<{hashState: LH.FlowResult.HashState}> =
+export const Header: FunctionComponent<{hashState: LH.HashState}> =
 ({hashState}) => {
   const flowResult = useFlowResult();
   const {index} = hashState;

flow-report/src/util.ts

@@ -97,7 +97,7 @@ function useHashParams(...params: string[]) {
   return paramValues;
 }
 
-function useHashState(): LH.FlowResult.HashState|null {
+function useHashState(): LH.HashState|null {
   const flowResult = useFlowResult();
   const [indexString, anchor] = useHashParams('index', 'anchor');
 

flow-report/src/wrappers/report.tsx

@@ -29,7 +29,7 @@ function convertAnchor(link: HTMLAnchorElement, index: number) {
   link.replaceWith(newLink);
 }
 
-export const Report: FunctionComponent<{hashState: LH.FlowResult.HashState}> =
+export const Report: FunctionComponent<{hashState: LH.HashState}> =
 ({hashState}) => {
   const ref = useExternalRenderer<HTMLDivElement>(() => {
     return renderReport(hashState.currentLhr, {

flow-report/types/flow-report.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 FlowResult_ from '../../types/lhr/flow';
+import FlowResult_ from '../../types/lhr/flow-result';
 import * as Settings from '../../types/lhr/settings';
 
 // Import to augment querySelector/querySelectorAll with stricter type checking.
@@ -20,11 +20,18 @@ declare global {
   // Expose global types in LH namespace.
   module LH {
     export type ConfigSettings = Settings.ConfigSettings;
+
     export interface FlowReportOptions {
       getReportHtml?: (flowResult: FlowResult_) => string;
       saveAsGist?: (flowResult: FlowResult_) => void;
     }
 
+    export interface HashState {
+      currentLhr: Result;
+      index: number;
+      anchor: string|null;
+    }
+
     export import FlowResult = FlowResult_;
   }
 }

report/generator/report-generator.js

@@ -8,7 +8,7 @@
 import {reportAssets} from './report-assets.js';
 
 /** @typedef {import('../../types/lhr/lhr').default} LHResult */
-/** @typedef {import('../../types/lhr/flow').default} FlowResult */
+/** @typedef {import('../../types/lhr/flow-result').default} FlowResult */
 
 class ReportGenerator {
   /**

shared/types/shared.d.ts

@@ -6,10 +6,10 @@
 
 import {IcuMessage as IcuMessage_} from '../../types/lhr/i18n';
 import LHResult from '../../types/lhr/lhr';
-import FlowResult_ from '../../types/lhr/flow';
+import FlowResult_ from '../../types/lhr/flow-result';
 
 import {Locale as Locale_} from '../../types/lhr/settings';
- 
+
 declare global {
   // Expose global types in LH namespace.
   module LH {

treemap/types/treemap.d.ts

@@ -5,7 +5,7 @@ import * as Settings from '../../types/lhr/settings';
 import 'google.analytics';
 import LHResult from '../../types/lhr/lhr';
 import {TreemapUtil} from '../app/src/util';
-import FlowResult_ from '../../types/lhr/flow';
+import FlowResult_ from '../../types/lhr/flow-result';
 
 // Import for needed DOM type augmentation.
 import '../../report/types/augment-dom';

types/global-lh.d.ts

@@ -16,7 +16,7 @@ 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';
+import FlowResult_ from './lhr/flow-result';
 import Protocol_ from './protocol';
 import * as Settings from './lhr/settings';
 import Treemap_ from './lhr/treemap';

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

@@ -8,15 +8,11 @@ import Result from './lhr';
 
 declare module FlowResult {
   interface Step {
+    /** Lighthouse report for this flow step. */
     lhr: Result;
+    /** Display name of this flow step. */
     name: string;
   }
-
-  interface HashState {
-    currentLhr: Result;
-    index: number;
-    anchor: string|null;
-  }
 }
 
 /**
@@ -25,7 +21,7 @@ declare module FlowResult {
 interface FlowResult {
   /** Ordered list of flow steps, each corresponding to a navigation, timespan, or snapshot. */
   steps: FlowResult.Step[];
-  /** Name given to this user flow. */
+  /** Display name of this user flow. */
   name: string;
 }
 

types/user-flow.d.ts

@@ -7,11 +7,14 @@ declare module UserFlow {
   }
 
   export interface Options {
-    config: LH.Config.Json;
+    /** Config to use for each flow step. */
+    config?: LH.Config.Json;
+    /** Display name for this user flow. */
     name?: string;
   }
 
   export interface StepFlags extends LH.Flags {
+    /** Display name for this flow step. */
     name?: string;
   }
 
@@ -21,6 +24,6 @@ declare module UserFlow {
   }
 }
 
-type UserFlow = typeof UserFlow_;
+type UserFlow = InstanceType<typeof UserFlow_>;
 
 export default UserFlow;