lighthouse/report/types/report-result.d.ts

Automated auditing, performance metrics, and best practices for the web.

/**
 * @license
 * Copyright 2018 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

import {Result as AuditResult}  from '../../types/lhr/audit-result';
import LHResult from '../../types/lhr/lhr';

/**
 * During report generation, the LHR object is transformed a bit for convenience
 * Primarily, the auditResult is added as .result onto the auditRef. We're lazy sometimes. It'll be removed in due time.
 */
interface ReportResult extends LHResult {
  categories: Record<string, ReportResult.Category>;
}

declare module ReportResult {
  interface Category extends LHResult.Category {
    auditRefs: Array<AuditRef>;
  }

  interface AuditRef extends LHResult.AuditRef {
    result: AuditResult;
    stackPacks?: StackPackDescription[];
    relevantMetrics?: ReportResult.AuditRef[];
  }

  interface StackPackDescription {
      /** The title of the stack pack. */
    title: string;
    /** A base64 data url to be used as the stack pack's icon. */
    iconDataURL: string;
    /** The stack-specific description for this audit. */
    description: string;
  }
}

export default ReportResult;