@transferwise/components 46.10.1 → 46.12.0

package/README.md

@@ -1,6 +1,6 @@
 [![ci-cd](https://github.com/transferwise/neptune-web/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/transferwise/neptune-web/actions) [![NPM](https://badge.fury.io/js/%40transferwise%2Fcomponents.svg)](https://www.npmjs.com/package/@transferwise/components)
 
-# Neptune Web React Components Temp
+# Neptune Web React Components
 
 Neptune is the Design System built by and used at TransferWise. Neptune Web is the Neptune framework for Web. Neptune Web provides a way to build high quality, consistent user experiences on the web with ease.
 
@@ -48,6 +48,19 @@ Note: types for some of components are not 100% accurate (some of them will be j
 
 Please follow [rules for JS components](https://github.com/transferwise/neptune-web/blob/main/packages/components/CONTRIBUTING.md#js-component-rules) in order to generate accurate types for them.
 
+### Mocks for testing
+
+We expose reusable mocks for Jest and Vitest under an isolated entry point. They can be applied by passing the testing framework as the parameter:
+
+```ts
+import { mockMatchMedia, mockResizeObserver } from '@transferwise/components/mocks';
+import { jest } from '@jest/globals';
+import { vi } from 'vitest';
+
+mockMatchMedia(jest); // With Jest
+mockResizeObserver(vi); // With Vitest
+```
+
 ## Documentation
 
 Visit the [docs](https://transferwise.github.io/neptune-web/about/Home) for information on getting started, usage information and examples for each component.

package/build/i18n/zh-HK.json

@@ -4,10 +4,10 @@
   "neptune.ClearButton.ariaLabel": "清除",
   "neptune.CloseButton.ariaLabel": "關閉",
   "neptune.DateInput.day.label": "日",
-  "neptune.DateInput.day.placeholder": "日",
+  "neptune.DateInput.day.placeholder": "DD",
   "neptune.DateInput.month.label": "月",
   "neptune.DateInput.year.label": "年",
-  "neptune.DateInput.year.placeholder": "年",
+  "neptune.DateInput.year.placeholder": "YYYY",
   "neptune.DateLookup.day": "日",
   "neptune.DateLookup.goTo20YearView": "切換至20年視圖",
   "neptune.DateLookup.month": "月",

package/build/index.esm.js

@@ -12210,8 +12210,10 @@ const TextareaWithDisplayFormat = props => /*#__PURE__*/jsx(WithDisplayFormat, {
 /* eslint-disable jsx-a11y/no-static-element-interactions */
 const DEFAULT_INPUT_MIN_WIDTH = 10;
 class TypeaheadInput extends Component {
-  constructor() {
-    super();
+  inputRef = /*#__PURE__*/createRef();
+  sizerRef = /*#__PURE__*/createRef();
+  constructor(props) {
+    super(props);
     this.state = {
       inputWidth: DEFAULT_INPUT_MIN_WIDTH
     };
@@ -12221,7 +12223,7 @@ class TypeaheadInput extends Component {
       autoFocus
     } = this.props;
     if (autoFocus) {
-      this.inputRef.focus();
+      this.inputRef.current?.focus();
     }
   }
   componentDidUpdate(previousProps) {
@@ -12232,7 +12234,7 @@ class TypeaheadInput extends Component {
   recalculateWidth = () => {
     requestAnimationFrame(() => {
       this.setState({
-        inputWidth: Math.max(DEFAULT_INPUT_MIN_WIDTH, this.sizerRef.scrollWidth + 10)
+        inputWidth: Math.max(DEFAULT_INPUT_MIN_WIDTH, this.sizerRef.current?.scrollWidth ?? 0 + 10)
       });
     });
   };
@@ -12257,9 +12259,7 @@ class TypeaheadInput extends Component {
     } = this.state;
     const hasPlaceholder = !multiple || selected.length === 0;
     return /*#__PURE__*/jsx(Input, {
-      ref: reference => {
-        this.inputRef = reference;
-      },
+      ref: this.inputRef,
       className: classNames(multiple && 'typeahead__input'),
       name: name,
       id: `input-${typeaheadId}`,
@@ -12292,11 +12292,11 @@ class TypeaheadInput extends Component {
     } = this.props;
     return multiple ? /*#__PURE__*/jsxs("div", {
       className: "form-control typeahead__input-container",
-      style: maxHeight && {
+      style: {
         maxHeight
       },
       onClick: () => {
-        this.inputRef.focus();
+        this.inputRef.current?.focus();
       },
       children: [/*#__PURE__*/jsxs("div", {
         className: "typeahead__input-wrapper",
@@ -12304,39 +12304,13 @@ class TypeaheadInput extends Component {
           className: "typeahead__input-aligner"
         })]
       }), /*#__PURE__*/jsx("div", {
-        ref: reference => {
-          this.sizerRef = reference;
-        },
+        ref: this.sizerRef,
         className: "sizer form-control typeahead__input",
         children: value
       })]
     }) : this.renderInput();
   }
 }
-TypeaheadInput.propTypes = {
-  typeaheadId: PropTypes.string.isRequired,
-  name: PropTypes.string.isRequired,
-  autoFocus: PropTypes.bool,
-  multiple: PropTypes.bool.isRequired,
-  value: PropTypes.string.isRequired,
-  selected: PropTypes.arrayOf(PropTypes.object),
-  placeholder: PropTypes.string,
-  optionsShown: PropTypes.bool,
-  maxHeight: PropTypes.number,
-  autoComplete: PropTypes.string.isRequired,
-  onChange: PropTypes.func.isRequired,
-  renderChip: PropTypes.func.isRequired,
-  onKeyDown: PropTypes.func.isRequired,
-  onFocus: PropTypes.func.isRequired,
-  onPaste: PropTypes.func.isRequired
-};
-TypeaheadInput.defaultProps = {
-  autoFocus: false,
-  maxHeight: null,
-  placeholder: '',
-  optionsShown: false,
-  selected: []
-};
 
 function highlight(value, query) {
   if (value && query) {
@@ -12357,9 +12331,9 @@ function highlight(value, query) {
 const Option = props => {
   const {
     option,
-    selected,
-    onClick,
-    query
+    selected = false,
+    onClick = () => {},
+    query = ''
   } = props;
   const {
     label,
@@ -12389,46 +12363,48 @@ const Option = props => {
     })
   });
 };
-Option.propTypes = {
-  option: PropTypes.shape({
-    label: PropTypes.string.isRequired,
-    note: PropTypes.string,
-    secondary: PropTypes.string
-  }).isRequired,
-  query: PropTypes.string,
-  selected: PropTypes.bool,
-  onClick: PropTypes.func
-};
-Option.defaultProps = {
-  selected: false,
-  query: '',
-  onClick: () => {}
-};
-var TypeaheadOption = Option;
 
 /* eslint-disable jsx-a11y/anchor-is-valid */
 /* eslint-disable jsx-a11y/click-events-have-key-events */
 /* eslint-disable jsx-a11y/no-static-element-interactions */
-
 const DEFAULT_MIN_QUERY_LENGTH = 3;
 const SEARCH_DELAY = 200;
 class Typeahead extends Component {
+  static defaultProps = {
+    allowNew: false,
+    autoFillOnBlur: true,
+    autoFocus: false,
+    chipSeparators: [],
+    clearable: true,
+    initialValue: [],
+    inputAutoComplete: 'new-password',
+    minQueryLength: DEFAULT_MIN_QUERY_LENGTH,
+    multiple: false,
+    searchDelay: SEARCH_DELAY,
+    showSuggestions: true,
+    showNewEntry: true,
+    size: Size.MEDIUM,
+    validateChip: () => true
+  };
   constructor(props) {
     super(props);
     const {
       searchDelay,
       initialValue,
       multiple
-    } = props;
+    } = this.props;
     this.handleSearchDebounced = debounce(this.handleSearch, searchDelay);
     const initialQuery = !multiple && initialValue.length > 0 ? initialValue[0].label : '';
     this.state = {
       selected: initialValue,
       errorState: false,
       query: initialQuery,
-      keyboardFocusedOptionIndex: null
+      keyboardFocusedOptionIndex: null,
+      optionsShown: false,
+      isFocused: false
     };
   }
+  handleSearchDebounced;
   UNSAFE_componentWillReceiveProps(nextProps) {
     if (nextProps.multiple !== this.props.multiple) {
       this.setState(previousState => {
@@ -12442,6 +12418,7 @@ class Typeahead extends Component {
           };
         }
         return {
+          selected: previousState.selected,
           query: ''
         };
       });
@@ -12451,13 +12428,8 @@ class Typeahead extends Component {
     this.handleSearchDebounced.cancel();
   }
   handleOnFocus = () => {
-    const {
-      onFocus
-    } = this.props;
     this.showMenu();
-    if (onFocus) {
-      this.props.onFocus();
-    }
+    this.props.onFocus?.();
   };
   onOptionSelected = (event, item) => {
     event.preventDefault();
@@ -12540,7 +12512,7 @@ class Typeahead extends Component {
           break;
         case 'Enter':
           event.preventDefault();
-          if (options[keyboardFocusedOptionIndex]) {
+          if (keyboardFocusedOptionIndex != null && options[keyboardFocusedOptionIndex]) {
             this.selectItem(options[keyboardFocusedOptionIndex]);
           } else if (allowNew && query.trim()) {
             this.selectItem({
@@ -12592,13 +12564,6 @@ class Typeahead extends Component {
       query
     });
   };
-  stopPropagation = event => {
-    event.stopPropagation();
-    event.preventDefault();
-    if (event.nativeEvent && event.nativeEvent.stopImmediatePropagation) {
-      event.nativeEvent.stopImmediatePropagation();
-    }
-  };
   handleSearch = query => {
     const {
       onSearch
@@ -12683,7 +12648,7 @@ class Typeahead extends Component {
     }
   };
   renderChip = (option, idx) => {
-    const valid = this.props.validateChip(option);
+    const valid = this.props.validateChip?.(option);
     return /*#__PURE__*/jsx(Chip, {
       label: option.label,
       className: classNames('m-t-1', {
@@ -12718,7 +12683,7 @@ class Typeahead extends Component {
         className: "dropdown-menu",
         role: "menu",
         "aria-labelledby": "dropdownMenu1",
-        children: [optionsToRender.map((option, idx) => /*#__PURE__*/jsx(TypeaheadOption, {
+        children: [optionsToRender.map((option, idx) => /*#__PURE__*/jsx(Option, {
           query: query,
           option: option,
           selected: keyboardFocusedOptionIndex === idx,
@@ -12761,16 +12726,18 @@ class Typeahead extends Component {
     const menu = this.renderMenu({
       footer,
       options,
+      id,
       keyboardFocusedOptionIndex,
       query,
       allowNew,
       showNewEntry,
       dropdownOpen
     });
-    const hasError = errorState || alert && alert.type === Sentiment.ERROR;
-    const displayAlert = !errorState && alert || alert && alert.type === Sentiment.ERROR;
-    const hasWarning = displayAlert && alert.type === Sentiment.WARNING;
-    const hasInfo = displayAlert && alert.type === Sentiment.NEUTRAL;
+    const alertType = alert?.type ?? Sentiment.NEUTRAL;
+    const hasError = errorState || alert && alertType === Sentiment.ERROR;
+    const displayAlert = !errorState && alert || alert && alertType === Sentiment.ERROR;
+    const hasWarning = displayAlert && alertType === Sentiment.WARNING;
+    const hasInfo = displayAlert && alertType === Sentiment.NEUTRAL;
     return /*#__PURE__*/jsx("div", {
       id: id,
       className: classNames('typeahead', `typeahead-${size}`, {
@@ -12779,7 +12746,7 @@ class Typeahead extends Component {
         'typeahead--multiple': multiple,
         open: dropdownOpen
       }),
-      onClick: this.stopPropagation,
+      onClick: stopPropagation$1,
       children: /*#__PURE__*/jsxs("div", {
         className: classNames('form-group', {
           'has-error': hasError,
@@ -12800,6 +12767,7 @@ class Typeahead extends Component {
             placeholder,
             selected,
             maxHeight,
+            id: id,
             name: name,
             value: query,
             typeaheadId: id,
@@ -12826,72 +12794,6 @@ class Typeahead extends Component {
     });
   }
 }
-Typeahead.propTypes = {
-  id: PropTypes.string.isRequired,
-  name: PropTypes.string.isRequired,
-  options: PropTypes.arrayOf(PropTypes.shape({
-    label: PropTypes.string.isRequired,
-    note: PropTypes.string,
-    secondary: PropTypes.string,
-    value: PropTypes.object
-  })).isRequired,
-  initialValue: PropTypes.arrayOf(PropTypes.shape({
-    label: PropTypes.string.isRequired,
-    note: PropTypes.string,
-    secondary: PropTypes.string
-  })),
-  onChange: PropTypes.func.isRequired,
-  allowNew: PropTypes.bool,
-  autoFocus: PropTypes.bool,
-  clearable: PropTypes.bool,
-  multiple: PropTypes.bool,
-  showSuggestions: PropTypes.bool,
-  showNewEntry: PropTypes.bool,
-  searchDelay: PropTypes.number,
-  maxHeight: PropTypes.number,
-  minQueryLength: PropTypes.number,
-  addon: PropTypes.node,
-  placeholder: PropTypes.string,
-  alert: PropTypes.shape({
-    message: PropTypes.string.isRequired,
-    type: PropTypes.oneOf(['error', 'warning', 'neutral']).isRequired
-  }),
-  footer: PropTypes.node,
-  validateChip: PropTypes.func,
-  onSearch: PropTypes.func,
-  onBlur: PropTypes.func,
-  onInputChange: PropTypes.func,
-  onFocus: PropTypes.func,
-  chipSeparators: PropTypes.arrayOf(PropTypes.string),
-  size: PropTypes.oneOf(['md', 'lg']),
-  inputAutoComplete: PropTypes.string,
-  autoFillOnBlur: PropTypes.bool
-};
-Typeahead.defaultProps = {
-  allowNew: false,
-  autoFocus: false,
-  clearable: true,
-  multiple: false,
-  maxHeight: null,
-  showSuggestions: true,
-  showNewEntry: true,
-  searchDelay: SEARCH_DELAY,
-  minQueryLength: DEFAULT_MIN_QUERY_LENGTH,
-  addon: null,
-  placeholder: null,
-  alert: null,
-  footer: null,
-  size: Size.MEDIUM,
-  chipSeparators: [],
-  initialValue: [],
-  onSearch: null,
-  onBlur: null,
-  onInputChange: null,
-  onFocus: null,
-  validateChip: () => true,
-  inputAutoComplete: 'new-password',
-  autoFillOnBlur: true
-};
 
 // TODO: consider to move this enum into component file once we migrate it on TypeScript or replace with some common enum
 var UploadStep;
@@ -15440,10 +15342,10 @@ var zhHK = {
 	"neptune.ClearButton.ariaLabel": "清除",
 	"neptune.CloseButton.ariaLabel": "關閉",
 	"neptune.DateInput.day.label": "日",
-	"neptune.DateInput.day.placeholder": "日",
+	"neptune.DateInput.day.placeholder": "DD",
 	"neptune.DateInput.month.label": "月",
 	"neptune.DateInput.year.label": "年",
-	"neptune.DateInput.year.placeholder": "年",
+	"neptune.DateInput.year.placeholder": "YYYY",
 	"neptune.DateLookup.day": "日",
 	"neptune.DateLookup.goTo20YearView": "切換至20年視圖",
 	"neptune.DateLookup.month": "月",