accessibility-checker 4.0.1 → 4.0.2

package/mjs/index.js

@@ -0,0 +1,368 @@
+/******************************************************************************
+    Copyright:: 2020- IBM, Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+ *****************************************************************************/
+import { ACBrowserManager } from "./lib/ACBrowserManager.js";
+import { ACEngineManager } from "./lib/ACEngineManager.js";
+import { getComplianceHelper } from "./lib/ACHelper.js";
+import { ACConfigManager } from "./lib/common/config/ACConfigManager.js";
+import { BaselineManager } from "./lib/common/report/BaselineManager.js";
+import { ReporterManager } from "./lib/common/report/ReporterManager.js";
+/**
+ * This function is responsible performing a scan based on the context that is provided, following are
+ * the supported context type:
+ *    Single node (HTMLElement)
+ *    Local file path (String)
+ *    URL (String)
+ *    document node
+ *    data stream for html content (String)
+ *
+ *  Future Items
+ *    Multiple node (Array of HTMLElements) ---> FUTURE
+ *
+ * @param {(String|HTMLElement|DocumentNode|Puppeteer Page |)} content - Provide the context to scan, which includes the items from above.
+ * @param {String} label - Provide a label for the scan that is being performed
+ * @param {Function} callback - (optional) Provide callback function which will be executed once the results are extracted.
+ * @return Promise with the ICheckerResult
+ */
+export function getCompliance(content, label, callback) {
+    if (callback) {
+        getComplianceHelper(content, label)
+            .then((result) => {
+            callback(result.report, result.webdriver);
+        });
+    }
+    else {
+        return getComplianceHelper(content, label);
+    }
+}
+/**
+ * This function is responsible for comparing the scan results with baseline or checking that there are
+ * no violations which fall into the failsLevels levels. In the case a baseline is found then baseline will
+ * be used to perform the check, in the case no baseline is provided then we comply with only failing if
+ * there is a sinble violation which falls into failLevels.
+ *
+ * @param {ReportResult} actual - the actual results object provided by the user, this object should follow the
+ *                          same format as outlined in the return of aChecker.buildReport function.
+ *
+ * @return {int} - return 0 in the case actual matches baseline or no violations fall into failsLevels,
+ *                 return 1 in the case actual results does not match baseline results,
+ *                 return 2 in the case that there is a failure based on failLevels (this means no baseline found).
+ *                 return -1 in the case that there is an exception that occured in the results object which came from the scan engine.
+ */
+export function assertCompliance(report) {
+    return BaselineManager.assertCompliance(report);
+}
+/**
+ * This function is responsible for printing the scan results to console.
+ *
+ * @param {Object} results - Provide the results from the scan.
+ *
+ * @return {String} resultsString - String representation of the results/violations.
+ *
+ * PUBLIC API
+ *
+ * @memberOf this
+ */
+export function stringifyResults(report) {
+    return ReporterManager.stringifyResults(report);
+}
+export function getConfig() {
+    return ACConfigManager.getConfig();
+}
+export function getConfigUnsupported() {
+    return ACConfigManager.getConfigUnsupported();
+}
+export async function close() {
+    try {
+        await ReporterManager.generateSummaries();
+    }
+    catch (err) {
+        console.error(err);
+    }
+    return ACBrowserManager.close();
+}
+/**
+ * This function is responsible for getting the diff results based on label for a scan that was already performed.
+ *
+ * @param {String} label - Provide a lable for which to get the diff results for.
+ *
+ * @return {Object} - return the diff results object from global space based on label provided, the object will be
+ *                    in the same format as outlined in the return of aChecker.diffResultsWithExpected function.
+ */
+export function getDiffResults(label) {
+    return BaselineManager.getDiffResults(label);
+}
+/**
+ * This function is responsible for getting the baseline object for a label that was provided.
+ *
+ * @param {String} label - Provide a lable for which to get the baseline for.
+ *
+ * @return {Object} - return the baseline object from global space based on label provided, the object will be
+ *                    in the same format as outlined in the return of aChecker.buildReport function.
+ */
+export function getBaseline(label) {
+    return BaselineManager.getBaseline(label);
+}
+/**
+ * This function is responsible for comparing actual with expected and returning all the differences as an array.
+ *
+ * @param {Object} actual - Provide the actual object to be used for compare
+ * @param {Object} expected - Provide the expected object to be used for compare
+ * @param {boolean} clean - Provide a boolean if both the actual and expected objects need to be cleaned
+ *                          cleaning refers to converting the objects to match with a basic compliance
+ *                          compare of xpath and ruleId.
+ *
+ * @return {Object} differences - return an array of diff objects that were found, following is the format of the object:
+ * [
+ *     {
+ *         "kind": "E",
+ *         "path": [
+ *             "reports",
+ *             0,
+ *             "issues",
+ *             10,
+ *             "xpath"
+ *         ],
+ *         "lhs": "/html[1]/body[1]/div[2]/table[5]",
+ *         "rhs": "/html[1]/body[1]/div[2]/table[5]d",
+ *     },
+ *     {
+ *         "kind": "E",
+ *         "path": [
+ *             "label"
+ *         ],
+ *         "lhs": "Table-layoutMultiple",
+ *         "rhs": "dependencies/tools-rules-html/v2/a11y/test/g471/Table-layoutMultiple.html",
+ *     }
+ * ]
+ */
+export function diffResultsWithExpected(actual, expected, clean) {
+    return BaselineManager.diffResultsWithExpected(actual, expected, clean);
+}
+/**
+ * This function is responsible for cleaning up the compliance baseline or actual results, based on
+ * a pre-defined set of criterias, such as the following:
+ *      1. No need to compare summary object
+ *      2. Only need to compare the ruleId and xpath in for each of the issues
+ *
+ * @param {Object} objectToClean - Provide either an baseline or actual results object which would be in the
+ *                                 the same format as outlined in the return of aChecker.buildReport function.
+ *
+ * @return {Object} objectToClean - return an object that was cleaned to only contain the information that is
+ *                                  needed for compare. Following is a sample of how the cleaned object will look like:
+ * {
+ *     "label": "unitTestContent",
+ *     "reports": [
+ *         {
+ *             "frameIdx": "0",
+ *             "frameTitle": "Frame 0",
+ *             "issues": [
+ *                 {
+ *                     "ruleId": "1",
+ *                     "xpath": "/html[1]/head[1]/style[1]"
+ *                 }
+ *                 ....
+ *             ]
+ *         },
+ *         {
+ *             "frameIdx": "1",
+ *             "frameTitle": "Frame 1",
+ *             "issues": [
+ *                 {
+ *                     "ruleId": "471",
+ *                     "xpath": "/html[1]/body[1]/div[2]/table[3]"
+ *                 }
+ *                 ....
+ *             ]
+ *         }
+ *     ]
+ * }
+ */
+export function cleanComplianceObjectBeforeCompare(objectToClean) {
+    return BaselineManager.cleanComplianceObjectBeforeCompare(objectToClean);
+}
+export function addRuleset(ruleset) {
+    ACEngineManager.addRuleset(ruleset);
+}
+export async function getRuleset(rsId) {
+    return ACEngineManager.getRuleset(rsId);
+}
+;
+export async function getRulesets() {
+    return ACEngineManager.getRulesets();
+}
+;
+export async function getRules() {
+    return ACEngineManager.getRules();
+}
+export const ruleIdToLegacyId = {
+    "list_structure_proper": "3",
+    "marquee_elem_avoid": "5",
+    "heading_markup_misuse": "7",
+    "imagebutton_alt_exists": "10",
+    "img_ismap_misuse": "11",
+    "object_text_exists": "20",
+    "applet_alt_exists": "21",
+    "media_audio_transcribed": "24",
+    "blockquote_cite_exists": "25",
+    "meta_refresh_delay": "33",
+    "frame_title_exists": "39",
+    "input_label_exists": "41",
+    "media_alt_brief": "99",
+    "a_target_warning": "112",
+    "area_alt_exists": "240",
+    "RPT_Media_ImgColorUsage": "245",
+    "meta_redirect_optional": "254",
+    "element_attribute_deprecated": "256",
+    "text_quoted_correctly": "263",
+    "element_mouseevent_keyboard": "269",
+    "page_title_exists": "273",
+    "text_block_heading": "322",
+    "form_submit_button_exists": "324",
+    "element_id_unique": "377",
+    "form_font_color": "394",
+    "form_label_unique": "398",
+    "img_alt_misuse": "453",
+    "img_longdesc_misuse": "454",
+    "img_alt_valid": "455",
+    "style_background_decorative": "456",
+    "asciiart_alt_exists": "458",
+    "media_track_available": "511",
+    "media_alt_exists": "460",
+    "style_color_misuse": "466",
+    "select_options_grouped": "467",
+    "list_markup_review": "468",
+    "script_onclick_misuse": "470",
+    "table_structure_misuse": "471",
+    "WCAG20_Img_AltTriggerNonDecorative": "473",
+    "blink_elem_deprecated": "478",
+    "blink_css_review": "479",
+    "html_skipnav_exists": "481",
+    "page_title_valid": "484",
+    "heading_content_exists": "488",
+    "html_lang_exists": "490",
+    "form_interaction_review": "491",
+    "a_text_purpose": "495",
+    "fieldset_legend_valid": "497",
+    "media_live_captioned": "501",
+    "text_sensory_misuse": "502",
+    "media_autostart_controllable": "503",
+    "style_focus_visible": "506",
+    "img_alt_redundant": "1000",
+    "RPT_Style_ExternalStyleSheet": "1073",
+    // "RPT_Header_Trigger": "1002",
+    "script_onclick_avoid": "1007",
+    "table_summary_redundant": "1011",
+    "input_label_before": "1017",
+    "input_label_after": "1018",
+    "embed_noembed_exists": "1020",
+    "table_scope_valid": "1025",
+    "img_alt_null": "1027",
+    "input_fields_grouped": "1028",
+    "input_checkboxes_grouped": "1029",
+    "script_select_review": "1035",
+    "input_onchange_review": "1050",
+    "embed_alt_exists": "1051",
+    "noembed_content_exists": "1052",
+    "table_caption_empty": "1053",
+    "table_caption_nested": "1054",
+    "label_content_exists": "1055",
+    "dir_attribute_valid": "1056",
+    "frame_src_valid": "1057",
+    "table_headers_related": "1059",
+    "table_layout_linearized": "1060",
+    "table_headers_exists": "1061",
+    "label_ref_valid": "1062",
+    "element_accesskey_unique": "1063",
+    "script_focus_blur_review": "1064",
+    "imagemap_alt_exists": "1067",
+    "emoticons_alt_exists": "1068",
+    "style_before_after_review": "1069",
+    "text_whitespace_valid": "1070",
+    "aria_role_allowed": "1074",
+    "aria_attribute_value_valid": "1076",
+    "aria_id_unique": "1077",
+    "aria_attribute_required": "1079",
+    "aria_attribute_exists": "1082",
+    "aria_attribute_allowed": "1083",
+    "aria_activedescendant_tabindex_valid": "1084",
+    "aria_child_tabbable": "1086",
+    "aria_keyboard_handler_exists": "1087",
+    "img_alt_decorative": "1090",
+    "aria_search_label_unique": "1097",
+    "aria_application_label_unique": "1099",
+    "aria_application_labelled": "1100",
+    "aria_document_label_unique": "1101",
+    "WCAG20_Label_TargetInvisible": "1112",
+    "caption_track_exists": "1117",
+    "media_keyboard_controllable": "1119",
+    "HAAC_Input_HasRequired": "1124",
+    "aria_img_labelled": "1128",
+    "img_alt_background": "1132",
+    "element_accesskey_labelled": "1140",
+    "aria_attribute_conflict": "1141",
+    "canvas_content_described": "1143",
+    "figure_label_exists": "1144",
+    "input_placeholder_label_visible": "1145",
+    "form_submit_review": "1147",
+    "text_contrast_sufficient": "1148",
+    "text_contrast_sufficient_PV": "1149",
+    "skip_main_exists": "1150",
+    "skip_main_described": "1151",
+    "aria_child_valid": "1152",
+    "aria_parent_required": "1153",
+    "aria_eventhandler_role_valid": "1154",
+    "aria_widget_labelled": "1156",
+    "aria_content_in_landmark": "1157",
+    "aria_region_labelled": "1158",
+    "aria_main_label_visible": "1159",
+    "aria_banner_label_unique": "1160",
+    "aria_complementary_label_unique": "1161",
+    "aria_contentinfo_label_unique": "1162",
+    "aria_form_label_unique": "1163",
+    "aria_navigation_label_unique": "1164",
+    "aria_complementary_label_visible": "1165",
+    "aria_article_label_unique": "1166",
+    "Rpt_Aria_ArticleRoleLabel_Implicit": "1167",
+    "Rpt_Aria_MultipleGroupRoles_Implicit": "1168",
+    "Rpt_Aria_GroupRoleLabel_Implicit": "1169",
+    "aria_contentinfo_single": "1170",
+    "aria_banner_single": "1172",
+    "aria_contentinfo_misuse": "1173",
+    "aria_complementary_labelled": "1174",
+    "aria_region_label_unique": "1176",
+    "widget_tabbable_exists": "1177",
+    "widget_tabbable_single": "1178",
+    "style_highcontrast_visible": "1180",
+    "aria_main_label_unique": "1182",
+    "download_keyboard_controllable": "1183",
+    "error_message_exists": "1184",
+    "list_children_valid": "1185",
+    "aria_activedescendant_valid": "1186",
+    "application_content_accessible": "1187",
+    "aria_toolbar_label_unique": "1188",
+    "HAAC_Combobox_ARIA_11_Guideline": "1193",
+    "HAAC_Combobox_Must_Have_Text_Input": "1194",
+    "HAAC_Combobox_DOM_Focus": "1195",
+    "HAAC_Combobox_Autocomplete": "1196",
+    "HAAC_Combobox_Autocomplete_Invalid": "1197",
+    "HAAC_Combobox_Expanded": "1198",
+    "HAAC_Combobox_Popup": "1199",
+    "style_viewport_resizable": "1200",
+    "label_name_visible": "1202",
+    "input_autocomplete_valid": "1203",
+    "input_label_visible": "1204"
+};
+//# sourceMappingURL=index.js.map

package/mjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src-ts/index.ts"],"names":[],"mappings":"AAAC;;;;;;;;;;;;;;+EAc+E;AAEhF,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAGzE,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAEzE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,aAAa,CAAC,OAAY,EACtC,KAAa,EACb,QAAoD;IAEpD,IAAI,QAAQ,EAAE,CAAC;QACX,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC;aAC9B,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACb,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACX,CAAC;SAAM,CAAC;QACJ,OAAO,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAuB;IACpD,OAAO,eAAe,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;AACnD,CAAC;AAEA;;;;;;;;;;GAUG;AACJ,MAAM,UAAU,gBAAgB,CAAC,MAAsB;IACnD,OAAO,eAAe,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;AACnD,CAAC;AAED,MAAM,UAAU,SAAS;IACrB,OAAO,eAAe,CAAC,SAAS,EAAE,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,oBAAoB;IAChC,OAAO,eAAe,CAAC,oBAAoB,EAAE,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,KAAK;IACvB,IAAI,CAAC;QACD,MAAM,eAAe,CAAC,iBAAiB,EAAE,CAAC;IAC9C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,gBAAgB,CAAC,KAAK,EAAE,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IACxC,OAAO,eAAe,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IACrC,OAAO,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK;IAC3D,OAAO,eAAe,CAAC,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,UAAU,kCAAkC,CAAC,aAAa;IAC5D,OAAO,eAAe,CAAC,kCAAkC,CAAC,aAAa,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAO;IAC9B,eAAe,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAI;IACjC,OAAO,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAAA,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,WAAW;IAC7B,OAAO,eAAe,CAAC,WAAW,EAAE,CAAC;AACzC,CAAC;AAAA,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC1B,OAAO,eAAe,CAAC,QAAQ,EAAE,CAAC;AACtC,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,uBAAuB,EAAE,GAAG;IAC5B,oBAAoB,EAAE,GAAG;IACzB,uBAAuB,EAAE,GAAG;IAC5B,wBAAwB,EAAE,IAAI;IAC9B,kBAAkB,EAAE,IAAI;IACxB,oBAAoB,EAAE,IAAI;IAC1B,mBAAmB,EAAE,IAAI;IACzB,yBAAyB,EAAE,IAAI;IAC/B,wBAAwB,EAAE,IAAI;IAC9B,oBAAoB,EAAE,IAAI;IAC1B,oBAAoB,EAAE,IAAI;IAC1B,oBAAoB,EAAE,IAAI;IAC1B,iBAAiB,EAAE,IAAI;IACvB,kBAAkB,EAAE,KAAK;IACzB,iBAAiB,EAAE,KAAK;IACxB,yBAAyB,EAAE,KAAK;IAChC,wBAAwB,EAAE,KAAK;IAC/B,8BAA8B,EAAE,KAAK;IACrC,uBAAuB,EAAE,KAAK;IAC9B,6BAA6B,EAAE,KAAK;IACpC,mBAAmB,EAAE,KAAK;IAC1B,oBAAoB,EAAE,KAAK;IAC3B,2BAA2B,EAAE,KAAK;IAClC,mBAAmB,EAAE,KAAK;IAC1B,iBAAiB,EAAE,KAAK;IACxB,mBAAmB,EAAE,KAAK;IAC1B,gBAAgB,EAAE,KAAK;IACvB,qBAAqB,EAAE,KAAK;IAC5B,eAAe,EAAE,KAAK;IACtB,6BAA6B,EAAE,KAAK;IACpC,qBAAqB,EAAE,KAAK;IAC5B,uBAAuB,EAAE,KAAK;IAC9B,kBAAkB,EAAE,KAAK;IACzB,oBAAoB,EAAE,KAAK;IAC3B,wBAAwB,EAAE,KAAK;IAC/B,oBAAoB,EAAE,KAAK;IAC3B,uBAAuB,EAAE,KAAK;IAC9B,wBAAwB,EAAE,KAAK;IAC/B,oCAAoC,EAAE,KAAK;IAC3C,uBAAuB,EAAE,KAAK;IAC9B,kBAAkB,EAAE,KAAK;IACzB,qBAAqB,EAAE,KAAK;IAC5B,kBAAkB,EAAE,KAAK;IACzB,wBAAwB,EAAE,KAAK;IAC/B,kBAAkB,EAAE,KAAK;IACzB,yBAAyB,EAAE,KAAK;IAChC,gBAAgB,EAAE,KAAK;IACvB,uBAAuB,EAAE,KAAK;IAC9B,sBAAsB,EAAE,KAAK;IAC7B,qBAAqB,EAAE,KAAK;IAC5B,8BAA8B,EAAE,KAAK;IACrC,qBAAqB,EAAE,KAAK;IAC5B,mBAAmB,EAAE,MAAM;IAC3B,8BAA8B,EAAE,MAAM;IACtC,gCAAgC;IAChC,sBAAsB,EAAE,MAAM;IAC9B,yBAAyB,EAAE,MAAM;IACjC,oBAAoB,EAAE,MAAM;IAC5B,mBAAmB,EAAE,MAAM;IAC3B,sBAAsB,EAAE,MAAM;IAC9B,mBAAmB,EAAE,MAAM;IAC3B,cAAc,EAAE,MAAM;IACtB,sBAAsB,EAAE,MAAM;IAC9B,0BAA0B,EAAE,MAAM;IAClC,sBAAsB,EAAE,MAAM;IAC9B,uBAAuB,EAAE,MAAM;IAC/B,kBAAkB,EAAE,MAAM;IAC1B,wBAAwB,EAAE,MAAM;IAChC,qBAAqB,EAAE,MAAM;IAC7B,sBAAsB,EAAE,MAAM;IAC9B,sBAAsB,EAAE,MAAM;IAC9B,qBAAqB,EAAE,MAAM;IAC7B,iBAAiB,EAAE,MAAM;IACzB,uBAAuB,EAAE,MAAM;IAC/B,yBAAyB,EAAE,MAAM;IACjC,sBAAsB,EAAE,MAAM;IAC9B,iBAAiB,EAAE,MAAM;IACzB,0BAA0B,EAAE,MAAM;IAClC,0BAA0B,EAAE,MAAM;IAClC,qBAAqB,EAAE,MAAM;IAC7B,sBAAsB,EAAE,MAAM;IAC9B,2BAA2B,EAAE,MAAM;IACnC,uBAAuB,EAAE,MAAM;IAC/B,mBAAmB,EAAE,MAAM;IAC3B,4BAA4B,EAAE,MAAM;IACpC,gBAAgB,EAAE,MAAM;IACxB,yBAAyB,EAAE,MAAM;IACjC,uBAAuB,EAAE,MAAM;IAC/B,wBAAwB,EAAE,MAAM;IAChC,sCAAsC,EAAE,MAAM;IAC9C,qBAAqB,EAAE,MAAM;IAC7B,8BAA8B,EAAE,MAAM;IACtC,oBAAoB,EAAE,MAAM;IAC5B,0BAA0B,EAAE,MAAM;IAClC,+BAA+B,EAAE,MAAM;IACvC,2BAA2B,EAAE,MAAM;IACnC,4BAA4B,EAAE,MAAM;IACpC,8BAA8B,EAAE,MAAM;IACtC,sBAAsB,EAAE,MAAM;IAC9B,6BAA6B,EAAE,MAAM;IACrC,wBAAwB,EAAE,MAAM;IAChC,mBAAmB,EAAE,MAAM;IAC3B,oBAAoB,EAAE,MAAM;IAC5B,4BAA4B,EAAE,MAAM;IACpC,yBAAyB,EAAE,MAAM;IACjC,0BAA0B,EAAE,MAAM;IAClC,qBAAqB,EAAE,MAAM;IAC7B,iCAAiC,EAAE,MAAM;IACzC,oBAAoB,EAAE,MAAM;IAC5B,0BAA0B,EAAE,MAAM;IAClC,6BAA6B,EAAE,MAAM;IACrC,kBAAkB,EAAE,MAAM;IAC1B,qBAAqB,EAAE,MAAM;IAC7B,kBAAkB,EAAE,MAAM;IAC1B,sBAAsB,EAAE,MAAM;IAC9B,8BAA8B,EAAE,MAAM;IACtC,sBAAsB,EAAE,MAAM;IAC9B,0BAA0B,EAAE,MAAM;IAClC,sBAAsB,EAAE,MAAM;IAC9B,yBAAyB,EAAE,MAAM;IACjC,0BAA0B,EAAE,MAAM;IAClC,iCAAiC,EAAE,MAAM;IACzC,+BAA+B,EAAE,MAAM;IACvC,wBAAwB,EAAE,MAAM;IAChC,8BAA8B,EAAE,MAAM;IACtC,kCAAkC,EAAE,MAAM;IAC1C,2BAA2B,EAAE,MAAM;IACnC,oCAAoC,EAAE,MAAM;IAC5C,sCAAsC,EAAE,MAAM;IAC9C,kCAAkC,EAAE,MAAM;IAC1C,yBAAyB,EAAE,MAAM;IACjC,oBAAoB,EAAE,MAAM;IAC5B,yBAAyB,EAAE,MAAM;IACjC,6BAA6B,EAAE,MAAM;IACrC,0BAA0B,EAAE,MAAM;IAClC,wBAAwB,EAAE,MAAM;IAChC,wBAAwB,EAAE,MAAM;IAChC,4BAA4B,EAAE,MAAM;IACpC,wBAAwB,EAAE,MAAM;IAChC,gCAAgC,EAAE,MAAM;IACxC,sBAAsB,EAAE,MAAM;IAC9B,qBAAqB,EAAE,MAAM;IAC7B,6BAA6B,EAAE,MAAM;IACrC,gCAAgC,EAAE,MAAM;IACxC,2BAA2B,EAAE,MAAM;IACnC,iCAAiC,EAAE,MAAM;IACzC,oCAAoC,EAAE,MAAM;IAC5C,yBAAyB,EAAE,MAAM;IACjC,4BAA4B,EAAE,MAAM;IACpC,oCAAoC,EAAE,MAAM;IAC5C,wBAAwB,EAAE,MAAM;IAChC,qBAAqB,EAAE,MAAM;IAC7B,0BAA0B,EAAE,MAAM;IAClC,oBAAoB,EAAE,MAAM;IAC5B,0BAA0B,EAAE,MAAM;IAClC,qBAAqB,EAAE,MAAM;CAChC,CAAA"}

package/mjs/lib/ACBrowserManager.d.ts

@@ -0,0 +1,22 @@
+import { IConfigInternal } from "./common/config/IConfig.js";
+export declare class ACBrowserManager {
+    static browserP: any;
+    static config: IConfigInternal;
+    static numInits: 0;
+    static pages: any[];
+    static getBrowserChrome(force: boolean): Promise<any>;
+    static close(): Promise<void>;
+    /**
+     * This function is responsible for building an iframe object with the provided URL or local file.
+     *
+     * @param {String} URLorLocalFile - Provide a URL or local file to scan.
+     *
+     * @return {Object} content - return an object which contains the iframeDoc and also the URL or
+     *                               local file name.
+     *
+     * PRIVATE METHOD
+     *
+     * @memberOf this
+     */
+    static buildIframeAndGetDoc(URLorLocalFileorContent: any): Promise<any>;
+}

package/mjs/lib/ACBrowserManager.js

@@ -0,0 +1,121 @@
+import * as puppeteer from "puppeteer";
+import { ACConfigManager } from "./common/config/ACConfigManager.js";
+export class ACBrowserManager {
+    static browserP;
+    static config;
+    static numInits;
+    static pages = [];
+    static async getBrowserChrome(force) {
+        if (!ACBrowserManager.config) {
+            ACBrowserManager.config = await ACConfigManager.getConfigUnsupported();
+        }
+        if (force || !ACBrowserManager.browserP) {
+            return ACBrowserManager.browserP = puppeteer.launch({ headless: ACBrowserManager.config.headless, ignoreHTTPSErrors: ACBrowserManager.config.ignoreHTTPSErrors || false });
+        }
+        else {
+            return ACBrowserManager.browserP;
+        }
+    }
+    static async close() {
+        if (ACBrowserManager.browserP) {
+            let browser = await ACBrowserManager.browserP;
+            await browser.close();
+            ACBrowserManager.browserP = null;
+            ACBrowserManager.pages = [];
+        }
+    }
+    /**
+     * This function is responsible for building an iframe object with the provided URL or local file.
+     *
+     * @param {String} URLorLocalFile - Provide a URL or local file to scan.
+     *
+     * @return {Object} content - return an object which contains the iframeDoc and also the URL or
+     *                               local file name.
+     *
+     * PRIVATE METHOD
+     *
+     * @memberOf this
+     */
+    static async buildIframeAndGetDoc(URLorLocalFileorContent) {
+        if (!ACBrowserManager.config) {
+            ACBrowserManager.config = await ACConfigManager.getConfigUnsupported();
+        }
+        const MAX_TABS = ACBrowserManager.config.maxTabs;
+        const browser = await ACBrowserManager.getBrowserChrome(false);
+        // Clear out any pages that are already closed
+        ACBrowserManager.pages = ACBrowserManager.pages.filter((page) => page && !page.isClosed());
+        // If there's an existing, ready page, use it
+        let availPage;
+        for (const page of ACBrowserManager.pages) {
+            if (!availPage) {
+                if (!page.aceBusy) {
+                    availPage = page;
+                    page.aceBusy = true;
+                }
+            }
+        }
+        if (!availPage) {
+            // All pages are busy. Should we create a new one?
+            if (ACBrowserManager.pages.length + ACBrowserManager.numInits >= MAX_TABS) {
+                // Too many pages, restart
+                return new Promise((resolve, reject) => {
+                    setTimeout(async () => {
+                        resolve(await ACBrowserManager.buildIframeAndGetDoc(URLorLocalFileorContent));
+                    }, 500);
+                });
+            }
+            else {
+                // Let's create a new page
+                ++ACBrowserManager.numInits;
+                let newPage = await browser.newPage();
+                newPage.on('console', msg => {
+                    for (let i = 0; i < msg.args.length; ++i)
+                        console.log(`${i}: ${msg.args[i]}`);
+                });
+                newPage.aceBusy = true;
+                availPage = newPage;
+                ACBrowserManager.pages.push(newPage);
+                --ACBrowserManager.numInits;
+            }
+        }
+        let err = null, retVal = null;
+        async function nav() {
+            try {
+                if (URLorLocalFileorContent.toLowerCase().includes("<html")) {
+                    // await page.goto(`data:text/html,encodeURIComponent(${URLorLocalFileorContent})`, { waitUntil: 'networkidle0' });
+                    let urlStr = "data:text/html;charset=utf-8," + encodeURIComponent(URLorLocalFileorContent);
+                    await availPage.goto(urlStr);
+                }
+                else {
+                    await availPage.goto(URLorLocalFileorContent);
+                }
+            }
+            catch (e) {
+                err = `${e.message} ${URLorLocalFileorContent}`;
+                console.error(err);
+                return null;
+            }
+            return availPage;
+        }
+        try {
+            retVal = await nav();
+        }
+        catch (e) {
+        }
+        if (!retVal) {
+            // Page bad or unable to navigate, start over
+            availPage.close();
+            return new Promise((resolve, reject) => {
+                setTimeout(async () => {
+                    resolve(await ACBrowserManager.buildIframeAndGetDoc(URLorLocalFileorContent));
+                }, 0);
+            });
+        }
+        if (retVal === null) {
+            console.log("[Internal Error:load content]", err);
+        }
+        return retVal;
+    }
+    ;
+}
+//# sourceMappingURL=ACBrowserManager.js.map

package/mjs/lib/ACBrowserManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACBrowserManager.js","sourceRoot":"","sources":["../../../src-ts/lib/ACBrowserManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAIrE,MAAM,OAAO,gBAAgB;IACzB,MAAM,CAAC,QAAQ,CAAC;IAChB,MAAM,CAAC,MAAM,CAAkB;IAC/B,MAAM,CAAC,QAAQ,CAAI;IACnB,MAAM,CAAC,KAAK,GAAU,EAAE,CAAC;IAEzB,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAc;QACxC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC3B,gBAAgB,CAAC,MAAM,GAAG,MAAM,eAAe,CAAC,oBAAoB,EAAE,CAAC;QAC3E,CAAC;QACD,IAAK,KAAK,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YACvC,OAAO,gBAAgB,CAAC,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,EAAC,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,MAAM,CAAC,iBAAiB,IAAI,KAAK,EAAC,CAAC,CAAC;QAC7K,CAAC;aAAM,CAAC;YACJ,OAAO,gBAAgB,CAAC,QAAQ,CAAC;QACrC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAK;QACd,IAAI,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC5B,IAAI,OAAO,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC;YAC9C,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;YACjC,gBAAgB,CAAC,KAAK,GAAG,EAAE,CAAC;QAChC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,uBAAuB;QACrD,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC3B,gBAAgB,CAAC,MAAM,GAAG,MAAM,eAAe,CAAC,oBAAoB,EAAE,CAAC;QAC3E,CAAC;QACD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC;QACjD,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE/D,8CAA8C;QAC9C,gBAAgB,CAAC,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3F,6CAA6C;QAC7C,IAAI,SAAS,CAAC;QACd,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;YACxC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;oBAChB,SAAS,GAAG,IAAI,CAAC;oBACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QAED,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,kDAAkD;YAClD,IAAI,gBAAgB,CAAC,KAAK,CAAC,MAAM,GAAC,gBAAgB,CAAC,QAAQ,IAAI,QAAQ,EAAE,CAAC;gBACtE,0BAA0B;gBAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACnC,UAAU,CAAC,KAAK,IAAI,EAAE;wBAClB,OAAO,CAAC,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,CAAC,CAAC;oBAClF,CAAC,EAAE,GAAG,CAAC,CAAC;gBACZ,CAAC,CAAC,CAAC;YACP,CAAC;iBAAM,CAAC;gBACJ,0BAA0B;gBAC1B,EAAE,gBAAgB,CAAC,QAAQ,CAAC;gBAE5B,IAAI,OAAO,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;gBACtC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE;oBACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;wBACxC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACxC,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;gBACvB,SAAS,GAAG,OAAO,CAAC;gBACpB,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrC,EAAE,gBAAgB,CAAC,QAAQ,CAAC;YAChC,CAAC;QACL,CAAC;QAED,IAAI,GAAG,GAAG,IAAI,EACV,MAAM,GAAG,IAAI,CAAC;QAClB,KAAK,UAAU,GAAG;YACd,IAAI,CAAC;gBACD,IAAI,uBAAuB,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC1D,mHAAmH;oBACnH,IAAI,MAAM,GAAG,+BAA+B,GAAG,kBAAkB,CAAC,uBAAuB,CAAC,CAAC;oBAC3F,MAAM,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACJ,MAAM,SAAS,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;gBAClD,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,GAAG,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAAC;gBAChD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,CAAC;YACD,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;QACb,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,6CAA6C;YAC7C,SAAS,CAAC,KAAK,EAAE,CAAC;YAClB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACnC,UAAU,CAAC,KAAK,IAAI,EAAE;oBAClB,OAAO,CAAC,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,CAAC,CAAC;gBAClF,CAAC,EAAE,CAAC,CAAC,CAAC;YACV,CAAC,CAAC,CAAC;QACP,CAAC;QACD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;QACtD,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAAA,CAAC"}

package/mjs/lib/ACEngineManager.d.ts

@@ -0,0 +1,19 @@
+import { IChecker } from "./common/engine/IChecker.js";
+export declare class ACEngineManager {
+    static customRulesets: any[];
+    static engineContent: any;
+    static loadEngine(content: any): Promise<any>;
+    static localLoadPromise: any;
+    static loadEngineLocal(): Promise<any>;
+    static isPuppeteer(content: any): any;
+    static isPlaywright(content: any): boolean;
+    static isSelenium(content: any): boolean;
+    static isWebDriverIO(content: any): boolean;
+    static addRuleset: (ruleset: any) => void;
+    static getRuleset: (rsId: any) => Promise<any>;
+    static getRulesets: () => Promise<any[]>;
+    static getChecker(): IChecker;
+    static loadChecker(): Promise<IChecker>;
+    static getRules: () => Promise<any[]>;
+    static getRulesSync: () => any[];
+}