abledom 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -2,33 +2,37 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
-interface ValidationError {
+declare enum ValidationRuleType {
+    Error = 1,
+    Warning = 2,
+    Info = 3
+}
+interface ValidationNotification {
     id: string;
     message: string;
+    element?: HTMLElement;
     rel?: Node;
     link?: string;
     stack?: string[];
     relStack?: string[];
 }
 interface ValidationResult {
-    error?: ValidationError;
+    notification?: ValidationNotification;
     dependsOnIds?: Set<string>;
 }
-interface FocusError {
-    element: HTMLElement;
-    error: ValidationError;
-}
-interface BlurError {
-    element: HTMLElement;
+interface BlurNotification extends ValidationNotification {
     position?: string[];
-    error: ValidationError;
 }
-declare abstract class ValidationRule {
+declare abstract class ValidationRule<N extends ValidationNotification = ValidationNotification> {
+    abstract type: ValidationRuleType;
     abstract name: string;
     private _window?;
     private _exceptions;
-    static setWindow(instance: ValidationRule, window: Window): void;
+    private _onNotification;
+    static init(instance: ValidationRule, window: Window, onNotification: (rule: ValidationRule, notification: ValidationNotification) => void): void;
+    static dispose(instance: ValidationRule): void;
     static checkExceptions(instance: ValidationRule, element: HTMLElement): boolean;
+    private dispose;
     addException(checkException: (element: HTMLElement) => boolean): void;
     removeException(checkException: (element: HTMLElement) => boolean): void;
     /**
@@ -45,8 +49,9 @@ declare abstract class ValidationRule {
     stop?(): void;
     accept?(element: HTMLElement): boolean;
     validate?(element: HTMLElement): ValidationResult | null;
-    focused?(event: FocusEvent): Promise<FocusError | null>;
-    blurred?(event: FocusEvent): Promise<BlurError | null>;
+    notify(notification: N): void;
+    focused?(event: FocusEvent): ValidationNotification | null;
+    blurred?(event: FocusEvent): BlurNotification | null;
 }
 
 /*!
@@ -55,10 +60,10 @@ declare abstract class ValidationRule {
  */
 
 declare class AbleDOM {
-    private _window;
+    private _win;
     private _observer;
     private _clearValidationTimeout;
-    private _elementsWithErrors;
+    private _elementsWithNotifications;
     private _changedElementIds;
     private _elementsDependingOnId;
     private _dependantIdsByElement;
@@ -68,13 +73,14 @@ declare class AbleDOM {
     private _isStarted;
     constructor(win: Window);
     private _onElementId;
-    private _addValidationError;
-    private _removeElementError;
+    private _addNotification;
+    private _removeNotification;
     private _validate;
     private _processElementDependingOnIds;
     private _remove;
     private _onFocusIn;
     private _onFocusOut;
+    private _notifyAsync;
     addRule(rule: ValidationRule): void;
     removeRule(rule: ValidationRule): void;
     start(): void;
@@ -82,6 +88,7 @@ declare class AbleDOM {
 }
 
 declare class AtomicRule extends ValidationRule {
+    type: ValidationRuleType;
     name: string;
     anchored: boolean;
     accept(element: HTMLElement): boolean;
@@ -94,6 +101,7 @@ declare class AtomicRule extends ValidationRule {
  */
 
 declare class FocusableElementLabelRule extends ValidationRule {
+    type: ValidationRuleType;
     name: string;
     anchored: boolean;
     private _isAriaHidden;
@@ -108,6 +116,7 @@ declare class FocusableElementLabelRule extends ValidationRule {
  */
 
 declare class ExistingIdRule extends ValidationRule {
+    type: ValidationRuleType;
     name: string;
     anchored: boolean;
     accept(element: HTMLElement): boolean;
@@ -119,7 +128,8 @@ declare class ExistingIdRule extends ValidationRule {
  * Licensed under the MIT License.
  */
 
-declare class FocusLostRule extends ValidationRule {
+declare class FocusLostRule extends ValidationRule<BlurNotification> {
+    type: ValidationRuleType;
     name: string;
     anchored: boolean;
     private _focusLostTimeout;
@@ -128,9 +138,13 @@ declare class FocusLostRule extends ValidationRule {
     private _focusedElementPosition;
     private _lastFocusStack;
     private _lastBlurStack;
+    private _mouseEventTimer;
+    private _releaseMouseEvent;
     private _serializeElementPosition;
-    focused(event: FocusEvent): Promise<FocusError | null>;
-    blurred(event: FocusEvent): Promise<BlurError | null>;
+    focused(event: FocusEvent): null;
+    blurred(event: FocusEvent): null;
+    start(): void;
+    stop(): void;
 }
 
 /*!
@@ -139,13 +153,51 @@ declare class FocusLostRule extends ValidationRule {
  */
 
 declare class BadFocusRule extends ValidationRule {
+    type: ValidationRuleType;
     name: string;
     anchored: boolean;
     private _lastFocusStack;
     private _lastBlurStack;
-    private _reject;
-    focused(): Promise<FocusError | null>;
-    blurred(): Promise<BlurError | null>;
+    private _clearCheckTimer;
+    focused(): null;
+    blurred(): null;
+    stop(): void;
+}
+
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+declare class FindElementRule extends ValidationRule {
+    type: ValidationRuleType;
+    name: string;
+    anchored: boolean;
+    private _conditions;
+    addCondition(name: string, condition: (element: HTMLElement) => boolean): void;
+    removeCondition(name: string): void;
+    validate(element: HTMLElement): ValidationResult | null;
+}
+
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+declare class CustomNotifyRule extends ValidationRule {
+    type: ValidationRuleType;
+    name: string;
+    anchored: boolean;
+    customNotify(message: string, element?: HTMLElement): void;
+}
+
+interface HTMLElementAttributes {
+    readonly [name: string]: string;
 }
+declare function isAccessibilityAffectingElement(element: HTMLElement): boolean;
+declare function hasAccessibilityAttribute(attributes: HTMLElementAttributes): boolean;
+declare function matchesSelector(element: HTMLElement, selector: string): boolean;
+declare function isDisplayNone(element: HTMLElement): boolean;
+declare function isElementVisible(element: HTMLElement): boolean;
 
-export { AbleDOM, AtomicRule, BadFocusRule, type BlurError, ExistingIdRule, type FocusError, FocusLostRule, FocusableElementLabelRule, ValidationRule };
+export { AbleDOM, AtomicRule, BadFocusRule, type BlurNotification, CustomNotifyRule, ExistingIdRule, FindElementRule, FocusLostRule, FocusableElementLabelRule, type ValidationNotification, type ValidationResult, ValidationRule, ValidationRuleType, hasAccessibilityAttribute, isAccessibilityAffectingElement, isDisplayNone, isElementVisible, matchesSelector };