accessibility-checker 4.0.1 → 4.0.2

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 (209) hide show
  1. package/bin/achecker.js +213 -262
  2. package/bin/achecker.js.map +1 -1
  3. package/cjs/bin/achecker.d.ts +2 -0
  4. package/cjs/bin/achecker.js +306 -0
  5. package/cjs/bin/achecker.js.map +1 -0
  6. package/cjs/index.d.ts +319 -0
  7. package/cjs/index.js +402 -0
  8. package/cjs/index.js.map +1 -0
  9. package/cjs/lib/ACBrowserManager.d.ts +22 -0
  10. package/cjs/lib/ACBrowserManager.js +172 -0
  11. package/cjs/lib/ACBrowserManager.js.map +1 -0
  12. package/cjs/lib/ACEngineManager.d.ts +19 -0
  13. package/cjs/lib/ACEngineManager.js +457 -0
  14. package/cjs/lib/ACEngineManager.js.map +1 -0
  15. package/cjs/lib/ACHelper.d.ts +2 -0
  16. package/cjs/lib/ACHelper.js +678 -0
  17. package/cjs/lib/ACHelper.js.map +1 -0
  18. package/cjs/lib/api/IChecker.d.ts +28 -0
  19. package/cjs/lib/api/IChecker.js +11 -0
  20. package/cjs/lib/api/IChecker.js.map +1 -0
  21. package/cjs/lib/api/IMapper.d.ts +37 -0
  22. package/cjs/lib/api/IMapper.js +18 -0
  23. package/cjs/lib/api/IMapper.js.map +1 -0
  24. package/cjs/lib/common/api-ext/Fetch.d.ts +17 -0
  25. package/cjs/lib/common/api-ext/Fetch.js +95 -0
  26. package/cjs/lib/common/api-ext/Fetch.js.map +1 -0
  27. package/cjs/lib/common/api-ext/IAbstractAPI.d.ts +33 -0
  28. package/cjs/lib/common/api-ext/IAbstractAPI.js +18 -0
  29. package/cjs/lib/common/api-ext/IAbstractAPI.js.map +1 -0
  30. package/cjs/lib/common/config/ACConfigManager.d.ts +13 -0
  31. package/cjs/lib/common/config/ACConfigManager.js +483 -0
  32. package/cjs/lib/common/config/ACConfigManager.js.map +1 -0
  33. package/cjs/lib/common/config/ACConstants.d.ts +17 -0
  34. package/cjs/lib/common/config/ACConstants.js +111 -0
  35. package/cjs/lib/common/config/ACConstants.js.map +1 -0
  36. package/cjs/lib/common/config/IArchive.d.ts +37 -0
  37. package/cjs/lib/common/config/IArchive.js +18 -0
  38. package/cjs/lib/common/config/IArchive.js.map +1 -0
  39. package/cjs/lib/common/config/IConfig.d.ts +152 -0
  40. package/cjs/lib/common/config/IConfig.js +36 -0
  41. package/cjs/lib/common/config/IConfig.js.map +1 -0
  42. package/cjs/lib/common/engine/IBounds.d.ts +21 -0
  43. package/cjs/lib/common/engine/IBounds.js +18 -0
  44. package/cjs/lib/common/engine/IBounds.js.map +1 -0
  45. package/cjs/lib/common/engine/IChecker.d.ts +23 -0
  46. package/cjs/lib/common/engine/IChecker.js +18 -0
  47. package/cjs/lib/common/engine/IChecker.js.map +1 -0
  48. package/cjs/lib/common/engine/IEngine.d.ts +39 -0
  49. package/cjs/lib/common/engine/IEngine.js +18 -0
  50. package/cjs/lib/common/engine/IEngine.js.map +1 -0
  51. package/cjs/lib/common/engine/IGuideline.d.ts +53 -0
  52. package/cjs/lib/common/engine/IGuideline.js +37 -0
  53. package/cjs/lib/common/engine/IGuideline.js.map +1 -0
  54. package/cjs/lib/common/engine/IMapper.d.ts +32 -0
  55. package/cjs/lib/common/engine/IMapper.js +18 -0
  56. package/cjs/lib/common/engine/IMapper.js.map +1 -0
  57. package/cjs/lib/common/engine/IReport.d.ts +143 -0
  58. package/cjs/lib/common/engine/IReport.js +44 -0
  59. package/cjs/lib/common/engine/IReport.js.map +1 -0
  60. package/cjs/lib/common/engine/IRule.d.ts +100 -0
  61. package/cjs/lib/common/engine/IRule.js +87 -0
  62. package/cjs/lib/common/engine/IRule.js.map +1 -0
  63. package/cjs/lib/common/engine/IRuleset.d.ts +20 -0
  64. package/cjs/lib/common/engine/IRuleset.js +18 -0
  65. package/cjs/lib/common/engine/IRuleset.js.map +1 -0
  66. package/cjs/lib/common/report/ACReporterCSV.d.ts +28 -0
  67. package/cjs/lib/common/report/ACReporterCSV.js +75 -0
  68. package/cjs/lib/common/report/ACReporterCSV.js.map +1 -0
  69. package/cjs/lib/common/report/ACReporterHTML.d.ts +27 -0
  70. package/cjs/lib/common/report/ACReporterHTML.js +61 -0
  71. package/cjs/lib/common/report/ACReporterHTML.js.map +1 -0
  72. package/cjs/lib/common/report/ACReporterJSON.d.ts +36 -0
  73. package/cjs/lib/common/report/ACReporterJSON.js +109 -0
  74. package/cjs/lib/common/report/ACReporterJSON.js.map +1 -0
  75. package/cjs/lib/common/report/ACReporterMetrics.d.ts +78 -0
  76. package/cjs/lib/common/report/ACReporterMetrics.js +135 -0
  77. package/cjs/lib/common/report/ACReporterMetrics.js.map +1 -0
  78. package/cjs/lib/common/report/ACReporterXLSX.d.ts +38 -0
  79. package/cjs/lib/common/report/ACReporterXLSX.js +996 -0
  80. package/cjs/lib/common/report/ACReporterXLSX.js.map +1 -0
  81. package/cjs/lib/common/report/BaselineManager.d.ts +169 -0
  82. package/cjs/lib/common/report/BaselineManager.js +382 -0
  83. package/cjs/lib/common/report/BaselineManager.js.map +1 -0
  84. package/cjs/lib/common/report/ReporterManager.d.ts +79 -0
  85. package/cjs/lib/common/report/ReporterManager.js +469 -0
  86. package/cjs/lib/common/report/ReporterManager.js.map +1 -0
  87. package/cjs/lib/common/report/genReport.d.ts +1 -0
  88. package/cjs/lib/common/report/genReport.js +12 -0
  89. package/cjs/lib/common/report/genReport.js.map +1 -0
  90. package/cjs/package.json +3 -0
  91. package/index.js +21 -63
  92. package/index.js.map +1 -1
  93. package/lib/ACBrowserManager.js +138 -203
  94. package/lib/ACBrowserManager.js.map +1 -1
  95. package/lib/ACEngineManager.js +395 -402
  96. package/lib/ACEngineManager.js.map +1 -1
  97. package/lib/ACHelper.js +581 -642
  98. package/lib/ACHelper.js.map +1 -1
  99. package/lib/common/api-ext/Fetch.js +58 -78
  100. package/lib/common/api-ext/Fetch.js.map +1 -1
  101. package/lib/common/config/ACConfigManager.js +271 -281
  102. package/lib/common/config/ACConfigManager.js.map +1 -1
  103. package/lib/common/config/ACConstants.js +38 -4
  104. package/lib/common/config/ACConstants.js.map +1 -1
  105. package/lib/common/config/IConfig.d.ts +1 -1
  106. package/lib/common/report/ACReporterCSV.js +42 -77
  107. package/lib/common/report/ACReporterCSV.js.map +1 -1
  108. package/lib/common/report/ACReporterHTML.js +15 -48
  109. package/lib/common/report/ACReporterHTML.js.map +1 -1
  110. package/lib/common/report/ACReporterJSON.js +59 -94
  111. package/lib/common/report/ACReporterJSON.js.map +1 -1
  112. package/lib/common/report/ACReporterMetrics.js +45 -108
  113. package/lib/common/report/ACReporterMetrics.js.map +1 -1
  114. package/lib/common/report/ACReporterXLSX.js +282 -300
  115. package/lib/common/report/ACReporterXLSX.js.map +1 -1
  116. package/lib/common/report/BaselineManager.js +82 -56
  117. package/lib/common/report/BaselineManager.js.map +1 -1
  118. package/lib/common/report/ReporterManager.js +125 -190
  119. package/lib/common/report/ReporterManager.js.map +1 -1
  120. package/lib/common/report/genReport.js +2 -2
  121. package/mjs/bin/achecker.d.ts +2 -0
  122. package/mjs/bin/achecker.js +236 -0
  123. package/mjs/bin/achecker.js.map +1 -0
  124. package/mjs/index.d.ts +319 -0
  125. package/mjs/index.js +368 -0
  126. package/mjs/index.js.map +1 -0
  127. package/mjs/lib/ACBrowserManager.d.ts +22 -0
  128. package/mjs/lib/ACBrowserManager.js +121 -0
  129. package/mjs/lib/ACBrowserManager.js.map +1 -0
  130. package/mjs/lib/ACEngineManager.d.ts +19 -0
  131. package/mjs/lib/ACEngineManager.js +397 -0
  132. package/mjs/lib/ACEngineManager.js.map +1 -0
  133. package/mjs/lib/ACHelper.d.ts +2 -0
  134. package/mjs/lib/ACHelper.js +614 -0
  135. package/mjs/lib/ACHelper.js.map +1 -0
  136. package/mjs/lib/api/IChecker.d.ts +28 -0
  137. package/mjs/lib/api/IChecker.js +8 -0
  138. package/mjs/lib/api/IChecker.js.map +1 -0
  139. package/mjs/lib/api/IMapper.d.ts +37 -0
  140. package/mjs/lib/api/IMapper.js +17 -0
  141. package/mjs/lib/api/IMapper.js.map +1 -0
  142. package/mjs/lib/common/api-ext/Fetch.d.ts +17 -0
  143. package/mjs/lib/common/api-ext/Fetch.js +45 -0
  144. package/mjs/lib/common/api-ext/Fetch.js.map +1 -0
  145. package/mjs/lib/common/api-ext/IAbstractAPI.d.ts +33 -0
  146. package/mjs/lib/common/api-ext/IAbstractAPI.js +17 -0
  147. package/mjs/lib/common/api-ext/IAbstractAPI.js.map +1 -0
  148. package/mjs/lib/common/config/ACConfigManager.d.ts +13 -0
  149. package/mjs/lib/common/config/ACConfigManager.js +421 -0
  150. package/mjs/lib/common/config/ACConfigManager.js.map +1 -0
  151. package/mjs/lib/common/config/ACConstants.d.ts +17 -0
  152. package/mjs/lib/common/config/ACConstants.js +75 -0
  153. package/mjs/lib/common/config/ACConstants.js.map +1 -0
  154. package/mjs/lib/common/config/IArchive.d.ts +37 -0
  155. package/mjs/lib/common/config/IArchive.js +17 -0
  156. package/mjs/lib/common/config/IArchive.js.map +1 -0
  157. package/mjs/lib/common/config/IConfig.d.ts +152 -0
  158. package/mjs/lib/common/config/IConfig.js +33 -0
  159. package/mjs/lib/common/config/IConfig.js.map +1 -0
  160. package/mjs/lib/common/engine/IBounds.d.ts +21 -0
  161. package/mjs/lib/common/engine/IBounds.js +17 -0
  162. package/mjs/lib/common/engine/IBounds.js.map +1 -0
  163. package/mjs/lib/common/engine/IChecker.d.ts +23 -0
  164. package/mjs/lib/common/engine/IChecker.js +17 -0
  165. package/mjs/lib/common/engine/IChecker.js.map +1 -0
  166. package/mjs/lib/common/engine/IEngine.d.ts +39 -0
  167. package/mjs/lib/common/engine/IEngine.js +17 -0
  168. package/mjs/lib/common/engine/IEngine.js.map +1 -0
  169. package/mjs/lib/common/engine/IGuideline.d.ts +53 -0
  170. package/mjs/lib/common/engine/IGuideline.js +34 -0
  171. package/mjs/lib/common/engine/IGuideline.js.map +1 -0
  172. package/mjs/lib/common/engine/IMapper.d.ts +32 -0
  173. package/mjs/lib/common/engine/IMapper.js +17 -0
  174. package/mjs/lib/common/engine/IMapper.js.map +1 -0
  175. package/mjs/lib/common/engine/IReport.d.ts +143 -0
  176. package/mjs/lib/common/engine/IReport.js +36 -0
  177. package/mjs/lib/common/engine/IReport.js.map +1 -0
  178. package/mjs/lib/common/engine/IRule.d.ts +100 -0
  179. package/mjs/lib/common/engine/IRule.js +79 -0
  180. package/mjs/lib/common/engine/IRule.js.map +1 -0
  181. package/mjs/lib/common/engine/IRuleset.d.ts +20 -0
  182. package/mjs/lib/common/engine/IRuleset.js +17 -0
  183. package/mjs/lib/common/engine/IRuleset.js.map +1 -0
  184. package/mjs/lib/common/report/ACReporterCSV.d.ts +28 -0
  185. package/mjs/lib/common/report/ACReporterCSV.js +60 -0
  186. package/mjs/lib/common/report/ACReporterCSV.js.map +1 -0
  187. package/mjs/lib/common/report/ACReporterHTML.d.ts +27 -0
  188. package/mjs/lib/common/report/ACReporterHTML.js +46 -0
  189. package/mjs/lib/common/report/ACReporterHTML.js.map +1 -0
  190. package/mjs/lib/common/report/ACReporterJSON.d.ts +36 -0
  191. package/mjs/lib/common/report/ACReporterJSON.js +94 -0
  192. package/mjs/lib/common/report/ACReporterJSON.js.map +1 -0
  193. package/mjs/lib/common/report/ACReporterMetrics.d.ts +78 -0
  194. package/mjs/lib/common/report/ACReporterMetrics.js +122 -0
  195. package/mjs/lib/common/report/ACReporterMetrics.js.map +1 -0
  196. package/mjs/lib/common/report/ACReporterXLSX.d.ts +38 -0
  197. package/mjs/lib/common/report/ACReporterXLSX.js +948 -0
  198. package/mjs/lib/common/report/ACReporterXLSX.js.map +1 -0
  199. package/mjs/lib/common/report/BaselineManager.d.ts +169 -0
  200. package/mjs/lib/common/report/BaselineManager.js +348 -0
  201. package/mjs/lib/common/report/BaselineManager.js.map +1 -0
  202. package/mjs/lib/common/report/ReporterManager.d.ts +79 -0
  203. package/mjs/lib/common/report/ReporterManager.js +469 -0
  204. package/mjs/lib/common/report/ReporterManager.js.map +1 -0
  205. package/mjs/lib/common/report/genReport.d.ts +1 -0
  206. package/mjs/lib/common/report/genReport.js +9 -0
  207. package/mjs/lib/common/report/genReport.js.map +1 -0
  208. package/mjs/package.json +3 -0
  209. package/package.json +10 -4
@@ -0,0 +1,94 @@
1
+ /******************************************************************************
2
+ Copyright:: 2020- IBM, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ *****************************************************************************/
16
+ import { ReporterManager } from "./ReporterManager.js";
17
+ export class ACReporterJSON {
18
+ name() {
19
+ return "json";
20
+ }
21
+ generateReport(config, rulesets, storedReport) {
22
+ let outReport = JSON.parse(JSON.stringify(storedReport.engineReport));
23
+ outReport.summary = ACReporterJSON.generateReportSummary(config, rulesets, storedReport);
24
+ delete outReport.totalTime;
25
+ outReport.scanID = config.scanID;
26
+ outReport.toolID = config.toolID;
27
+ outReport.label = storedReport.label;
28
+ return {
29
+ reportPath: `${storedReport.label.replace(/[:?&=]/g, "_")}.json`,
30
+ report: JSON.stringify(outReport, null, 4)
31
+ };
32
+ }
33
+ async generateSummary(config, _rulesets, endReport, compressedReports) {
34
+ if (compressedReports && compressedReports.length > 0) {
35
+ let storedScan = ReporterManager.uncompressReport(compressedReports[0]);
36
+ let retVal = {
37
+ counts: {
38
+ ignored: 0,
39
+ violation: 0,
40
+ recommendation: 0,
41
+ pass: 0,
42
+ potentialviolation: 0,
43
+ potentialrecommendation: 0,
44
+ manual: 0,
45
+ elements: 0,
46
+ elementsViolation: 0,
47
+ elementsViolationReview: 0
48
+ },
49
+ startReport: storedScan.engineReport.summary.startScan,
50
+ endReport: endReport,
51
+ toolID: config.toolID,
52
+ policies: config.policies,
53
+ reportLevels: config.reportLevels,
54
+ labels: config.label,
55
+ failLevels: config.failLevels,
56
+ scanID: config.scanID,
57
+ pageScanSummary: []
58
+ };
59
+ for (const compressedReport of compressedReports) {
60
+ let storedScan = ReporterManager.uncompressReport(compressedReport);
61
+ let counts = storedScan.engineReport.summary.counts;
62
+ retVal.pageScanSummary.push({
63
+ label: storedScan.label,
64
+ counts
65
+ });
66
+ for (const key in counts) {
67
+ retVal.counts[key] += counts[key];
68
+ }
69
+ }
70
+ let startScan = new Date(storedScan.engineReport.summary.startScan);
71
+ let reportFilename = `summary_${startScan.toISOString().replace(/:/g, "-")}.json`;
72
+ if (config.outputFilenameTimestamp === false) {
73
+ reportFilename = `summary.json`;
74
+ }
75
+ return {
76
+ summaryPath: reportFilename,
77
+ summary: JSON.stringify(retVal, null, 4)
78
+ };
79
+ }
80
+ }
81
+ static generateReportSummary(config, rulesets, storedReport) {
82
+ let { engineReport, startScan, url } = storedReport;
83
+ return {
84
+ counts: engineReport.summary.counts,
85
+ scanTime: engineReport.totalTime,
86
+ ruleArchive: config.ruleArchiveLabel,
87
+ policies: config.policies,
88
+ reportLevels: config.reportLevels,
89
+ startScan: startScan,
90
+ URL: url
91
+ };
92
+ }
93
+ }
94
+ //# sourceMappingURL=ACReporterJSON.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ACReporterJSON.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/report/ACReporterJSON.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;gFAcgF;AAKhF,OAAO,EAA6C,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAElG,MAAM,OAAO,cAAc;IAChB,IAAI;QACP,OAAO,MAAM,CAAC;IAClB,CAAC;IACM,cAAc,CAAC,MAAuB,EAAE,QAAqB,EAAE,YAA6B;QAC/F,IAAI,SAAS,GAAoB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;QACvF,SAAS,CAAC,OAAO,GAAG,cAAc,CAAC,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QACzF,OAAQ,SAAiB,CAAC,SAAS,CAAC;QACpC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QACjC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QACjC,SAAS,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC;QAErC,OAAO;YACH,UAAU,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAC,GAAG,CAAC,OAAO;YAC/D,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;SAC7C,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAuB,EAAE,SAAsB,EAAE,SAAiB,EAAE,iBAAqC;QAClI,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,UAAU,GAAG,eAAe,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;YACxE,IAAI,MAAM,GAAG;gBACT,MAAM,EAAE;oBACJ,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,CAAC;oBACZ,cAAc,EAAE,CAAC;oBACjB,IAAI,EAAE,CAAC;oBACP,kBAAkB,EAAE,CAAC;oBACrB,uBAAuB,EAAE,CAAC;oBAC1B,MAAM,EAAE,CAAC;oBACT,QAAQ,EAAE,CAAC;oBACX,iBAAiB,EAAE,CAAC;oBACpB,uBAAuB,EAAE,CAAC;iBAC7B;gBACD,WAAW,EAAE,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS;gBACtD,SAAS,EAAE,SAAS;gBACpB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,MAAM,EAAE,MAAM,CAAC,KAAK;gBACpB,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,eAAe,EAAE,EAAE;aACtB,CAAA;YACD,KAAK,MAAM,gBAAgB,IAAI,iBAAiB,EAAE,CAAC;gBAC/C,IAAI,UAAU,GAAG,eAAe,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;gBACpE,IAAI,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC;gBACpD,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC;oBACxB,KAAK,EAAE,UAAU,CAAC,KAAK;oBACvB,MAAM;iBACT,CAAC,CAAA;gBACF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;oBACvB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;gBACtC,CAAC;YACL,CAAC;YACD,IAAI,SAAS,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACpE,IAAI,cAAc,GAAG,WAAW,SAAS,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,OAAO,CAAC;YACjF,IAAI,MAAM,CAAC,uBAAuB,KAAK,KAAK,EAAE,CAAC;gBAC3C,cAAc,GAAG,cAAc,CAAC;YACpC,CAAC;YACD,OAAO;gBACH,WAAW,EAAE,cAAc;gBAC3B,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;aAC3C,CAAC;QACN,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,MAAuB,EAAE,QAAqB,EAAE,YAA6B;QAC7G,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC;QAEpD,OAAO;YACH,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,MAAM;YACnC,QAAQ,EAAG,YAAoB,CAAC,SAAS;YACzC,WAAW,EAAE,MAAM,CAAC,gBAAgB;YACpC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,SAAS,EAAE,SAAS;YACpB,GAAG,EAAE,GAAG;SACX,CAAA;IACL,CAAC;CACJ"}
@@ -0,0 +1,78 @@
1
+ /******************************************************************************
2
+ Copyright:: 2020- IBM, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ *****************************************************************************/
16
+ import { IConfigInternal } from "../config/IConfig.js";
17
+ import { Guideline } from "../engine/IGuideline.js";
18
+ import { CompressedReport } from "../engine/IReport.js";
19
+ import { GenSummReturn, IReporter, IReporterStored } from "./ReporterManager.js";
20
+ /*******************************************************************************
21
+ * NAME: ACMetricsLogger.js
22
+ * DESCRIPTION: Common Metrics logger object which can be shared between tools
23
+ * to upload metrics of the tool to the metrics server.
24
+ *******************************************************************************/
25
+ /**
26
+ * This function is responsible for constructing the accessibility-checker Metrics object which contains all the function
27
+ * that are needed to upload scan metrics to the metric server.
28
+ *
29
+ * @param {String} toolName - The name of the tool sending the metrics.
30
+ * @param {String} logger - Logger object which can be used to log debug information.
31
+ * @param {String} policies - Array of policies which will be sent to the metrics server.
32
+ *
33
+ * @return - N/A
34
+ *
35
+ * @memberOf this
36
+ */
37
+ export declare class ACReporterMetrics implements IReporter {
38
+ name(): string;
39
+ policies: string;
40
+ metricsURLV2: string;
41
+ toolName: string;
42
+ scanTimesV1: any[];
43
+ scanTimesV2: {
44
+ [profile: string]: number[];
45
+ };
46
+ constructor(toolName: string, policies: string[]);
47
+ /**
48
+ * This function is responsible for profiling the testcases and adding the scan time to the global
49
+ * array which will be sent to the metrics server to log the number of scans that were performed.
50
+ * This function profiles scanTimes for the V2 metric server:
51
+ * https://aat.w3ibm.mybluemix.net
52
+ *
53
+ * In the case that user provides any url that is https://aat* it will upload based on accountId
54
+ *
55
+ * @param {String} scanTime - Provide the time it took for the testcase to run
56
+ * @param {String} profile - The type of profile the scan time is for:
57
+ * i.e. browser information, features, etc...
58
+ *
59
+ * @return N/A - Global scanTimesV2 object is updated with the time
60
+ *
61
+ * @memberOf this
62
+ */
63
+ generateReport(config: IConfigInternal, rulesets: Guideline[], storedReport: IReporterStored): {
64
+ reportPath: string;
65
+ report: string;
66
+ } | void;
67
+ /**
68
+ * This function is responsible for uploading scan results to the metrics server:
69
+ * https://aat.w3ibm.mybluemix.net
70
+ *
71
+ * @param {Function} done - The browser on which the testcases were run on
72
+ *
73
+ * @return N/A - performs the upload of the metrics to the server
74
+ *
75
+ * @memberOf this
76
+ */
77
+ generateSummary(config: IConfigInternal, rulesets: Guideline[], endReport: number, summaryData: CompressedReport[]): Promise<GenSummReturn>;
78
+ }
@@ -0,0 +1,122 @@
1
+ /******************************************************************************
2
+ Copyright:: 2020- IBM, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ *****************************************************************************/
16
+ import { fetch_get } from "../api-ext/Fetch.js";
17
+ /*******************************************************************************
18
+ * NAME: ACMetricsLogger.js
19
+ * DESCRIPTION: Common Metrics logger object which can be shared between tools
20
+ * to upload metrics of the tool to the metrics server.
21
+ *******************************************************************************/
22
+ /**
23
+ * This function is responsible for constructing the accessibility-checker Metrics object which contains all the function
24
+ * that are needed to upload scan metrics to the metric server.
25
+ *
26
+ * @param {String} toolName - The name of the tool sending the metrics.
27
+ * @param {String} logger - Logger object which can be used to log debug information.
28
+ * @param {String} policies - Array of policies which will be sent to the metrics server.
29
+ *
30
+ * @return - N/A
31
+ *
32
+ * @memberOf this
33
+ */
34
+ export class ACReporterMetrics {
35
+ name() {
36
+ return "metrics";
37
+ }
38
+ policies;
39
+ metricsURLV2 = "https://able.ibm.com/tools";
40
+ toolName;
41
+ scanTimesV1 = [];
42
+ scanTimesV2 = {};
43
+ constructor(toolName, policies) {
44
+ this.policies = policies.join(",");
45
+ // Init all the local object variables
46
+ this.toolName = toolName;
47
+ }
48
+ /**
49
+ * This function is responsible for profiling the testcases and adding the scan time to the global
50
+ * array which will be sent to the metrics server to log the number of scans that were performed.
51
+ * This function profiles scanTimes for the V2 metric server:
52
+ * https://aat.w3ibm.mybluemix.net
53
+ *
54
+ * In the case that user provides any url that is https://aat* it will upload based on accountId
55
+ *
56
+ * @param {String} scanTime - Provide the time it took for the testcase to run
57
+ * @param {String} profile - The type of profile the scan time is for:
58
+ * i.e. browser information, features, etc...
59
+ *
60
+ * @return N/A - Global scanTimesV2 object is updated with the time
61
+ *
62
+ * @memberOf this
63
+ */
64
+ generateReport(config, rulesets, storedReport) {
65
+ if (!config.label || !config.label.includes("IBMa-Node-TeSt")) {
66
+ // URI encode the profile text provided
67
+ let profile = encodeURIComponent(storedReport.scanProfile);
68
+ // Add the time it took for the testcase to run to the global array, indexed by the profile
69
+ this.scanTimesV2[profile] = this.scanTimesV2[profile] || [];
70
+ this.scanTimesV2[profile].push(storedReport.engineReport.summary.scanTime);
71
+ }
72
+ }
73
+ ;
74
+ /**
75
+ * This function is responsible for uploading scan results to the metrics server:
76
+ * https://aat.w3ibm.mybluemix.net
77
+ *
78
+ * @param {Function} done - The browser on which the testcases were run on
79
+ *
80
+ * @return N/A - performs the upload of the metrics to the server
81
+ *
82
+ * @memberOf this
83
+ */
84
+ async generateSummary(config, rulesets, endReport, summaryData) {
85
+ try {
86
+ // Variable Decleration
87
+ let numProfiles = 0;
88
+ let accountId = "";
89
+ // Loop over all the profiles with in the scanTime Object
90
+ for (let profile in this.scanTimesV2) {
91
+ // Loop over all the V2 Scan Times until it reaches 0
92
+ while (this.scanTimesV2[profile].length > 0) {
93
+ // Build a truncatedScanTime Array to upload to the metrics server chunck by chunck
94
+ let subScanTimes = this.scanTimesV2[profile].splice(0, 150);
95
+ // Increment the num Profile
96
+ ++numProfiles;
97
+ // Start building the Query string to be sent to the metrics server
98
+ let qs = "?t=" + this.toolName + "&tag=" + profile + "&a=" + accountId + "&pol=" + this.policies + "&st=";
99
+ subScanTimes.forEach(function (t) {
100
+ qs += t;
101
+ qs += ",";
102
+ });
103
+ qs = qs.substr(0, qs.length - 1);
104
+ // Dispatch the call to the metrics server
105
+ // Istanbul is not able to capture the coverate of functions call in a callback therefore we need to skip
106
+ /* istanbul ignore next */
107
+ await fetch_get(this.metricsURLV2 + "/api/pub/meter/v2" + qs).then(() => {
108
+ }).catch((_err) => {
109
+ }).finally(() => {
110
+ // Decrement the numProfiles to identify that scan has finished
111
+ --numProfiles;
112
+ });
113
+ }
114
+ }
115
+ }
116
+ catch (e) {
117
+ }
118
+ }
119
+ ;
120
+ }
121
+ ;
122
+ //# sourceMappingURL=ACReporterMetrics.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ACReporterMetrics.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/report/ACReporterMetrics.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;+EAc+E;AAE/E,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAMhD;;;;iFAIiF;AAEjF;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,iBAAiB;IACnB,IAAI;QACP,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,QAAQ,CAAS;IACjB,YAAY,GAAW,4BAA4B,CAAC;IACpD,QAAQ,CAAS;IACjB,WAAW,GAAG,EAAE,CAAC;IACjB,WAAW,GAEP,EAAE,CAAC;IAEP,YAAY,QAAgB,EAAE,QAAkB;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEnC,sCAAsC;QACtC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,cAAc,CAAC,MAAuB,EAAE,QAAqB,EAAE,YAA6B;QAC/F,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC5D,uCAAuC;YACvC,IAAI,OAAO,GAAG,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAE3D,2FAA2F;YAC3F,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC5D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/E,CAAC;IACL,CAAC;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACI,KAAK,CAAC,eAAe,CAAC,MAAuB,EAAE,QAAqB,EAAE,SAAiB,EAAE,WAA+B;QAC3H,IAAI,CAAC;YACD,uBAAuB;YACvB,IAAI,WAAW,GAAG,CAAC,CAAC;YACpB,IAAI,SAAS,GAAG,EAAE,CAAC;YAEnB,yDAAyD;YACzD,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBAEnC,qDAAqD;gBACrD,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1C,mFAAmF;oBACnF,IAAI,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;oBAE5D,4BAA4B;oBAC5B,EAAE,WAAW,CAAC;oBAEd,mEAAmE;oBACnE,IAAI,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;oBAE1G,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;wBAC5B,EAAE,IAAI,CAAC,CAAC;wBACR,EAAE,IAAI,GAAG,CAAC;oBACd,CAAC,CAAC,CAAC;oBACH,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAEjC,0CAA0C;oBAC1C,yGAAyG;oBACzG,0BAA0B;oBAC1B,MAAM,SAAS,CAAC,IAAI,CAAC,YAAY,GAAG,mBAAmB,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;oBACxE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;oBAClB,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;wBACZ,+DAA+D;wBAC/D,EAAE,WAAW,CAAC;oBAClB,CAAC,CAAC,CAAA;gBACN,CAAC;YACL,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;QACb,CAAC;IACL,CAAC;IAAA,CAAC;CACL;AAAA,CAAC"}
@@ -0,0 +1,38 @@
1
+ /******************************************************************************
2
+ Copyright:: 2020- IBM, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ *****************************************************************************/
16
+ import { IConfigInternal } from "../config/IConfig.js";
17
+ import { Guideline } from "../engine/IGuideline.js";
18
+ import { CompressedReport } from "../engine/IReport.js";
19
+ import { GenSummReturn, IReporter } from "./ReporterManager.js";
20
+ export declare class ACReporterXLSX implements IReporter {
21
+ name(): string;
22
+ generateReport(_reportData: any): {
23
+ reportPath: string;
24
+ report: string;
25
+ } | void;
26
+ generateSummary(config: IConfigInternal, rulesets: Guideline[], endReport: number, summaryData: CompressedReport[]): Promise<GenSummReturn>;
27
+ private static createOverviewSheet;
28
+ private static createScanSummarySheet;
29
+ private static buildIssueSummaryLevel;
30
+ private static buildIssueSummaryTKLevel;
31
+ private static createIssueSummarySheet;
32
+ private static createIssuesSheet;
33
+ private static createDefinitionsSheet;
34
+ private static countDuplicatesInArray;
35
+ private static get_element;
36
+ private static format_date;
37
+ private static stringHash;
38
+ }