@transferwise/components 46.5.0 → 46.6.0

package/src/withDisplayFormat/{WithDisplayFormat.js → WithDisplayFormat.tsx}

@@ -1,4 +1,3 @@
-import PropTypes from 'prop-types';
 import { Component } from 'react';
 
 import { HistoryNavigator } from '../common';
@@ -10,27 +9,93 @@ import {
   getDistanceToPreviousSymbol,
   getDistanceToNextSymbol,
 } from '../common/textFormat';
+import { InputProps } from '../inputs/Input';
+import { TextAreaProps } from '../inputs/TextArea';
+
+type HTMLTextElement = HTMLInputElement | HTMLTextAreaElement;
+type TextElementProps = InputProps | TextAreaProps;
+
+export type EventType =
+  | 'KeyDown'
+  | 'Paste'
+  | 'Cut'
+  | 'Undo'
+  | 'Redo'
+  | 'Backspace'
+  | 'Delete'
+  | 'Initial';
+
+interface WithDisplayFormatState {
+  value: string;
+  historyNavigator: HistoryNavigator;
+  prevDisplayPattern: string;
+  triggerType: EventType;
+  triggerEvent: React.KeyboardEvent<HTMLTextElement> | null;
+  pastedLength: number;
+  selectionStart: number;
+  selectionEnd: number;
+}
+
+export interface WithDisplayFormatProps<T extends TextElementProps = TextElementProps>
+  extends Pick<
+    TextElementProps,
+    | 'className'
+    | 'disabled'
+    | 'id'
+    | 'maxLength'
+    | 'minLength'
+    | 'name'
+    | 'placeholder'
+    | 'readOnly'
+    | 'required'
+    | 'inputMode'
+  > {
+  value?: string;
+  displayPattern: string;
+  /**
+   * autocomplete hides our form help so we need to disable it when help text
+   * is present. Chrome ignores autocomplete=off, the only way to disable it is
+   * to provide an 'invalid' value, for which 'disabled' serves.
+   */
+  autoComplete?: TextElementProps['autoComplete'] | 'disabled';
+  onChange?: (value: string) => void;
+  onBlur?: (value: string) => void;
+  onFocus?: (value: string) => void;
+  render: (renderProps: T) => JSX.Element;
+}
 
-class WithDisplayFormat extends Component {
-  constructor(props) {
+class WithDisplayFormat<T extends TextElementProps> extends Component<
+  WithDisplayFormatProps<T>,
+  WithDisplayFormatState
+> {
+  declare props: WithDisplayFormatProps<T> &
+    Required<Pick<WithDisplayFormatProps<T>, keyof typeof WithDisplayFormat.defaultProps>>;
+  static defaultProps = {
+    autoComplete: 'off',
+    displayPattern: '',
+    value: '',
+  };
+
+  constructor(props: WithDisplayFormatProps) {
     super(props);
-    const { value, displayPattern } = props;
-    const unformattedValue = unformatWithPattern(value, displayPattern);
+    const unformattedValue = unformatWithPattern(props.value ?? '', props.displayPattern);
     this.state = {
-      value: formatWithPattern(unformattedValue, displayPattern),
+      value: formatWithPattern(unformattedValue, props.displayPattern),
       historyNavigator: new HistoryNavigator(),
       prevDisplayPattern: props.displayPattern,
-      triggerType: null,
+      triggerType: 'Initial',
       triggerEvent: null,
+      selectionStart: 0,
+      selectionEnd: 0,
+      pastedLength: 0,
     };
   }
 
-  static getDerivedStateFromProps(nextProps, previousState) {
-    const { displayPattern } = nextProps;
-    const { prevDisplayPattern } = previousState;
-    if (previousState.prevDisplayPattern !== displayPattern) {
-      const { value, historyNavigator } = previousState;
-
+  static getDerivedStateFromProps(
+    { displayPattern }: WithDisplayFormatProps,
+    { prevDisplayPattern = displayPattern, value, historyNavigator }: WithDisplayFormatState,
+  ) {
+    if (prevDisplayPattern !== displayPattern) {
       const unFormattedValue = unformatWithPattern(value, prevDisplayPattern);
       historyNavigator.reset();
 
@@ -45,43 +110,48 @@ class WithDisplayFormat extends Component {
     return null;
   }
 
-  getUserAction = (unformattedValue) => {
+  getUserAction = (unformattedValue: string): EventType | string => {
     const { triggerEvent, triggerType, value } = this.state;
     const { displayPattern } = this.props;
 
-    const charCode = String.fromCharCode(triggerEvent.which).toLowerCase();
+    if (triggerEvent) {
+      const charCode = String.fromCharCode(triggerEvent.which).toLowerCase();
 
-    if (triggerType === 'Paste' || triggerType === 'Cut') {
-      return triggerType;
-    }
+      if (triggerType === 'Paste' || triggerType === 'Cut') {
+        return triggerType;
+      }
 
-    if ((triggerEvent.ctrlKey || triggerEvent.metaKey) && charCode === 'z') {
-      return triggerEvent.shiftKey ? 'Redo' : 'Undo';
-    }
-    // Detect mouse event redo
-    if (triggerEvent.ctrlKey && charCode === 'd') {
-      return 'Delete';
-    }
+      if ((triggerEvent.ctrlKey || triggerEvent.metaKey) && charCode === 'z') {
+        return triggerEvent.shiftKey ? 'Redo' : 'Undo';
+      }
+      // Detect mouse event redo
+      if (triggerEvent.ctrlKey && charCode === 'd') {
+        return 'Delete';
+      }
 
-    // Android Fix.
-    if (typeof triggerEvent.key === 'undefined') {
-      if (unformattedValue.length <= unformatWithPattern(value, displayPattern).length) {
+      // Android Fix.
+      if (
+        typeof triggerEvent.key === 'undefined' &&
+        unformattedValue.length <= unformatWithPattern(value, displayPattern).length
+      ) {
         return 'Backspace';
       }
+      return triggerEvent.key;
+    } else {
+      // triggerEvent can be null only in case of "autofilling" (via password manager extension or browser build-in one) events
+      return 'Paste';
     }
-
-    return triggerEvent.key;
   };
 
   resetEvent = () => {
     this.setState({
-      triggerType: null,
+      triggerType: 'Initial',
       triggerEvent: null,
       pastedLength: 0,
     });
   };
 
-  detectUndoRedo = (event) => {
+  detectUndoRedo = (event: React.KeyboardEvent<HTMLTextElement>) => {
     const charCode = String.fromCharCode(event.which).toLowerCase();
     if ((event.ctrlKey || event.metaKey) && charCode === 'z') {
       return event.shiftKey ? 'Redo' : 'Undo';
@@ -89,9 +159,9 @@ class WithDisplayFormat extends Component {
     return null;
   };
 
-  handleOnKeyDown = (event) => {
+  handleOnKeyDown: React.KeyboardEventHandler<HTMLTextElement> = (event) => {
     event.persist();
-    const { selectionStart, selectionEnd } = event.target;
+    const { selectionStart, selectionEnd } = event.currentTarget;
     const { historyNavigator } = this.state;
     const { displayPattern } = this.props;
 
@@ -108,13 +178,13 @@ class WithDisplayFormat extends Component {
       this.setState({
         triggerEvent: event,
         triggerType: 'KeyDown',
-        selectionStart,
-        selectionEnd,
+        selectionStart: selectionStart ?? 0,
+        selectionEnd: selectionEnd ?? 0,
       });
     }
   };
 
-  handleOnPaste = (event) => {
+  handleOnPaste: React.ClipboardEventHandler<HTMLTextElement> = (event) => {
     const { displayPattern } = this.props;
     const pastedLength = unformatWithPattern(
       event.clipboardData.getData('Text'),
@@ -124,27 +194,23 @@ class WithDisplayFormat extends Component {
     this.setState({ triggerType: 'Paste', pastedLength });
   };
 
-  handleOnCut = () => {
+  handleOnCut: React.ClipboardEventHandler<HTMLTextElement> = () => {
     this.setState({ triggerType: 'Cut' });
   };
 
-  isKeyAllowed = (action) => {
+  isKeyAllowed = (action: EventType | string) => {
     const { displayPattern } = this.props;
     const symbolsInPattern = displayPattern.split('').filter((character) => character !== '*');
 
     return !symbolsInPattern.includes(action);
   };
 
-  handleOnChange = (event) => {
-    const { historyNavigator, triggerEvent, triggerType } = this.state;
+  handleOnChange: React.ChangeEventHandler<HTMLTextElement> = (event) => {
+    const { historyNavigator, triggerType } = this.state;
     const { displayPattern, onChange } = this.props;
     const { value } = event.target;
     let unformattedValue = unformatWithPattern(value, displayPattern);
-    const action =
-      triggerEvent === null
-        ? // triggerEvent can be null only in case of "autofilling" (via password manager extension or browser build-in one) events
-          'Paste'
-        : this.getUserAction(unformattedValue);
+    const action = this.getUserAction(unformattedValue);
     if (!this.isKeyAllowed(action) || triggerType === 'Undo' || triggerType === 'Redo') {
       return;
     }
@@ -158,19 +224,20 @@ class WithDisplayFormat extends Component {
 
     this.handleCursorPositioning(action);
 
-    const broadcastValue = unformatWithPattern(newFormattedValue, displayPattern);
-
-    this.setState({ value: newFormattedValue }, this.resetEvent(), onChange(broadcastValue));
+    this.setState({ value: newFormattedValue }, () => {
+      this.resetEvent();
+      if (onChange) {
+        const broadcastValue = unformatWithPattern(newFormattedValue, displayPattern);
+        onChange(broadcastValue);
+      }
+    });
   };
 
-  handleOnBlur = (event) => {
-    const { displayPattern, onBlur } = this.props;
-    if (onBlur) {
-      onBlur(unformatWithPattern(event.target.value, displayPattern));
-    }
+  handleOnBlur: React.FocusEventHandler<HTMLTextElement> = (event) => {
+    this.props.onBlur?.(unformatWithPattern(event.target.value, this.props.displayPattern));
   };
 
-  handleOnFocus = (event) => {
+  handleOnFocus: React.FocusEventHandler<HTMLTextElement> = (event) => {
     const { displayPattern, onFocus } = this.props;
     if (onFocus) {
       this.handleOnChange(event);
@@ -178,7 +245,7 @@ class WithDisplayFormat extends Component {
     }
   };
 
-  handleDelete = (unformattedValue, action) => {
+  handleDelete = (unformattedValue: string, action: EventType) => {
     const { displayPattern } = this.props;
     const { selectionStart, selectionEnd } = this.state;
     const newStack = [...unformattedValue];
@@ -203,7 +270,7 @@ class WithDisplayFormat extends Component {
     return newStack.join('');
   };
 
-  handleCursorPositioning = (action) => {
+  handleCursorPositioning = (action: string) => {
     const { displayPattern } = this.props;
     const { triggerEvent, selectionStart, selectionEnd, pastedLength } = this.state;
 
@@ -217,7 +284,7 @@ class WithDisplayFormat extends Component {
 
     setTimeout(() => {
       if (triggerEvent) {
-        triggerEvent.target.setSelectionRange(cursorPosition, cursorPosition);
+        triggerEvent.currentTarget.setSelectionRange(cursorPosition, cursorPosition);
       }
       this.setState({ selectionStart: cursorPosition, selectionEnd: cursorPosition });
     }, 0);
@@ -225,7 +292,6 @@ class WithDisplayFormat extends Component {
 
   render() {
     const {
-      type,
       inputMode,
       className,
       id,
@@ -239,8 +305,7 @@ class WithDisplayFormat extends Component {
       autoComplete,
     } = this.props;
     const { value } = this.state;
-    const renderProps = {
-      type,
+    const renderProps: TextElementProps = {
       inputMode,
       className,
       id,
@@ -260,53 +325,8 @@ class WithDisplayFormat extends Component {
       onChange: this.handleOnChange,
       onCut: this.handleOnCut,
     };
-    return this.props.render(renderProps);
+    return this.props.render(renderProps as T);
   }
 }
 
-WithDisplayFormat.propTypes = {
-  /**
-   * autocomplete hides our form help so we need to disable it when help text
-   * is present. Chrome ignores autocomplete=off, the only way to disable it is
-   * to provide an 'invalid' value, for which 'disabled' serves.
-   */
-  autoComplete: PropTypes.oneOf(['on', 'off', 'disabled']),
-  className: PropTypes.string,
-  disabled: PropTypes.bool,
-  id: PropTypes.string,
-  maxLength: PropTypes.number,
-  minLength: PropTypes.number,
-  name: PropTypes.string,
-  onFocus: PropTypes.func,
-  onBlur: PropTypes.func,
-  onChange: PropTypes.func.isRequired,
-  placeholder: PropTypes.string,
-  readOnly: PropTypes.bool,
-  render: PropTypes.func.isRequired,
-  required: PropTypes.bool,
-  displayPattern: PropTypes.string,
-  type: PropTypes.string,
-  inputMode: PropTypes.string,
-  value: PropTypes.string,
-};
-
-WithDisplayFormat.defaultProps = {
-  autoComplete: 'off',
-  className: null,
-  disabled: false,
-  id: null,
-  maxLength: null,
-  minLength: null,
-  name: null,
-  placeholder: null,
-  readOnly: false,
-  required: false,
-  displayPattern: '',
-  type: 'text',
-  inputMode: null,
-  value: '',
-  onFocus: null,
-  onBlur: null,
-};
-
 export default WithDisplayFormat;

package/src/withDisplayFormat/index.ts

@@ -0,0 +1,2 @@
+export { default } from './WithDisplayFormat';
+export type { WithDisplayFormatProps } from './WithDisplayFormat';

package/src/inputWithDisplayFormat/InputWithDisplayFormat.js

@@ -1,14 +0,0 @@
-import PropTypes from 'prop-types';
-
-import WithDisplayFormat from '../withDisplayFormat';
-
-const InputWithDisplayFormat = (props) => (
-  <WithDisplayFormat {...props} render={(renderProps) => <input {...renderProps} />} />
-);
-
-InputWithDisplayFormat.propTypes = {
-  displayPattern: PropTypes.string.isRequired,
-  onChange: PropTypes.func.isRequired,
-};
-
-export default InputWithDisplayFormat;

package/src/inputWithDisplayFormat/index.js

@@ -1 +0,0 @@
-export { default } from './InputWithDisplayFormat';

package/src/textareaWithDisplayFormat/TextareaWithDisplayFormat.js

@@ -1,14 +0,0 @@
-import PropTypes from 'prop-types';
-
-import WithDisplayFormat from '../withDisplayFormat';
-
-const TextareaWithDisplayFormat = (props) => (
-  <WithDisplayFormat {...props} render={(renderProps) => <textarea {...renderProps} />} />
-);
-
-TextareaWithDisplayFormat.propTypes = {
-  displayPattern: PropTypes.string.isRequired,
-  onChange: PropTypes.func.isRequired,
-};
-
-export default TextareaWithDisplayFormat;

package/src/textareaWithDisplayFormat/index.js

@@ -1 +0,0 @@
-export { default } from './TextareaWithDisplayFormat';

package/src/withDisplayFormat/index.js

@@ -1 +0,0 @@
-export { default } from './WithDisplayFormat';