#132: Fix incorrectly typed message type arguments.

archfz · Feb 6, 2022 · 59f0ab9 · 59f0ab9
1 parent e9b146e
commit 59f0ab9
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -307,9 +307,10 @@ directory. You should add `it.only` to the test case you are working on to speed
 
 ## Release Notes
 
-- Security update.
+- Fix incorrectly typed message type arguments. [issue](https://github.com/archfz/cypress-terminal-report/issues/132)
+- Security updates.
 - Update cypress to 9.4.1 in tests to confirm support.
-- 
+
 #### 3.4.1
 
 - Add severity typescript types. [merge-request](https://github.com/archfz/cypress-terminal-report/pull/128)  by [tebeco](https://github.com/tebeco)

diff --git a/src/installLogsCollector.d.ts b/src/installLogsCollector.d.ts
@@ -1,4 +1,17 @@
 export type Severity = '' | 'error' | 'warning';
+export type LogType = 'cons:log' |
+  'cons:info' |
+  'cons:warn' |
+  'cons:error' |
+  'cons:debug' |
+  'cy:log' |
+  'cy:xhr' |
+  'cy:fetch' |
+  'cy:request' |
+  'cy:route' |
+  'cy:intercept' |
+  'cy:command' |
+  'ctr:info';
 
 export interface SupportOptions {
   /**
@@ -17,7 +30,7 @@ export interface SupportOptions {
   filterLog?:
     | null
     | NonNullable<SupportOptions['collectTypes']>[number]
-    | ((args: [/* type: */ Severity, /* message: */ string, /* severity: */ Severity]) => boolean);
+    | ((args: [/* type: */ LogType, /* message: */ string, /* severity: */ Severity]) => boolean);
 
   /**
    * Callback to process logs manually. The type is from the same list as for the collectTypes option.
@@ -27,15 +40,15 @@ export interface SupportOptions {
   processLog?:
       | null
       | NonNullable<SupportOptions['collectTypes']>[number]
-      | ((args: [/* type: */ Severity, /* message: */ string, /* severity: */ Severity]) => [Severity, string, Severity]);
+      | ((args: [/* type: */ LogType, /* message: */ string, /* severity: */ Severity]) => [Severity, string, Severity]);
 
   /**
    * Callback to collect each test case's logs after its run.
    * @default undefined
    */
   collectTestLogs?: (
     context: {mochaRunnable: any, testState: string, testTitle: string, testLevel: number},
-    messages: [/* type: */ Severity, /* message: */ string, /* severity: */ Severity][]
+    messages: [/* type: */ LogType, /* message: */ string, /* severity: */ Severity][]
   ) => void;
 
   xhr?: {
@@ -67,4 +80,4 @@ export interface SupportOptions {
 }
 
 declare function installLogsCollector(config?: SupportOptions): void;
-export = installLogsCollector;
+export default installLogsCollector;
diff --git a/src/installLogsPrinter.d.ts b/src/installLogsPrinter.d.ts
@@ -1,6 +1,19 @@
 /// <reference types="cypress" />
 
 export type Severity = '' | 'error' | 'warning';
+export type LogType = 'cons:log' |
+  'cons:info' |
+  'cons:warn' |
+  'cons:error' |
+  'cons:debug' |
+  'cy:log' |
+  'cy:xhr' |
+  'cy:fetch' |
+  'cy:request' |
+  'cy:route' |
+  'cy:intercept' |
+  'cy:command' |
+  'ctr:info';
 
 export interface PluginOptions {
   /**
@@ -41,7 +54,7 @@ export interface PluginOptions {
     string,
     | 'json'
     | 'txt'
-    | ((messages: Record<string, Record<string, [string, string, Severity]>>) => string)
+    | ((messages: Record<string, Record<string, [LogType, string, Severity]>>) => string)
   >;
 
   /**
@@ -80,8 +93,8 @@ export interface PluginOptions {
    * Callback to collect each test case's logs after its run.
    * @default undefined
    */
-  collectTestLogs?: (context: {spec: string, test: string, state: string}, messages: [/* type: */ Severity, /* message: */ string, /* severity: */ Severity][]) => void;
+  collectTestLogs?: (context: {spec: string, test: string, state: string}, messages: [/* type: */ LogType, /* message: */ string, /* severity: */ Severity][]) => void;
 }
 
 declare function installLogsPrinter(on: Cypress.PluginEvents, options?: PluginOptions): void;
-export = installLogsPrinter;
+export default installLogsPrinter;