react-native-reanimated/src/css/utils/guards.ts

More powerful alternative to Animated library for React Native.

'use strict';
import {
  ANIMATION_PROPS,
  TRANSITION_PROPS,
  VALID_PARAMETRIZED_TIMING_FUNCTIONS,
  VALID_PREDEFINED_TIMING_FUNCTIONS,
  VALID_STEPS_MODIFIERS,
} from '../constants';
import type { PredefinedTimingFunction, StepsModifier } from '../easings/types';
import type {
  AnyRecord,
  CSSAnimationKeyframes,
  CSSAnimationProp,
  CSSKeyframesRule,
  CSSStyleProp,
  CSSTransitionProp,
  Repeat,
  TimeUnit,
} from '../types';
import type { ConfigPropertyAlias } from '../types/config';

const ANIMATION_PROPS_SET = new Set<string>(ANIMATION_PROPS);
const TRANSITION_PROPS_SET = new Set<string>(TRANSITION_PROPS);
const VALID_STEPS_MODIFIERS_SET = new Set<string>(VALID_STEPS_MODIFIERS);

const VALID_PREDEFINED_TIMING_FUNCTIONS_SET = new Set<string>(
  VALID_PREDEFINED_TIMING_FUNCTIONS
);

const VALID_PARAMETRIZED_TIMING_FUNCTIONS_SET = new Set<string>(
  VALID_PARAMETRIZED_TIMING_FUNCTIONS
);

export const isPredefinedTimingFunction = (
  value: string
): value is PredefinedTimingFunction =>
  VALID_PREDEFINED_TIMING_FUNCTIONS_SET.has(value);

export const smellsLikeTimingFunction = (value: string) =>
  VALID_PREDEFINED_TIMING_FUNCTIONS_SET.has(value) ||
  VALID_PARAMETRIZED_TIMING_FUNCTIONS_SET.has(value.split('(')[0].trim());

export const isAnimationProp = (key: string): key is CSSAnimationProp =>
  ANIMATION_PROPS_SET.has(key);

export const isTransitionProp = (key: string): key is CSSTransitionProp =>
  TRANSITION_PROPS_SET.has(key);

export const isStepsModifier = (value: string): value is StepsModifier =>
  VALID_STEPS_MODIFIERS_SET.has(value);

export const isCSSStyleProp = (key: string): key is CSSStyleProp =>
  isTransitionProp(key) || isAnimationProp(key);

export const isTimeUnit = (value: unknown): value is TimeUnit =>
  // TODO: implement more strict check
  typeof value === 'string' &&
  (/^-?(\d+)?(\.\d+)?(ms|s)$/.test(value) || value === '0');

export const isNumber = (value: unknown): value is number =>
  typeof value === 'number' && !isNaN(value);

export const isPercentage = (value: string | number): value is `${number}%` =>
  typeof value === 'string' && /^-?\d+(\.\d+)?%$/.test(value);

export const isAngleValue = (
  value: string | number
): value is `${number}deg` | `${number}rad` =>
  typeof value === 'string' && /^-?\d+(\.\d+)?(deg|rad)$/.test(value);

export const isDefined = <T>(value: T): value is NonNullable<T> =>
  value !== undefined && value !== null;

export const isRecord = <T extends AnyRecord = AnyRecord>(
  value: unknown
): value is T =>
  typeof value === 'object' && value !== null && !Array.isArray(value);

export const isNumberArray = (value: unknown): value is number[] =>
  Array.isArray(value) && value.every(isNumber);

export const isArrayOfLength = <T, L extends number>(
  value: T[],
  length: L
): value is Repeat<T, L> => Array.isArray(value) && value.length === length;

export const isCSSKeyframesObject = (
  value: object
): value is CSSAnimationKeyframes =>
  typeof value === 'object' && Object.keys(value).length > 0;

export const isCSSKeyframesRule = (value: object): value is CSSKeyframesRule =>
  typeof value === 'object' && 'cssRules' in value && 'cssText' in value;

export const isConfigPropertyAlias = <P extends AnyRecord>(
  value: unknown
): value is ConfigPropertyAlias<P> =>
  !!value &&
  typeof value === 'object' &&
  'as' in value &&
  typeof value.as === 'string';

export const hasProp = <P extends AnyRecord, K extends string>(
  obj: P,
  key: K
): obj is P & Record<K, string> => key in obj;