@react-native-ama/core 1.2.1 → 2.0.0-beta.0

package/dist/internals/utils/amaHighlightComponent.js

@@ -0,0 +1,51 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.amaHighlightComponent = void 0;
+const ReactNativeAmaModule_1 = __importDefault(require("../../ReactNativeAmaModule"));
+const config_1 = __importDefault(require("../config"));
+const rules_1 = require("./rules");
+// Severity priority: Critical > Serious > Warning
+const SEVERITY_PRIORITY = {
+    Critical: 3,
+    Serious: 2,
+    Warning: 1,
+};
+const getHighestSeverityColor = (issues) => {
+    var _a, _b;
+    let highestPriority = 0;
+    let highestSeverity = 'Warning';
+    for (const issue of issues) {
+        const severity = (_b = (_a = rules_1.RULES_HELP === null || rules_1.RULES_HELP === void 0 ? void 0 : rules_1.RULES_HELP[issue.rule]) === null || _a === void 0 ? void 0 : _a.severity) !== null && _b !== void 0 ? _b : 'Critical';
+        const priority = SEVERITY_PRIORITY[severity];
+        if (priority > highestPriority) {
+            highestPriority = priority;
+            highestSeverity = severity;
+        }
+    }
+    return rules_1.AMA_COLORS[highestSeverity];
+};
+exports.amaHighlightComponent = __DEV__
+    ? (issues, mode) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b;
+        const issuesArray = Array.isArray(issues) ? issues : [issues];
+        if (issuesArray.length === 0) {
+            return null;
+        }
+        const viewId = issuesArray[0].viewId;
+        const color = getHighestSeverityColor(issuesArray);
+        const issueCount = issuesArray.length;
+        return ReactNativeAmaModule_1.default.highlight(viewId, (_b = mode !== null && mode !== void 0 ? mode : (_a = config_1.default.highlight) === null || _a === void 0 ? void 0 : _a.mode) !== null && _b !== void 0 ? _b : 'both', color, issueCount);
+    })
+    : null;

package/dist/internals/utils/constants.d.ts

@@ -0,0 +1,3 @@
+import type { ViewStyle } from 'react-native';
+export type MotionAnimationKey = Partial<keyof ViewStyle> | 'scale';
+export declare const MOTION_ANIMATIONS: MotionAnimationKey[];

package/dist/internals/utils/constants.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MOTION_ANIMATIONS = void 0;
+exports.MOTION_ANIMATIONS = [
+    'left',
+    'bottom',
+    'top',
+    'right',
+    'transform',
+    'translateX',
+    'translateY',
+    'scaleX',
+    'scaleY',
+    'scale',
+    'width',
+    'height',
+    'padding',
+    'paddingBottom',
+    'paddingLeft',
+    'paddingRight',
+    'paddingTop',
+    'paddingVertical',
+    'paddingHorizontal',
+    'margin',
+    'marginBottom',
+    'marginLeft',
+    'marginRight',
+    'marginTop',
+    'marginHorizontal',
+    'marginVertical',
+    'rotation',
+];

package/dist/internals/utils/getErrorColor.d.ts

@@ -0,0 +1,2 @@
+import { AmaRule } from '../types';
+export declare const getErrorColor: (rule: AmaRule) => string;

package/dist/internals/utils/getErrorColor.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorColor = void 0;
+const rules_1 = require("./rules");
+const getErrorColor = (rule) => {
+    var _a;
+    const theRule = rules_1.RULES_HELP === null || rules_1.RULES_HELP === void 0 ? void 0 : rules_1.RULES_HELP[rule];
+    return rules_1.AMA_COLORS[(_a = theRule === null || theRule === void 0 ? void 0 : theRule.severity) !== null && _a !== void 0 ? _a : 'Critical'];
+};
+exports.getErrorColor = getErrorColor;

package/dist/internals/utils/getRuleAction.d.ts

@@ -0,0 +1,2 @@
+import { AmaRule, AmaRuleAction } from '../types';
+export declare const getRuleAction: ((rule: AmaRule) => AmaRuleAction) | null;

package/dist/internals/utils/getRuleAction.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRuleAction = void 0;
+const config_1 = __importDefault(require("../config"));
+const rules_1 = __importStar(require("./rules"));
+exports.getRuleAction = __DEV__
+    ? (rule) => {
+        var _a;
+        const customRule = (rules_1.default === null || rules_1.default === void 0 ? void 0 : (0, rules_1.default)(rule))
+            ? (_a = config_1.default === null || config_1.default === void 0 ? void 0 : config_1.default.rules) === null || _a === void 0 ? void 0 : _a[rule]
+            : undefined;
+        return customRule || rules_1.LOGGER_RULES[rule];
+    }
+    : null;

package/dist/internals/utils/getRuleErrorInfo.d.ts

@@ -0,0 +1,7 @@
+import { AmaError } from '../types';
+export type A11ySeverity = 'Serious' | 'Critical' | 'Warning';
+export declare const getAMARuleErrorInfo: ((issue: AmaError) => {
+    message: string;
+    url: string;
+    severity: import("./rules").A11ySeverity;
+}) | null;

package/dist/internals/utils/getRuleErrorInfo.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAMARuleErrorInfo = void 0;
+const rules_1 = require("./rules");
+exports.getAMARuleErrorInfo = __DEV__
+    ? (issue) => {
+        const ruleHelp = rules_1.RULES_HELP[issue.rule];
+        if (!ruleHelp) {
+            console.error(`Missing rule help: ${issue.rule}`);
+            throw new Error(`Missing rule help: ${issue.rule}`);
+        }
+        let message = ruleHelp.message;
+        if (issue.extra) {
+            message += ': ' + issue.extra;
+        }
+        const url = `https://nearform.com/open-source/react-native-ama/${ruleHelp.url}`;
+        return { message, url, severity: ruleHelp.severity };
+    }
+    : null;

package/dist/internals/utils/ignoreContrastCheck.d.ts

@@ -0,0 +1 @@
+export declare const shouldIgnoreContrastCheckForDisabledElement: (() => false | import("./rules").AmaRuleAction) | null;

package/dist/internals/utils/ignoreContrastCheck.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldIgnoreContrastCheckForDisabledElement = void 0;
+const config_1 = __importDefault(require("../config"));
+const rules_1 = require("./rules");
+exports.shouldIgnoreContrastCheckForDisabledElement = __DEV__
+    ? () => {
+        var _a;
+        return (((_a = config_1.default === null || config_1.default === void 0 ? void 0 : config_1.default.rules) === null || _a === void 0 ? void 0 : _a.IGNORE_CONTRAST_FOR_DISABLED_ELEMENTS) ||
+            rules_1.IGNORE_CONTRAST_FOR_DISABLED_ELEMENTS);
+    }
+    : null;

package/dist/internals/utils/interpolateAnimationStates.d.ts

@@ -0,0 +1,2 @@
+import type { Animated } from 'react-native';
+export declare const interpolateAnimationStates: (from: Record<string, any>, to: Record<string, any>, isReduceMotionEnabled: boolean, progressValue: Animated.Value, reduceMotionProgressValue: Animated.Value) => Record<string, any>;

package/dist/internals/utils/interpolateAnimationStates.js

@@ -0,0 +1,43 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interpolateAnimationStates = void 0;
+const constants_1 = require("./constants");
+const interpolateAnimationStates = (from, to, isReduceMotionEnabled, progressValue, reduceMotionProgressValue) => {
+    return Object.keys(from).reduce((outputAnimation, key) => {
+        const isMotionAnimation = constants_1.MOTION_ANIMATIONS.includes(key);
+        const progressKey = isReduceMotionEnabled && isMotionAnimation
+            ? reduceMotionProgressValue
+            : progressValue;
+        if (Array.isArray(from[key])) {
+            outputAnimation[key] = from[key].map((animationObject, index) => {
+                const _a = (0, exports.interpolateAnimationStates)(animationObject, to[key][index], isReduceMotionEnabled, progressValue, reduceMotionProgressValue), { __hasOnlyMotionAnimation } = _a, style = __rest(_a, ["__hasOnlyMotionAnimation"]);
+                outputAnimation.__hasOnlyMotionAnimation =
+                    outputAnimation.__hasOnlyMotionAnimation &&
+                        __hasOnlyMotionAnimation;
+                return style;
+            });
+        }
+        else {
+            outputAnimation[key] = progressKey.interpolate({
+                inputRange: [0, 1],
+                // @ts-ignore
+                outputRange: [from[key], to[key]],
+            });
+            outputAnimation.__hasOnlyMotionAnimation =
+                outputAnimation.__hasOnlyMotionAnimation && isMotionAnimation;
+        }
+        return outputAnimation;
+    }, { __hasOnlyMotionAnimation: true });
+};
+exports.interpolateAnimationStates = interpolateAnimationStates;

package/dist/internals/utils/isA11yLabelAllowed.d.ts

@@ -0,0 +1 @@
+export declare const isAccessibilityLabelAllowed: ((accessibilityLabel: string) => boolean) | null;

package/dist/internals/utils/isA11yLabelAllowed.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAccessibilityLabelAllowed = void 0;
+const config_1 = __importDefault(require("../config"));
+exports.isAccessibilityLabelAllowed = __DEV__
+    ? (accessibilityLabel) => {
+        var _a;
+        return (accessibilityLabel.length < config_1.default.uppercaseMinLength ||
+            ((_a = config_1.default === null || config_1.default === void 0 ? void 0 : config_1.default.accessibilityLabelExceptions) === null || _a === void 0 ? void 0 : _a.includes(accessibilityLabel)));
+    }
+    : null;

package/dist/internals/utils/isRuleDisabled.d.ts

@@ -0,0 +1,2 @@
+import { AmaError } from '../types';
+export declare const isRuleDisabled: ((error: AmaError) => boolean | undefined) | null;

package/dist/internals/utils/isRuleDisabled.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRuleDisabled = void 0;
+const getRuleAction_1 = require("./getRuleAction");
+exports.isRuleDisabled = __DEV__
+    ? (error) => {
+        const action = getRuleAction_1.getRuleAction === null || getRuleAction_1.getRuleAction === void 0 ? void 0 : (0, getRuleAction_1.getRuleAction)(error.rule);
+        return action && action === 'PLEASE_FORGIVE_ME';
+    }
+    : null;

package/dist/internals/utils/logError.d.ts

@@ -0,0 +1,2 @@
+import { AmaError } from '../types';
+export declare const logError: ((issue: AmaError) => void) | null;

package/dist/internals/utils/logError.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logError = void 0;
+const getRuleAction_1 = require("./getRuleAction");
+const logger_1 = __importDefault(require("./logger"));
+const rules_1 = require("./rules");
+const getAMARuleErrorInfo = __DEV__
+    ? ({ rule, extra }) => {
+        const ruleHelp = rules_1.RULES_HELP[rule];
+        let message = ruleHelp.message;
+        if (extra) {
+            message += ': ' + extra;
+        }
+        const url = `https://nearform.com/open-source/react-native-ama/${ruleHelp.url}`;
+        return { message, url, severity: ruleHelp.severity };
+    }
+    : null;
+exports.logError = __DEV__
+    ? (issue) => {
+        var _a;
+        const action = getRuleAction_1.getRuleAction === null || getRuleAction_1.getRuleAction === void 0 ? void 0 : (0, getRuleAction_1.getRuleAction)(issue.rule);
+        const log = action === 'MUST' || action === 'MUST_NOT'
+            ? logger_1.default === null || logger_1.default === void 0 ? void 0 : logger_1.default.error
+            : logger_1.default === null || logger_1.default === void 0 ? void 0 : logger_1.default.warn;
+        const { message, url } = (_a = getAMARuleErrorInfo === null || getAMARuleErrorInfo === void 0 ? void 0 : getAMARuleErrorInfo(issue)) !== null && _a !== void 0 ? _a : {};
+        log === null || log === void 0 ? void 0 : log(`${issue.rule}
+        Component: ${issue.label || '--- NO LABEL FOUND ---'} (#${issue.viewId})
+
+        ${message}
+
+        Learn about: ${url}\n`);
+    }
+    : null;

package/dist/internals/utils/logFoundIssues.d.ts

@@ -0,0 +1,2 @@
+import { AmaError } from '../types';
+export declare const logFoundIssues: ((issues: AmaError[]) => void) | null;

package/dist/internals/utils/logFoundIssues.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logFoundIssues = void 0;
+const config_1 = __importDefault(require("../config"));
+const logError_1 = require("./logError");
+const logger_1 = __importDefault(require("./logger"));
+exports.logFoundIssues = __DEV__
+    ? (issues) => {
+        if (issues.length === 0) {
+            return;
+        }
+        logger_1.default === null || logger_1.default === void 0 ? void 0 : logger_1.default.log(`Issues found: ${issues.length}`);
+        if (config_1.default.log !== 'always') {
+            return;
+        }
+        issues.forEach((issue) => {
+            logError_1.logError === null || logError_1.logError === void 0 ? void 0 : (0, logError_1.logError)(issue);
+        });
+    }
+    : null;

package/dist/internals/utils/logger.d.ts

@@ -0,0 +1,6 @@
+declare const logger: {
+    log: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string) => void;
+} | null;
+export default logger;

package/dist/internals/utils/logger.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _log = __DEV__
+    ? (consoleMethod, msg) => {
+        consoleMethod(`[React Native AMA]: ${msg}`);
+    }
+    : null;
+const logger = _log
+    ? {
+        log: (msg) => _log(console.debug, msg),
+        warn: (msg) => _log(console.warn, msg),
+        error: (msg) => _log(console.error, msg),
+    }
+    : null;
+exports.default = logger;

package/dist/internals/utils/minimumTouchableSize.d.ts

@@ -0,0 +1 @@
+export declare const MINIMUM_TOUCHABLE_SIZE: number;

package/dist/internals/utils/minimumTouchableSize.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MINIMUM_TOUCHABLE_SIZE = void 0;
+const react_native_1 = require("react-native");
+const ANDROID_MINIMUM_TOUCHABLE_SIZE = 48;
+const IOS_MINIMUM_TOUCHABLE_SIZE = 44;
+exports.MINIMUM_TOUCHABLE_SIZE = react_native_1.Platform.OS === 'android'
+    ? ANDROID_MINIMUM_TOUCHABLE_SIZE
+    : IOS_MINIMUM_TOUCHABLE_SIZE;

package/dist/internals/utils/platformHelpers.d.ts

@@ -0,0 +1,2 @@
+export declare const IS_IOS: boolean;
+export declare const IS_ANDROID: boolean;

package/dist/internals/utils/platformHelpers.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IS_ANDROID = exports.IS_IOS = void 0;
+const react_native_1 = require("react-native");
+exports.IS_IOS = react_native_1.Platform.OS === 'ios';
+exports.IS_ANDROID = react_native_1.Platform.OS === 'android';

package/dist/internals/utils/rules.d.ts

@@ -0,0 +1,22 @@
+export type AmaRule = 'BOTTOM_SHEET_CLOSE_ACTION' | 'CONTRAST_FAILED' | 'CONTRAST_FAILED_AAA' | 'FLATLIST_NO_COUNT_IN_PLURAL_MESSAGE' | 'FLATLIST_NO_COUNT_IN_SINGULAR_MESSAGE' | 'IMAGE_MISSING_ALT_TEXT' | 'MINIMUM_SIZE' | 'NO_ACCESSIBILITY_LABEL' | 'NO_ACCESSIBILITY_ROLE' | 'NO_FORM_ERROR' | 'INPUT_HAS_NO_VISIBLE_LABEL' | 'NO_KEYBOARD_TRAP' | 'NO_UNDEFINED' | 'NO_UPPERCASE_TEXT' | 'INCOMPATIBLE_ACCESSIBILITY_STATE' | 'INCOMPATIBLE_ACCESSIBILITY_ROLE' | 'INPUT_HAS_NO_VISIBLE_LABEL_ENDING_WITH_ASTERISK' | 'UPPERCASE_TEXT_NO_ACCESSIBILITY_LABEL' | 'NO_UPPERCASE_ACCESSIBILITY_LABEL' | 'NO_HEADER_FOUND' | 'NO_ACCESSIBILITY_STATE_SET' | 'INPUT_INVALID_RETURN_KEY' | 'INPUT_HAS_FOCUSABLE_LABEL' | 'LONG_NUMBER_NOT_FORMATTED';
+export type AmaRuleAction = 'SHOULD_NOT' | 'MUST_NOT' | 'MUST' | 'SHOULD' | 'PLEASE_FORGIVE_ME';
+export declare const NON_OVERRIDABLE_RULES: Array<AmaRule> | undefined;
+export declare const LOGGER_RULES: Record<AmaRule, AmaRuleAction> | null;
+export declare const CONTRAST_CHECKER_MAX_DEPTH = 5;
+export declare const IGNORE_CONTRAST_FOR_DISABLED_ELEMENTS = false;
+export type A11ySeverity = 'Serious' | 'Critical' | 'Warning';
+export type RuleHelp = {
+    [key in AmaRule]: {
+        url: string;
+        issue: string;
+        severity: A11ySeverity;
+        message: string;
+        howToFix: string | string[];
+    };
+};
+export declare const RULES_HELP: RuleHelp | null;
+declare const canRuleBeOverridden: ((rule: AmaRule) => boolean) | null;
+export declare const AMA_COLORS: {
+    [key in A11ySeverity]: string;
+};
+export default canRuleBeOverridden;