anta/typings/types.ts

CLI tool and lib to gather app audits via [Lighthouse](https://github.com/GoogleChrome/lighthouse/).

// Copyright 2016 Google Inc. All Rights Reserved.
// Licensed under the Apache License, Version 2.0. See LICENSE

interface LighthouseAudits {
  [key: string]: {
    rawValue: boolean | number;
    displayValue: string;
    debugString?: string;
    score: boolean | number;
    scoringMode: string;
    error?: boolean;
    description: string;
    name: string;
    helpText?: string;
    extendedInfo?: { value: string };
  }
}

interface LighthouseResults {
  reportCategories: any;
  reportGroups: any;
  runtimeConfig: any;
  runWarnings: any;
  userAgent: any;
  url: string;
  audits: LighthouseAudits;
  lighthouseVersion: string;
  artifacts?: Object;
  initialUrl: string;
  generatedTime: string;
}

// interface SheetsConfig {
//   type: string;
//   options: {
//     spreadsheetId: string;
//     tableName: string;
//     clientSecret: AuthorizeCredentials;
//   };
// }

interface MainOptions {
  flags?: FeatureFlags;
  // sheets?: SheetsConfig;
  expectations?: ExpectationMetrics;
  // clientSecret?: AuthorizeCredentials;
}

interface FeatureFlags {
  runs: number;
  // submit: Boolean;
  // upload: Boolean;
  view: Boolean;
  expectations: Boolean;
  json: Boolean;
  chromeFlags: Array<string>;
  chromePath?: string
  port?: number;
}

interface MetricsResults {
  audits: LighthouseAudits;
  reportCategories: any;
  reportGroups: any;
  runtimeConfig: any;
  runWarnings: any;
  userAgent: any;
  timings: Timing[];
  timestamps: Timestamp[];
  generatedTime: string;
  lighthouseVersion: string;
  url: string;
  initialUrl: string;
}

interface PWMetricsResults {
  runs: MetricsResults[];
  median?: MetricsResults;
}

interface MetricsDefinition {
  name: string;
  id: string;
  getTs(audits: LighthouseAudits): number;
}

interface Timestamp {
  title: string;
  id: string;
  timestamp: number;
}

interface Timing {
  title: string,
  id: string;
  timestamp: number;
  timing: number;
  color: string;
}

// interface AuthorizeCredentials {
//   installed: {
//     client_secret: number;
//     client_id: number;
//     redirect_uris: Array<any>;
//   }
// }

// interface Oauth2Client {
//   generateAuthUrl: Function;
//   getToken: Function;
//   credentials: any;
// }

interface GSheetsValuesToAppend {
  0: string; // lighthouseVersion
  1: string; // url
  2: string; // time
  3: number; // TTFCP timing
  4: number; // TTFMP timing
  5: number; // PSI timing
  6: number; // FV timing
  7: number; // VC100 timing
  8: number; // TTI timing
  9: number; // VC85 timing
}

interface GSheetsAppendResultsOptions {
  spreadsheetId: string;
  tableName: string;
}

interface ExpectationMetrics {
  [key: string]: {
    warn: string;
    error: string;
  }
}

interface NormalizedExpectationMetrics {
  [key: string]: {
    warn: number;
    error: number;
  }
}

interface DriveResponse {
  id: string
}

interface PreparedAssets {
  traceData: Array<any>
}

//@todo after closing https://github.com/DefinitelyTyped/DefinitelyTyped/issues/13508
interface TermWritableStream extends NodeJS.WritableStream  {
  columns: number;
  rows: number;
}

export {
  Timing,
  Timestamp,
  // SheetsConfig,
  // AuthorizeCredentials,
  // Oauth2Client,
  MetricsDefinition,
  MetricsResults,
  LighthouseResults,
  LighthouseAudits,
  GSheetsValuesToAppend,
  GSheetsAppendResultsOptions,
  DriveResponse,
  ExpectationMetrics,
  NormalizedExpectationMetrics,
  PreparedAssets,
  MainOptions,
  FeatureFlags,
  TermWritableStream,
  PWMetricsResults
};