pa11y-ci-reporter-runner 5.0.5 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +71 -71
  2. package/package.json +12 -11
package/index.d.ts CHANGED
@@ -1,82 +1,82 @@
1
1
  type RunnerStates = 'afterAll' | 'beforeAll' | 'beginUrl' | 'urlResults';
2
2
 
3
3
  export type RunnerState = {
4
- state: RunnerStates;
5
- url: string;
4
+ state: RunnerStates;
5
+ url: string;
6
6
  };
7
7
 
8
8
  export type Runner = {
9
- /**
10
- * Get the current state (state, url).
11
- *
12
- * @instance
13
- * @returns The current runner state.
14
- * @public
15
- */
16
- getCurrentState(): RunnerState;
9
+ /**
10
+ * Get the current state (state, url).
11
+ *
12
+ * @instance
13
+ * @returns The current runner state.
14
+ * @public
15
+ */
16
+ getCurrentState(): RunnerState;
17
17
 
18
- /**
19
- * Get the next state (state, url).
20
- *
21
- * @instance
22
- * @returns The next runner state.
23
- * @public
24
- */
25
- getNextState(): RunnerState;
18
+ /**
19
+ * Get the next state (state, url).
20
+ *
21
+ * @instance
22
+ * @returns The next runner state.
23
+ * @public
24
+ */
25
+ getNextState(): RunnerState;
26
26
 
27
- /**
28
- * Resets the runner and reporter to the initial states.
29
- *
30
- * @instance
31
- * @async
32
- * @public
33
- */
34
- reset(): void;
27
+ /**
28
+ * Resets the runner and reporter to the initial states.
29
+ *
30
+ * @instance
31
+ * @async
32
+ * @public
33
+ */
34
+ reset(): void;
35
35
 
36
- /**
37
- * Executes the entire Pa11y CI sequence, calling all reporter functions.
38
- *
39
- * @instance
40
- * @async
41
- * @public
42
- */
43
- runAll(): void;
36
+ /**
37
+ * Executes the entire Pa11y CI sequence, calling all reporter functions.
38
+ *
39
+ * @instance
40
+ * @async
41
+ * @public
42
+ */
43
+ runAll(): void;
44
44
 
45
- /**
46
- * Executes the next event in the Pa11y CI sequence, calling the
47
- * appropriate reporter function.
48
- *
49
- * @instance
50
- * @async
51
- * @public
52
- */
53
- runNext(): void;
45
+ /**
46
+ * Executes the next event in the Pa11y CI sequence, calling the
47
+ * appropriate reporter function.
48
+ *
49
+ * @instance
50
+ * @async
51
+ * @public
52
+ */
53
+ runNext(): void;
54
54
 
55
- /**
56
- * Executes the entire Pa11y CI sequence, calling all reporter functions,
57
- * until the specified current state and optional URL are reached. If a URL is not
58
- * specified, the run completes on the first occurrence of the target state.
59
- *
60
- * @instance
61
- * @param targetState The target state to run to.
62
- * @param targetUrl The target URL to run to.
63
- * @async
64
- * @public
65
- */
66
- runUntil(state: RunnerStates, url?: string): void;
55
+ /**
56
+ * Executes the entire Pa11y CI sequence, calling all reporter functions,
57
+ * until the specified current state and optional URL are reached. If a URL is not
58
+ * specified, the run completes on the first occurrence of the target state.
59
+ *
60
+ * @instance
61
+ * @param targetState The target state to run to.
62
+ * @param targetUrl The target URL to run to.
63
+ * @async
64
+ * @public
65
+ */
66
+ runUntil(state: RunnerStates, url?: string): void;
67
67
 
68
- /**
69
- * Executes the entire Pa11y CI sequence, calling all reporter functions,
70
- * until the specified next state and optional URL are reached. If a URL is not
71
- * specified, the run completes on the first occurrence of the target state.
72
- *
73
- * @instance
74
- * @param targetState The target state to run to.
75
- * @param targetUrl The target URL to run to.
76
- * @async
77
- * @public
78
- */
79
- runUntilNext(state: RunnerStates, url?: string): void;
68
+ /**
69
+ * Executes the entire Pa11y CI sequence, calling all reporter functions,
70
+ * until the specified next state and optional URL are reached. If a URL is not
71
+ * specified, the run completes on the first occurrence of the target state.
72
+ *
73
+ * @instance
74
+ * @param targetState The target state to run to.
75
+ * @param targetUrl The target URL to run to.
76
+ * @async
77
+ * @public
78
+ */
79
+ runUntilNext(state: RunnerStates, url?: string): void;
80
80
  };
81
81
 
82
82
  /**
@@ -92,8 +92,8 @@ export type Runner = {
92
92
  * @public
93
93
  */
94
94
  export function createRunner(
95
- resultsFileName: string,
96
- reporterName: string,
97
- options?: object,
98
- config?: object
95
+ resultsFileName: string,
96
+ reporterName: string,
97
+ options?: object,
98
+ config?: object
99
99
  ): Runner;
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "pa11y-ci-reporter-runner",
3
- "version": "5.0.5",
3
+ "version": "6.0.0",
4
4
  "description": "Pa11y CI Reporter Runner is designed to facilitate testing of Pa11y CI reporters. Given a Pa11y CI JSON results file and optional configuration it simulates the Pa11y CI calls to the reporter.",
5
5
  "main": "index.js",
6
+ "types": "index.d.ts",
6
7
  "scripts": {
7
8
  "build:types": "tsc index.js --declaration --allowJs --emitDeclarationOnly",
8
9
  "hooks:pre-commit": "npm run lint && npm run prettier:check",
@@ -30,7 +31,7 @@
30
31
  "author": "Aaron Goldenthal <npm@aarongoldenthal.com>",
31
32
  "license": "MIT",
32
33
  "engines": {
33
- "node": "^18.12.0 || ^20.9.0 || >=22.0.0"
34
+ "node": "^20.9.0 || ^22.11.0 || >=24.0.0"
34
35
  },
35
36
  "files": [
36
37
  "index.d.ts",
@@ -42,19 +43,19 @@
42
43
  },
43
44
  "homepage": "https://gitlab.com/gitlab-ci-utils/pa11y-ci-reporter-runner",
44
45
  "devDependencies": {
45
- "@aarongoldenthal/eslint-config-standard": "^33.0.2",
46
- "eslint": "^9.18.0",
47
- "globals": "^15.14.0",
48
- "jest": "^29.7.0",
46
+ "@aarongoldenthal/eslint-config-standard": "^38.0.1",
47
+ "eslint": "^9.31.0",
48
+ "globals": "^16.3.0",
49
+ "jest": "^30.0.5",
49
50
  "jest-junit": "^16.0.0",
50
- "markdownlint-cli2": "^0.17.2",
51
+ "markdownlint-cli2": "^0.18.1",
51
52
  "pa11y-ci-reporter-cli-summary": "^4.0.1",
52
- "prettier": "^3.4.2",
53
- "tsd": "^0.31.2",
54
- "typescript": "^5.7.3"
53
+ "prettier": "^3.6.2",
54
+ "tsd": "^0.32.0",
55
+ "typescript": "^5.8.3"
55
56
  },
56
57
  "dependencies": {
57
58
  "lodash": "^4.17.21",
58
- "xstate": "^5.19.2"
59
+ "xstate": "^5.20.1"
59
60
  }
60
61
  }