bfsg-scanner 0.1.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 (104) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/LICENSE +21 -0
  3. package/README.md +147 -0
  4. package/dist/cli/index.d.ts +2 -0
  5. package/dist/cli/index.js +4 -0
  6. package/dist/cli/index.js.map +1 -0
  7. package/dist/cli/run.d.ts +29 -0
  8. package/dist/cli/run.js +202 -0
  9. package/dist/cli/run.js.map +1 -0
  10. package/dist/config/index.d.ts +2 -0
  11. package/dist/config/index.js +3 -0
  12. package/dist/config/index.js.map +1 -0
  13. package/dist/config/load.d.ts +12 -0
  14. package/dist/config/load.js +47 -0
  15. package/dist/config/load.js.map +1 -0
  16. package/dist/config/schema.d.ts +51 -0
  17. package/dist/config/schema.js +16 -0
  18. package/dist/config/schema.js.map +1 -0
  19. package/dist/discovery/crawl.d.ts +21 -0
  20. package/dist/discovery/crawl.js +79 -0
  21. package/dist/discovery/crawl.js.map +1 -0
  22. package/dist/discovery/discover-site.d.ts +26 -0
  23. package/dist/discovery/discover-site.js +50 -0
  24. package/dist/discovery/discover-site.js.map +1 -0
  25. package/dist/discovery/discover.d.ts +25 -0
  26. package/dist/discovery/discover.js +81 -0
  27. package/dist/discovery/discover.js.map +1 -0
  28. package/dist/discovery/index.d.ts +11 -0
  29. package/dist/discovery/index.js +7 -0
  30. package/dist/discovery/index.js.map +1 -0
  31. package/dist/discovery/links.d.ts +11 -0
  32. package/dist/discovery/links.js +69 -0
  33. package/dist/discovery/links.js.map +1 -0
  34. package/dist/discovery/robots.d.ts +18 -0
  35. package/dist/discovery/robots.js +91 -0
  36. package/dist/discovery/robots.js.map +1 -0
  37. package/dist/discovery/sitemap.d.ts +18 -0
  38. package/dist/discovery/sitemap.js +36 -0
  39. package/dist/discovery/sitemap.js.map +1 -0
  40. package/dist/index.d.ts +1 -0
  41. package/dist/index.js +2 -0
  42. package/dist/index.js.map +1 -0
  43. package/dist/report/build.d.ts +14 -0
  44. package/dist/report/build.js +100 -0
  45. package/dist/report/build.js.map +1 -0
  46. package/dist/report/clauses.d.ts +32 -0
  47. package/dist/report/clauses.js +57 -0
  48. package/dist/report/clauses.js.map +1 -0
  49. package/dist/report/i18n.d.ts +54 -0
  50. package/dist/report/i18n.js +95 -0
  51. package/dist/report/i18n.js.map +1 -0
  52. package/dist/report/index.d.ts +12 -0
  53. package/dist/report/index.js +8 -0
  54. package/dist/report/index.js.map +1 -0
  55. package/dist/report/pdf.d.ts +12 -0
  56. package/dist/report/pdf.js +25 -0
  57. package/dist/report/pdf.js.map +1 -0
  58. package/dist/report/render.d.ts +8 -0
  59. package/dist/report/render.js +204 -0
  60. package/dist/report/render.js.map +1 -0
  61. package/dist/report/types.d.ts +78 -0
  62. package/dist/report/types.js +2 -0
  63. package/dist/report/types.js.map +1 -0
  64. package/dist/report/verdict.d.ts +20 -0
  65. package/dist/report/verdict.js +28 -0
  66. package/dist/report/verdict.js.map +1 -0
  67. package/dist/report/write.d.ts +21 -0
  68. package/dist/report/write.js +35 -0
  69. package/dist/report/write.js.map +1 -0
  70. package/dist/scan/index.d.ts +2 -0
  71. package/dist/scan/index.js +2 -0
  72. package/dist/scan/index.js.map +1 -0
  73. package/dist/scan/scan.d.ts +2 -0
  74. package/dist/scan/scan.js +82 -0
  75. package/dist/scan/scan.js.map +1 -0
  76. package/dist/scan/types.d.ts +56 -0
  77. package/dist/scan/types.js +2 -0
  78. package/dist/scan/types.js.map +1 -0
  79. package/dist/shared/index.d.ts +4 -0
  80. package/dist/shared/index.js +5 -0
  81. package/dist/shared/index.js.map +1 -0
  82. package/dist/shared/package-info.d.ts +10 -0
  83. package/dist/shared/package-info.js +11 -0
  84. package/dist/shared/package-info.js.map +1 -0
  85. package/dist/shared/pool.d.ts +7 -0
  86. package/dist/shared/pool.js +25 -0
  87. package/dist/shared/pool.js.map +1 -0
  88. package/dist/shared/rate-limiter.d.ts +11 -0
  89. package/dist/shared/rate-limiter.js +26 -0
  90. package/dist/shared/rate-limiter.js.map +1 -0
  91. package/dist/shared/user-agent.d.ts +11 -0
  92. package/dist/shared/user-agent.js +12 -0
  93. package/dist/shared/user-agent.js.map +1 -0
  94. package/docs/SCANNING-ETHICS.md +52 -0
  95. package/docs/adr/0001-page-discovery-strategy.md +74 -0
  96. package/docs/adr/0002-json-report-output.md +54 -0
  97. package/docs/adr/0003-failon-threshold-and-exit-codes.md +72 -0
  98. package/docs/adr/0004-clause-mapping-from-axe-tags.md +81 -0
  99. package/docs/adr/0005-html-report-rendering.md +71 -0
  100. package/docs/adr/0006-pdf-report-rendering.md +58 -0
  101. package/docs/adr/0007-cli-argument-surface.md +73 -0
  102. package/docs/adr/0008-report-json-schema.md +59 -0
  103. package/package.json +73 -0
  104. package/schema/report.v1.json +156 -0
package/schema/report.v1.json ADDED
@@ -0,0 +1,156 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://github.com/MihaelaAghirculesei/bfsg-scanner/schema/report.v1.json",
4
+ "title": "bfsg-scanner report",
5
+ "description": "The report.json a scan writes. schemaVersion 1. Any breaking change to this envelope bumps both this file (report.v2.json) and SCHEMA_VERSION.",
6
+ "type": "object",
7
+ "additionalProperties": false,
8
+ "required": ["schemaVersion", "generatedAt", "tool", "target", "summary", "verdict", "pages"],
9
+ "properties": {
10
+ "schemaVersion": { "const": 1 },
11
+ "generatedAt": { "type": "string", "format": "date-time" },
12
+ "tool": {
13
+ "type": "object",
14
+ "additionalProperties": false,
15
+ "required": ["name", "version"],
16
+ "properties": {
17
+ "name": { "type": "string" },
18
+ "version": { "type": "string" }
19
+ }
20
+ },
21
+ "target": {
22
+ "type": "object",
23
+ "additionalProperties": false,
24
+ "required": ["baseUrl", "wcagTags", "failOn"],
25
+ "properties": {
26
+ "baseUrl": { "type": "string" },
27
+ "wcagTags": { "type": "array", "items": { "type": "string" } },
28
+ "failOn": { "enum": ["critical", "serious", "moderate", "minor"] }
29
+ }
30
+ },
31
+ "summary": {
32
+ "type": "object",
33
+ "additionalProperties": false,
34
+ "required": [
35
+ "pagesScanned",
36
+ "pagesFailed",
37
+ "pagesWithViolations",
38
+ "totalViolations",
39
+ "violationsByImpact",
40
+ "breachedSuccessCriteria",
41
+ "breachedEn301549Clauses"
42
+ ],
43
+ "properties": {
44
+ "pagesScanned": { "type": "integer", "minimum": 0 },
45
+ "pagesFailed": { "type": "integer", "minimum": 0 },
46
+ "pagesWithViolations": { "type": "integer", "minimum": 0 },
47
+ "totalViolations": { "type": "integer", "minimum": 0 },
48
+ "violationsByImpact": { "$ref": "#/$defs/impactCounts" },
49
+ "breachedSuccessCriteria": { "type": "array", "items": { "type": "string" } },
50
+ "breachedEn301549Clauses": { "type": "array", "items": { "type": "string" } }
51
+ }
52
+ },
53
+ "verdict": {
54
+ "type": "object",
55
+ "additionalProperties": false,
56
+ "required": ["violationsAtOrAboveThreshold", "unrankedViolations", "passed"],
57
+ "properties": {
58
+ "violationsAtOrAboveThreshold": { "type": "integer", "minimum": 0 },
59
+ "unrankedViolations": { "type": "integer", "minimum": 0 },
60
+ "passed": { "type": "boolean" }
61
+ }
62
+ },
63
+ "pages": {
64
+ "type": "array",
65
+ "items": {
66
+ "oneOf": [{ "$ref": "#/$defs/pageSuccess" }, { "$ref": "#/$defs/pageFailure" }]
67
+ }
68
+ }
69
+ },
70
+ "$defs": {
71
+ "impactCounts": {
72
+ "type": "object",
73
+ "additionalProperties": false,
74
+ "required": ["critical", "serious", "moderate", "minor", "unknown"],
75
+ "properties": {
76
+ "critical": { "type": "integer", "minimum": 0 },
77
+ "serious": { "type": "integer", "minimum": 0 },
78
+ "moderate": { "type": "integer", "minimum": 0 },
79
+ "minor": { "type": "integer", "minimum": 0 },
80
+ "unknown": { "type": "integer", "minimum": 0 }
81
+ }
82
+ },
83
+ "pageSuccess": {
84
+ "type": "object",
85
+ "additionalProperties": false,
86
+ "required": ["status", "url", "violations", "incomplete"],
87
+ "properties": {
88
+ "status": { "const": "ok" },
89
+ "url": { "type": "string" },
90
+ "violations": { "type": "array", "items": { "$ref": "#/$defs/finding" } },
91
+ "incomplete": { "type": "array", "items": { "$ref": "#/$defs/finding" } }
92
+ }
93
+ },
94
+ "pageFailure": {
95
+ "type": "object",
96
+ "additionalProperties": false,
97
+ "required": ["status", "url", "error"],
98
+ "properties": {
99
+ "status": { "const": "error" },
100
+ "url": { "type": "string" },
101
+ "error": { "type": "string" }
102
+ }
103
+ },
104
+ "finding": {
105
+ "type": "object",
106
+ "additionalProperties": false,
107
+ "required": [
108
+ "ruleId",
109
+ "tags",
110
+ "impact",
111
+ "description",
112
+ "help",
113
+ "helpUrl",
114
+ "clauses",
115
+ "nodes"
116
+ ],
117
+ "properties": {
118
+ "ruleId": { "type": "string" },
119
+ "tags": { "type": "array", "items": { "type": "string" } },
120
+ "impact": {
121
+ "type": ["string", "null"],
122
+ "enum": ["critical", "serious", "moderate", "minor", null]
123
+ },
124
+ "description": { "type": "string" },
125
+ "help": { "type": "string" },
126
+ "helpUrl": { "type": "string" },
127
+ "clauses": {
128
+ "type": "object",
129
+ "additionalProperties": false,
130
+ "required": ["wcagSc", "en301549"],
131
+ "properties": {
132
+ "wcagSc": { "type": "array", "items": { "type": "string" } },
133
+ "en301549": { "type": "array", "items": { "type": "string" } }
134
+ }
135
+ },
136
+ "nodes": { "type": "array", "items": { "$ref": "#/$defs/node" } }
137
+ }
138
+ },
139
+ "node": {
140
+ "type": "object",
141
+ "additionalProperties": false,
142
+ "required": ["target", "html", "failureSummary"],
143
+ "properties": {
144
+ "target": {
145
+ "type": "array",
146
+ "items": {
147
+ "type": ["string", "array"],
148
+ "items": { "type": "string" }
149
+ }
150
+ },
151
+ "html": { "type": "string" },
152
+ "failureSummary": { "type": ["string", "null"] }
153
+ }
154
+ }
155
+ }
156
+ }