accessibility-checker 3.1.0 → 3.1.4

package/index.d.ts

@@ -0,0 +1,317 @@
+/******************************************************************************
+    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 { eAssertResult, ICheckerError, ICheckerReport, ICheckerResult, IConfig, IConfigUnsupported } from "./lib/api/IChecker";
+/**
+ * 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 declare function getCompliance(content: any, label: string, callback?: (report: ICheckerReport | ICheckerError, webdriver: any) => void): Promise<ICheckerResult>;
+/**
+ * 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 {ICheckerReport} 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 declare function assertCompliance(report: ICheckerReport): eAssertResult;
+/**
+ * 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 declare function stringifyResults(report: ICheckerReport): string;
+export declare function getConfig(): Promise<IConfig>;
+export declare function getConfigUnsupported(): Promise<IConfigUnsupported>;
+export declare function close(): Promise<void>;
+/**
+ * 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 declare function getDiffResults(label: string): any;
+/**
+ * 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 declare function getBaseline(label: string): any;
+/**
+ * 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 declare function diffResultsWithExpected(actual: any, expected: any, clean: any): any;
+/**
+ * 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 declare function cleanComplianceObjectBeforeCompare(objectToClean: any): any;
+export declare const ruleIdToLegacyId: {
+    RPT_List_Misuse: string;
+    RPT_Marquee_Trigger: string;
+    RPT_Headers_FewWords: string;
+    WCAG20_Input_ExplicitLabelImage: string;
+    RPT_Img_UsemapValid: string;
+    WCAG20_Object_HasText: string;
+    WCAG20_Applet_HasAlt: string;
+    RPT_Media_AudioTrigger: string;
+    RPT_Blockquote_HasCite: string;
+    RPT_Meta_Refresh: string;
+    WCAG20_Frame_HasTitle: string;
+    WCAG20_Input_ExplicitLabel: string;
+    RPT_Media_AltBrief: string;
+    WCAG20_A_TargetAndText: string;
+    WCAG20_Area_HasAlt: string;
+    RPT_Media_ImgColorUsage: string;
+    WCAG20_Meta_RedirectZero: string;
+    RPT_Elem_Deprecated: string;
+    RPT_Blockquote_WrapsTextQuote: string;
+    RPT_Elem_EventMouseAndKey: string;
+    WCAG20_Doc_HasTitle: string;
+    RPT_Block_ShouldBeHeading: string;
+    WCAG20_Form_HasSubmit: string;
+    RPT_Elem_UniqueId: string;
+    RPT_Font_ColorInForm: string;
+    RPT_Label_UniqueFor: string;
+    RPT_Img_AltCommonMisuse: string;
+    RPT_Img_LongDescription2: string;
+    WCAG20_Img_HasAlt: string;
+    RPT_Style_BackgroundImage: string;
+    RPT_Pre_ASCIIArt: string;
+    RPT_Media_VideoReferenceTrigger: string;
+    RPT_Media_AudioVideoAltFilename: string;
+    RPT_Style_ColorSemantics1: string;
+    WCAG20_Select_HasOptGroup: string;
+    RPT_List_UseMarkup: string;
+    RPT_Script_OnclickHTML1: string;
+    WCAG20_Table_Structure: string;
+    WCAG20_Img_AltTriggerNonDecorative: string;
+    WCAG20_Blink_AlwaysTrigger: string;
+    RPT_Blink_CSSTrigger1: string;
+    RPT_Html_SkipNav: string;
+    RPT_Title_Valid: string;
+    RPT_Header_HasContent: string;
+    WCAG20_Html_HasLang: string;
+    WCAG20_Form_TargetAndText: string;
+    WCAG20_A_HasText: string;
+    WCAG20_Fieldset_HasLegend: string;
+    RPT_Media_VideoObjectTrigger: string;
+    RPT_Text_SensoryReference: string;
+    RPT_Embed_AutoStart: string;
+    RPT_Style_HinderFocus1: string;
+    WCAG20_Elem_Lang_Valid: string;
+    WCAG20_Img_LinkTextNotRedundant: string;
+    RPT_Style_ExternalStyleSheet: string;
+    RPT_Header_Trigger: string;
+    RPT_Script_OnclickHTML2: string;
+    WCAG20_Table_CapSummRedundant: string;
+    WCAG20_Input_LabelBefore: string;
+    WCAG20_Input_LabelAfter: string;
+    WCAG20_Embed_HasNoEmbed: string;
+    WCAG20_Table_Scope_Valid: string;
+    WCAG20_Img_TitleEmptyWhenAltNull: string;
+    WCAG20_Input_InFieldSet: string;
+    WCAG20_Input_RadioChkInFieldSet: string;
+    WCAG20_Select_NoChangeAction: string;
+    WCAG20_Input_HasOnchange: string;
+    RPT_Embed_HasAlt: string;
+    Valerie_Noembed_HasContent: string;
+    Valerie_Caption_HasContent: string;
+    Valerie_Caption_InTable: string;
+    Valerie_Label_HasContent: string;
+    Valerie_Elem_DirValid: string;
+    Valerie_Frame_SrcHtml: string;
+    Valerie_Table_DataCellRelationships: string;
+    RPT_Table_LayoutTrigger: string;
+    RPT_Table_DataHeadingsAria: string;
+    WCAG20_Label_RefValid: string;
+    WCAG20_Elem_UniqueAccessKey: string;
+    WCAG20_Script_FocusBlurs: string;
+    HAAC_Img_UsemapAlt: string;
+    WCAG20_Text_Emoticons: string;
+    WCAG20_Style_BeforeAfter: string;
+    WCAG20_Text_LetterSpacing: string;
+    Rpt_Aria_ValidRole: string;
+    Rpt_Aria_ValidPropertyValue: string;
+    Rpt_Aria_ValidIdRef: string;
+    Rpt_Aria_RequiredProperties: string;
+    Rpt_Aria_EmptyPropertyValue: string;
+    Rpt_Aria_ValidProperty: string;
+    Rpt_Aria_InvalidTabindexForActivedescendant: string;
+    Rpt_Aria_MissingFocusableChild: string;
+    Rpt_Aria_MissingKeyboardHandler: string;
+    WCAG20_Img_PresentationImgHasNonNullAlt: string;
+    Rpt_Aria_MultipleSearchLandmarks: string;
+    Rpt_Aria_MultipleApplicationLandmarks: string;
+    Rpt_Aria_ApplicationLandmarkLabel: string;
+    Rpt_Aria_MultipleDocumentRoles: string;
+    WCAG20_Label_TargetInvisible: string;
+    HAAC_Video_HasNoTrack: string;
+    HAAC_Audio_Video_Trigger: string;
+    HAAC_Input_HasRequired: string;
+    HAAC_Aria_ImgAlt: string;
+    HAAC_BackgroundImg_HasTextOrTitle: string;
+    HAAC_Accesskey_NeedLabel: string;
+    HAAC_Aria_Or_HTML5_Attr: string;
+    HAAC_Canvas: string;
+    HAAC_Figure_label: string;
+    HAAC_Input_Placeholder: string;
+    HAAC_Aria_Native_Host_Sematics: string;
+    RPT_Form_ChangeEmpty: string;
+    IBMA_Color_Contrast_WCAG2AA: string;
+    IBMA_Color_Contrast_WCAG2AA_PV: string;
+    WCAG20_Body_FirstASkips_Native_Host_Sematics: string;
+    WCAG20_Body_FirstAContainsSkipText_Native_Host_Sematics: string;
+    Rpt_Aria_RequiredChildren_Native_Host_Sematics: string;
+    Rpt_Aria_RequiredParent_Native_Host_Sematics: string;
+    Rpt_Aria_EventHandlerMissingRole_Native_Host_Sematics: string;
+    Rpt_Aria_WidgetLabels_Implicit: string;
+    Rpt_Aria_OrphanedContent_Native_Host_Sematics: string;
+    Rpt_Aria_RegionLabel_Implicit: string;
+    Rpt_Aria_MultipleMainsVisibleLabel_Implicit: string;
+    Rpt_Aria_MultipleBannerLandmarks_Implicit: string;
+    Rpt_Aria_MultipleComplementaryLandmarks_Implicit: string;
+    Rpt_Aria_MultipleContentinfoLandmarks_Implicit: string;
+    Rpt_Aria_MultipleFormLandmarks_Implicit: string;
+    Rpt_Aria_MultipleNavigationLandmarks_Implicit: string;
+    Rpt_Aria_ComplementaryLandmarkLabel_Implicit: string;
+    Rpt_Aria_MultipleArticleRoles_Implicit: string;
+    Rpt_Aria_ArticleRoleLabel_Implicit: string;
+    Rpt_Aria_MultipleGroupRoles_Implicit: string;
+    Rpt_Aria_GroupRoleLabel_Implicit: string;
+    Rpt_Aria_MultipleContentinfoInSiblingSet_Implicit: string;
+    Rpt_Aria_OneBannerInSiblingSet_Implicit: string;
+    Rpt_Aria_ContentinfoWithNoMain_Implicit: string;
+    Rpt_Aria_ComplementaryRequiredLabel_Implicit: string;
+    Rpt_Aria_MultipleRegionsUniqueLabel_Implicit: string;
+    IBMA_Focus_Tabbable: string;
+    IBMA_Focus_MultiTab: string;
+    WCAG20_Table_SummaryAria3: string;
+    RPT_Style_Trigger2: string;
+    Rpt_Aria_MultipleMainsRequireLabel_Implicit_2: string;
+    HAAC_Media_DocumentTrigger2: string;
+    HAAC_Aria_ErrorMessage: string;
+    HAAC_List_Group_ListItem: string;
+    HAAC_ActiveDescendantCheck: string;
+    HAAC_Application_Role_Text: string;
+    Rpt_Aria_MultipleToolbarUniqueLabel: string;
+    HAAC_Combobox_ARIA_11_Guideline: string;
+    HAAC_Combobox_Must_Have_Text_Input: string;
+    HAAC_Combobox_DOM_Focus: string;
+    HAAC_Combobox_Autocomplete: string;
+    HAAC_Combobox_Autocomplete_Invalid: string;
+    HAAC_Combobox_Expanded: string;
+    HAAC_Combobox_Popup: string;
+    WCAG21_Style_Viewport: string;
+    WCAG21_Label_Accessible: string;
+    WCAG21_Input_Autocomplete: string;
+    WCAG20_Input_VisibleLabel: string;
+};