@yaronelh/accessibilitytool 1.0.1

package/dist-cjs/core/session.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveSessionState = saveSessionState;
+exports.restoreSessionState = restoreSessionState;
+const SESSION_STORAGE_KEY = 'accessibility:session:v1';
+const LEGACY_SESSION_STORAGE_KEY = '_accessState';
+function saveSessionState(storage, sessionState) {
+    storage.set(SESSION_STORAGE_KEY, sessionState);
+    storage.remove(LEGACY_SESSION_STORAGE_KEY);
+}
+function restoreSessionState(storage, handlers) {
+    const sessionState = (storage.get(SESSION_STORAGE_KEY) ??
+        storage.get(LEGACY_SESSION_STORAGE_KEY));
+    if (!sessionState)
+        return;
+    replayDelta(sessionState.textSize, handlers.applyTextSize);
+    replayDelta(sessionState.textSpace, handlers.applyTextSpace);
+    replayDelta(sessionState.lineHeight, handlers.applyLineHeight);
+    if (sessionState.invertColors)
+        handlers.enableInvertColors();
+    if (sessionState.grayHues)
+        handlers.enableGrayHues();
+    if (sessionState.underlineLinks)
+        handlers.enableUnderlineLinks();
+    if (sessionState.bigCursor)
+        handlers.enableBigCursor();
+    if (sessionState.readingGuide)
+        handlers.enableReadingGuide();
+    handlers.assignSessionState(sessionState);
+}
+function replayDelta(value, apply) {
+    if (!value)
+        return;
+    if (value > 0) {
+        while (value--)
+            apply(true);
+    }
+    else {
+        while (value++)
+            apply(false);
+    }
+}
+//# sourceMappingURL=session.js.map

package/dist-cjs/core/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../../src/core/session.ts"],"names":[],"mappings":";;AAMA,4CAGC;AAED,kDA6BC;AArCD,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AACvD,MAAM,0BAA0B,GAAG,cAAc,CAAC;AAElD,SAAgB,gBAAgB,CAAC,OAAgB,EAAE,YAA2B;IAC7E,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IAC/C,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAC5C,CAAC;AAED,SAAgB,mBAAmB,CAClC,OAAgB,EAChB,QAUC;IAED,MAAM,YAAY,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACrD,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAyB,CAAC;IAClE,IAAI,CAAC,YAAY;QAAE,OAAO;IAE1B,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC3D,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC7D,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE/D,IAAI,YAAY,CAAC,YAAY;QAAE,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IAC7D,IAAI,YAAY,CAAC,QAAQ;QAAE,QAAQ,CAAC,cAAc,EAAE,CAAC;IACrD,IAAI,YAAY,CAAC,cAAc;QAAE,QAAQ,CAAC,oBAAoB,EAAE,CAAC;IACjE,IAAI,YAAY,CAAC,SAAS;QAAE,QAAQ,CAAC,eAAe,EAAE,CAAC;IACvD,IAAI,YAAY,CAAC,YAAY;QAAE,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IAE7D,QAAQ,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,KAAoC;IACvE,IAAI,CAAC,KAAK;QAAE,OAAO;IAEnB,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACf,OAAO,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;SAAM,CAAC;QACP,OAAO,KAAK,EAAE;YAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;AACF,CAAC"}

package/dist-cjs/interfaces/accessibility.interface.d.ts

@@ -0,0 +1,208 @@
+import { ICommon, IJsonToHtml, IUnitsDim } from './common.interface.js';
+import { IMenuInterface } from './menu.interface.js';
+export interface IAccessibility {
+    menuInterface: IMenuInterface;
+    options: IAccessibilityOptions;
+    sessionState: ISessionState;
+    common: ICommon;
+    stateValues: IStateValues;
+    isReading: boolean;
+    readonly html: HTMLElement;
+    readonly body: HTMLBodyElement;
+    readonly recognition: any;
+    readonly fixedDefaultFont: string;
+    alterTextSize(isIncrease: boolean): void;
+    alterTextSpace(isIncrease: boolean): void;
+    alterLineHeight(isIncrease: boolean): void;
+    speechToText(): void;
+    textToSpeech(text: string): void;
+    listen(e?: Event): void;
+    read(e?: Event): void;
+    runHotkey(name: string): void;
+    toggleMenu(): void;
+    invoke(action: string, button: HTMLElement): void;
+    build(): void;
+    updateReadGuide(e: Event | TouchEvent | any): void;
+    resetIfDefined(src: string, dest: any, prop: string): void;
+    onChange(updateSession: boolean): void;
+    createScreenShot(url: string): Promise<string>;
+    injectCss(injectFull: boolean): void;
+    removeCSS(): void;
+}
+export interface IAccessibilityOptions {
+    icon?: IAccessibilityIconOptions;
+    hotkeys?: IAccessibilityHotkeysOptions;
+    guide?: IAccessibilityGuideOptions;
+    labels?: IAccessibilityMenuLabelsOptions;
+    textToSpeechLang?: string;
+    speechToTextLang?: string;
+    textPixelMode?: boolean;
+    textEmlMode?: boolean;
+    textSizeFactor?: number;
+    modules?: IAccessibilityModulesOptions;
+    modulesOrder?: Array<IAccessibilityModuleOrder>;
+    session?: IAccessibilitySessionOptions;
+    iframeModals?: Array<IIframeModal>;
+    customFunctions?: Array<ICustomFunction>;
+    allowedIframeOrigins?: string[];
+    statement?: IAccessibilityUrlOptions;
+    feedback?: IAccessibilityUrlOptions;
+    language?: IAccessibilityLanguageOptions;
+    suppressCssInjection?: boolean;
+    suppressDomInjection?: boolean;
+}
+export interface ICustomFunction {
+    method: Function;
+    buttonText: string;
+    id: any;
+    toggle: boolean;
+    icon?: string;
+    emoji?: string;
+}
+export interface IIframeModal {
+    iframeUrl: string;
+    buttonText: string;
+    icon?: string;
+    emoji?: string;
+}
+export interface IAccessibilityIconOptions {
+    img?: string;
+    imgElem?: IJsonToHtml;
+    fontFaceSrc?: Array<string>;
+    fontClass?: string;
+    useEmojis?: boolean;
+    allowRemoteFonts?: boolean;
+    fontFamilyValidation?: string;
+    tabIndex?: number;
+    closeIcon?: string;
+    resetIcon?: string;
+    closeIconElem?: IJsonToHtml;
+    resetIconElem?: IJsonToHtml;
+}
+export interface IAccessibilityIconPositionOptions {
+    top?: IUnitsDim;
+    bottom?: IUnitsDim;
+    left?: IUnitsDim;
+    right?: IUnitsDim;
+    type?: string;
+}
+export interface IAccessibilityIconDimensionsOptions {
+    width: IUnitsDim;
+    height: IUnitsDim;
+}
+export interface IAccessibilityHotkeysOptions {
+    enabled: boolean;
+    helpTitles: boolean;
+    keys: IAccessibilityHotkeysKeysOptions;
+}
+export interface IAccessibilityHotkeysKeysOptions {
+    toggleMenu: Array<any>;
+    invertColors: Array<any>;
+    grayHues: Array<any>;
+    underlineLinks: Array<any>;
+    bigCursor: Array<any>;
+    readingGuide: Array<any>;
+    textToSpeech: Array<any>;
+    speechToText: Array<any>;
+    disableAnimations: Array<any>;
+}
+export interface IAccessibilityGuideOptions {
+    cBorder: string;
+    cBackground: string;
+    height: string;
+}
+export interface IAccessibilityMenuDimensionsOptions {
+    width: IUnitsDim;
+    height: IUnitsDim;
+}
+export interface IAccessibilityMenuLabelsOptions {
+    resetTitle: string;
+    closeTitle: string;
+    menuTitle: string;
+    increaseText: string;
+    decreaseText: string;
+    increaseTextSpacing: string;
+    decreaseTextSpacing: string;
+    invertColors: string;
+    grayHues: string;
+    bigCursor: string;
+    readingGuide: string;
+    underlineLinks: string;
+    textToSpeech: string;
+    speechToText: string;
+    disableAnimations: string;
+    increaseLineHeight: string;
+    decreaseLineHeight: string;
+    hotkeyPrefix: string;
+}
+export interface IAccessibilityModulesOptions {
+    increaseText: boolean;
+    decreaseText: boolean;
+    increaseTextSpacing: boolean;
+    decreaseTextSpacing: boolean;
+    increaseLineHeight: boolean;
+    decreaseLineHeight: boolean;
+    invertColors: boolean;
+    grayHues: boolean;
+    bigCursor: boolean;
+    readingGuide: boolean;
+    underlineLinks: boolean;
+    textToSpeech: boolean;
+    speechToText: boolean;
+    disableAnimations: boolean;
+}
+export declare enum AccessibilityModulesType {
+    increaseText = 1,
+    decreaseText = 2,
+    increaseTextSpacing = 3,
+    decreaseTextSpacing = 4,
+    increaseLineHeight = 5,
+    decreaseLineHeight = 6,
+    invertColors = 7,
+    grayHues = 8,
+    bigCursor = 9,
+    readingGuide = 10,
+    underlineLinks = 11,
+    textToSpeech = 12,
+    speechToText = 13,
+    disableAnimations = 14,
+    iframeModals = 15,
+    customFunctions = 16
+}
+export interface IAccessibilityModuleOrder {
+    order: number;
+    type: AccessibilityModulesType;
+}
+export interface IAccessibilitySessionOptions {
+    persistent: boolean;
+}
+export interface IAccessibilityUrlOptions {
+    url: string;
+}
+export interface IAccessibilityLanguageOptions {
+    textToSpeechLang: string;
+    speechToTextLang: string;
+}
+export interface ISessionState {
+    textSize: number;
+    textSpace: number;
+    lineHeight: number;
+    invertColors: boolean;
+    grayHues: boolean;
+    underlineLinks: boolean;
+    bigCursor: boolean;
+    readingGuide: boolean;
+}
+export interface IStateValues {
+    underlineLinks: boolean;
+    textToSpeech: boolean;
+    bigCursor: boolean;
+    readingGuide: boolean;
+    invertColors?: boolean;
+    grayHues?: boolean;
+    speechToText?: boolean;
+    disableAnimations?: boolean;
+    speechRate?: number;
+    body: any;
+    html: any;
+}

package/dist-cjs/interfaces/accessibility.interface.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccessibilityModulesType = void 0;
+var AccessibilityModulesType;
+(function (AccessibilityModulesType) {
+    AccessibilityModulesType[AccessibilityModulesType["increaseText"] = 1] = "increaseText";
+    AccessibilityModulesType[AccessibilityModulesType["decreaseText"] = 2] = "decreaseText";
+    AccessibilityModulesType[AccessibilityModulesType["increaseTextSpacing"] = 3] = "increaseTextSpacing";
+    AccessibilityModulesType[AccessibilityModulesType["decreaseTextSpacing"] = 4] = "decreaseTextSpacing";
+    AccessibilityModulesType[AccessibilityModulesType["increaseLineHeight"] = 5] = "increaseLineHeight";
+    AccessibilityModulesType[AccessibilityModulesType["decreaseLineHeight"] = 6] = "decreaseLineHeight";
+    AccessibilityModulesType[AccessibilityModulesType["invertColors"] = 7] = "invertColors";
+    AccessibilityModulesType[AccessibilityModulesType["grayHues"] = 8] = "grayHues";
+    AccessibilityModulesType[AccessibilityModulesType["bigCursor"] = 9] = "bigCursor";
+    AccessibilityModulesType[AccessibilityModulesType["readingGuide"] = 10] = "readingGuide";
+    AccessibilityModulesType[AccessibilityModulesType["underlineLinks"] = 11] = "underlineLinks";
+    AccessibilityModulesType[AccessibilityModulesType["textToSpeech"] = 12] = "textToSpeech";
+    AccessibilityModulesType[AccessibilityModulesType["speechToText"] = 13] = "speechToText";
+    AccessibilityModulesType[AccessibilityModulesType["disableAnimations"] = 14] = "disableAnimations";
+    AccessibilityModulesType[AccessibilityModulesType["iframeModals"] = 15] = "iframeModals";
+    AccessibilityModulesType[AccessibilityModulesType["customFunctions"] = 16] = "customFunctions";
+})(AccessibilityModulesType || (exports.AccessibilityModulesType = AccessibilityModulesType = {}));
+//# sourceMappingURL=accessibility.interface.js.map

package/dist-cjs/interfaces/accessibility.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessibility.interface.js","sourceRoot":"","sources":["../../src/interfaces/accessibility.interface.ts"],"names":[],"mappings":";;;AAuKA,IAAY,wBAiBX;AAjBD,WAAY,wBAAwB;IACnC,uFAAgB,CAAA;IAChB,uFAAgB,CAAA;IAChB,qGAAuB,CAAA;IACvB,qGAAuB,CAAA;IACvB,mGAAsB,CAAA;IACtB,mGAAsB,CAAA;IACtB,uFAAgB,CAAA;IAChB,+EAAY,CAAA;IACZ,iFAAa,CAAA;IACb,wFAAiB,CAAA;IACjB,4FAAmB,CAAA;IACnB,wFAAiB,CAAA;IACjB,wFAAiB,CAAA;IACjB,kGAAsB,CAAA;IACtB,wFAAiB,CAAA;IACjB,8FAAoB,CAAA;AACrB,CAAC,EAjBW,wBAAwB,wCAAxB,wBAAwB,QAiBnC"}

package/dist-cjs/interfaces/common.interface.d.ts

@@ -0,0 +1,39 @@
+export interface ICommon {
+    deployedObjects: IDeployedObjects;
+    isIOS(): boolean;
+    jsonToHtml(obj: IJsonToHtml): HTMLElement;
+    injectStyle(css: string, innerOptions?: IInjectStyleOptions): void;
+    getFormattedDim(value: string): IFormattedDim;
+    extend(src: any, dest: any): void;
+    injectIconsFont(urls: Array<string>, callback: Function): void;
+    getFixedFont(name: string): void;
+    getFixedPseudoFont(name: string): void;
+    isFontLoaded(fontFamily?: string, callback?: Function): void;
+    warn(msg: string): void;
+    createScreenshot(url: string): Promise<string>;
+    getFileExtension(filename: string): string;
+}
+export interface IJsonToHtml {
+    type: string;
+    attrs?: any;
+    children?: Array<IJsonToHtml>;
+    text?: string;
+}
+export interface IInjectStyleOptions {
+    className?: string;
+}
+export interface IFormattedDim {
+    size: string | number;
+    suffix: string;
+}
+export interface IUnitsDim {
+    size: string | number;
+    units: string;
+}
+export interface IDeployedObjects {
+    get(key: string): boolean;
+    contains(key: string): boolean;
+    set(key: string, val: boolean): void;
+    remove(key: string): void;
+    getAll(): Map<string, boolean>;
+}

package/dist-cjs/interfaces/common.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.interface.js.map

package/dist-cjs/interfaces/common.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.interface.js","sourceRoot":"","sources":["../../src/interfaces/common.interface.ts"],"names":[],"mappings":""}

package/dist-cjs/interfaces/menu.interface.d.ts

@@ -0,0 +1,18 @@
+export interface IMenuInterface {
+    increaseText(): void;
+    decreaseText(): void;
+    increaseTextSpacing(): void;
+    decreaseTextSpacing(): void;
+    invertColors(destroy?: boolean): void;
+    grayHues(destroy?: boolean): void;
+    underlineLinks(destroy?: boolean): void;
+    bigCursor(destroy?: boolean): void;
+    readingGuide(destroy?: boolean): void;
+    textToSpeech(destroy?: boolean): void;
+    speechToText(destroy?: boolean): void;
+    disableAnimations(destroy?: boolean): void;
+    iframeModals(destroy?: boolean, button?: HTMLElement): void;
+    customFunctions(destroy?: boolean, button?: HTMLElement): void;
+    increaseLineHeight(): void;
+    decreaseLineHeight(): void;
+}

package/dist-cjs/interfaces/menu.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=menu.interface.js.map

package/dist-cjs/interfaces/menu.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu.interface.js","sourceRoot":"","sources":["../../src/interfaces/menu.interface.ts"],"names":[],"mappings":""}

package/dist-cjs/main.d.ts

@@ -0,0 +1,84 @@
+import { Common } from './common.js';
+import { IAccessibility, IAccessibilityOptions, ISessionState, IStateValues } from './interfaces/accessibility.interface.js';
+import { IMenuInterface } from './interfaces/menu.interface.js';
+export declare class Accessibility implements IAccessibility {
+    static CSS_CLASS_NAME: string;
+    static MENU_WIDTH: string;
+    static MENU_ID: string;
+    static MENU_LABEL_ID: string;
+    private _isReading;
+    private _common;
+    private _storage;
+    private _options;
+    private _sessionState;
+    private _htmlInitFS;
+    private _body;
+    private _html;
+    private _icon;
+    private _menu;
+    private _htmlOrgFontSize;
+    private _stateValues;
+    private _recognition;
+    private _speechToTextTarget;
+    private _onKeyDownBind;
+    private _fixedDefaultFont;
+    menuInterface: IMenuInterface;
+    options: IAccessibilityOptions;
+    constructor(options?: IAccessibilityOptions);
+    private hasRemoteFontSources;
+    private shouldUseEmojiIcons;
+    get stateValues(): IStateValues;
+    set stateValues(value: IStateValues);
+    get html(): HTMLElement;
+    get body(): HTMLBodyElement;
+    get sessionState(): ISessionState;
+    set sessionState(value: ISessionState);
+    get common(): Common;
+    get recognition(): any;
+    get isReading(): boolean;
+    set isReading(value: boolean);
+    get fixedDefaultFont(): string;
+    private get defaultOptions();
+    initFontSize(): void;
+    fontFallback(): void;
+    addDefaultOptions(options: IAccessibilityOptions): void;
+    addModuleOrderIfNotDefined(): void;
+    disabledUnsupportedFeatures(): void;
+    injectCss(injectFull: boolean): void;
+    removeCSS(): void;
+    injectIcon(): HTMLElement;
+    parseKeys(arr: Array<any>): string;
+    private syncMenuState;
+    injectMenu(): HTMLElement;
+    getVoices(): Promise<SpeechSynthesisVoice[]>;
+    injectTts(): Promise<void>;
+    addListeners(): void;
+    sortModuleTypes(): void;
+    disableUnsupportedModulesAndSort(): void;
+    resetAll(): void;
+    resetTextSize(): void;
+    resetLineHeight(): void;
+    resetTextSpace(): void;
+    alterTextSize(isIncrease: boolean): void;
+    alterLineHeight(isIncrease: boolean): void;
+    alterTextSpace(isIncrease: boolean): void;
+    speechToText(): void;
+    textToSpeech(text: string): void;
+    createScreenShot(url: string): Promise<string>;
+    listen(e?: Event): void;
+    read(e?: Event): void;
+    runHotkey(name: string): void;
+    toggleMenu(): void;
+    invoke(action: string, button: HTMLElement): void;
+    onKeyDown(e: KeyboardEvent): void;
+    build(): void;
+    updateReadGuide(e: Event | TouchEvent | any): void;
+    resetIfDefined(src: string, dest: any, prop: string): void;
+    onChange(updateSession: boolean): void;
+    saveSession(): void;
+    setSessionFromCache(): void;
+    destroy(): void;
+}
+export * from './interfaces/accessibility.interface.js';
+export * from './interfaces/menu.interface.js';
+export default Accessibility;