@telus-uds/components-base 1.66.0 → 1.67.1

package/lib/utils/info/index.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _platform = _interopRequireDefault(require("./platform"));
-
 var _versions = _interopRequireDefault(require("./versions"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // export an object accessed like info.platform.OS, info.version.uds, etc
 var _default = {
   platform: _platform.default,

package/lib/utils/info/platform/index.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _platform = _interopRequireDefault(require("./platform"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // Allows consuming libraries that might not have a direct dependency on
 // React Native to check what the current platform is.
 // Particularly useful for validating Jest config: it is possible for Jest to

package/lib/utils/info/versions.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _package = _interopRequireDefault(require("../../../package.json"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // Add more versions if they are useful e.g. theme schema version
 var _default = {
   uds: _package.default.version

package/lib/utils/input.js

@@ -4,14 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useMultipleInputValues = exports.useInputValue = void 0;
-
 var _react = require("react");
-
 /**
  * @typedef {import('react').SyntheticEvent} Event
  */
-const pluralHooks = ['useMultipleInputValues'];
 
+const pluralHooks = ['useMultipleInputValues'];
 const validateProps = (_ref, _ref2, hookName) => {
   let {
     value,
@@ -24,7 +22,6 @@ const validateProps = (_ref, _ref2, hookName) => {
     isControlled
   } = _ref2;
   const s = pluralHooks.includes(hookName) ? 's' : '';
-
   const usageError = error => {
     // Errors inside hooks in React Native get incomplete stack traces pointing at parent component only.
     // Help devs out by telling them exactly which hook threw the error as well as why.
@@ -36,23 +33,20 @@ Consumers of this hook must be one of:
 3. A "read-only" component, with \`readOnly\` prop set as \`true\`.
 `);
   };
-
   if (value && !onChange && !readOnly) {
     usageError(`has \`value${s}\` prop without \`onChange\` or \`readOnly\``);
   }
-
   if (initialValue && value) {
     usageError(`has both \`initialValue${s}\` and \`value${s}\``);
   }
-
   if (isControlled && !isCurrentlyControlled) {
     usageError(`stopped receiving \`value${s}\` from parent after delegating state management`);
   }
-
   if (!isControlled && isCurrentlyControlled) {
     usageError(`started receiving \`value${s}\` from parent after starting managing own state`);
   }
 };
+
 /**
  * Hook used for controlling the input state of input components that have a singular value.
  * If `value` prop is passed in, this delegates state management to a parent using a passed-in `onChange` prop.
@@ -76,8 +70,6 @@ Consumers of this hook must be one of:
  *   isControlled: bool
  * }}
  */
-
-
 const useInputValue = function () {
   let props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   let hookName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'useInputValue';
@@ -95,26 +87,25 @@ const useInputValue = function () {
     readOnly = false
   } = props;
   const [ownValue, setOwnValue] = (0, _react.useState)(!isControlled && initialValue);
-  const currentValue = isControlled ? value : ownValue; // Store the first valid value, for resetting input to default. If behaviour like Formik's `enableReinitialize`
-  // is needed, add useEffect calling a set fn if !deepEqual(initializedValues, initialValues)
+  const currentValue = isControlled ? value : ownValue;
 
+  // Store the first valid value, for resetting input to default. If behaviour like Formik's `enableReinitialize`
+  // is needed, add useEffect calling a set fn if !deepEqual(initializedValues, initialValues)
   const valueRef = (0, _react.useRef)({
     initial: currentValue,
     value: currentValue
-  }); // Make current value accessible inside useCallback without rememoizing every time the value changes
-
+  });
+  // Make current value accessible inside useCallback without rememoizing every time the value changes
   valueRef.current.value = currentValue;
   const isDirty = currentValue !== valueRef.current.initial;
   const setValue = (0, _react.useCallback)((arg, event) => {
     if (readOnly) return;
     const newValue = typeof arg === 'function' ? arg(valueRef.current.value) : arg;
-
     if (!isControlled) {
       setOwnValue(newValue);
       if (inputRef !== null && inputRef !== void 0 && inputRef.current) inputRef.current.value = newValue ?? '';
-    } // Call onChange handler if there's something for it to handle (event or a changed value)
-
-
+    }
+    // Call onChange handler if there's something for it to handle (event or a changed value)
     if (onChange && (event || valueRef.current.value !== newValue)) onChange(newValue, event);
   }, [inputRef, isControlled, onChange, readOnly]);
   const resetValue = (0, _react.useCallback)(event => setValue(valueRef.current.initial, event), [setValue]);
@@ -126,6 +117,7 @@ const useInputValue = function () {
     isDirty
   };
 };
+
 /**
  * Hook used for controlling the input state of input components that have multiple named on/off states.
  * If `values` are passed in, this delegates state management to a parent using a passed-in `onChange` prop.
@@ -151,10 +143,7 @@ const useInputValue = function () {
  *   unsetValues: () => void
  * }}
  */
-
-
 exports.useInputValue = useInputValue;
-
 const useMultipleInputValues = function () {
   let {
     values,
@@ -187,9 +176,9 @@ const useMultipleInputValues = function () {
   const resetValues = resetValue;
   const unsetValues = (0, _react.useCallback)(event => setValues([], event), [setValues]);
   const toggleOneValue = (0, _react.useCallback)((newValue, event) => {
-    if (readOnly) return; // This will only work with primitive values (e.g. strings, numbers), swap for .some() and
+    if (readOnly) return;
+    // This will only work with primitive values (e.g. strings, numbers), swap for .some() and
     // a deepEqual() function if there's any use case for toggling stored objects or arrays.
-
     const newValues = currentValues.includes(newValue) ? currentValues.filter(oldValue => oldValue !== newValue) : [...currentValues, newValue];
     setValues(newValues, event);
   }, [currentValues, readOnly, setValues]);
@@ -201,5 +190,4 @@ const useMultipleInputValues = function () {
     unsetValues
   };
 };
-
 exports.useMultipleInputValues = useMultipleInputValues;

package/lib/utils/pressability.js

@@ -4,20 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.resolvePressableTokens = exports.resolvePressableState = exports.getPressHandlersWithArgs = exports.getCursorStyle = void 0;
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
-
 var _pressProps = _interopRequireDefault(require("./props/pressProps"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @typedef {import('react').ReactNode} ReactNode
- */
-// These roles should result in cursor: pointer but don't in current RNW releases
+ */ // These roles should result in cursor: pointer but don't in current RNW releases
 const shouldUseCursor = ['checkbox', 'radio', 'switch'];
+
 /**
  * React Native Web has some built-in logic for applying cursor styles based on accessibility roles;
  * however, it misses certain cases. This fills in known cases where widely used versions of RNW
@@ -29,7 +24,6 @@ const shouldUseCursor = ['checkbox', 'radio', 'switch'];
  * @param {string} [props.accessibilityRole]
  * @returns
  */
-
 const getCursorStyle = _ref => {
   let {
     inactive,
@@ -41,6 +35,7 @@ const getCursorStyle = _ref => {
   if (shouldUseCursor.includes(accessibilityRole)) return staticStyles.pointer;
   return undefined; // allows React Native Web's built-in logic to apply
 };
+
 /**
  * @typedef {{ pressed: boolean, focused: boolean, hovered?: boolean }} PressableState
  */
@@ -55,10 +50,7 @@ const getCursorStyle = _ref => {
  *   such as `inactive`, `selected`, etc.
  * @returns {object}
  */
-
-
 exports.getCursorStyle = getCursorStyle;
-
 const resolvePressableState = function () {
   let {
     pressed = false,
@@ -66,12 +58,14 @@ const resolvePressableState = function () {
     hovered = false
   } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   let additionalState = arguments.length > 1 ? arguments[1] : undefined;
-  return { ...additionalState,
+  return {
+    ...additionalState,
     focus: focused,
     hover: hovered,
     pressed
   };
 };
+
 /**
  * Takes a UDS `tokens` prop and, if it is a function, resolves it based on a state
  * object passed from the React Native `Pressable` component and optional extra properties.
@@ -81,18 +75,13 @@ const resolvePressableState = function () {
  * @param {object} [additionalState] - properties specific to the current component
  * @returns {object} - resolved tokens object
  */
-
-
 exports.resolvePressableState = resolvePressableState;
-
 const resolvePressableTokens = (tokens, pressableState, additionalState) => {
   if (typeof tokens !== 'function') return tokens;
   const udsPressableState = resolvePressableState(pressableState, additionalState);
   return tokens(udsPressableState);
 };
-
 exports.resolvePressableTokens = resolvePressableTokens;
-
 const staticStyles = _StyleSheet.default.create(_Platform.default.select({
   web: {
     notAllowed: {
@@ -104,13 +93,12 @@ const staticStyles = _StyleSheet.default.create(_Platform.default.select({
   },
   default: {}
 }));
+
 /**
  * From an object of props, extracts any platform-appropriate press handler functions and wraps
  * them in a function that passes in some provided args. Allows components containing a Pressable
  * to pass in press handlers that are then called with state or values that is otherwise internal.
  */
-
-
 const getPressHandlersWithArgs = function () {
   let pressableProps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   let args = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
@@ -122,7 +110,6 @@ const getPressHandlersWithArgs = function () {
         for (var _len = arguments.length, defaultArgs = new Array(_len), _key = 0; _key < _len; _key++) {
           defaultArgs[_key] = arguments[_key];
         }
-
         // Pass each handler data on this button and current selection
         handler(...args, ...defaultArgs);
       }
@@ -130,5 +117,4 @@ const getPressHandlersWithArgs = function () {
   }));
   return pressHandlers;
 };
-
 exports.getPressHandlersWithArgs = getPressHandlersWithArgs;

package/lib/utils/props/a11yProps.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _getPropSelector = _interopRequireDefault(require("./getPropSelector"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // React Native exports a11y prop definitions as TypeScript Interfaces, but no longer exports PropTypes
 // so we have to define them ourselves.
 const nativeA11yPropTypes = {
@@ -48,7 +43,8 @@ const nativeA11yPropTypes = {
   onAccessibilityEscape: _propTypes.default.func,
   onAccessibilityTap: _propTypes.default.func
 };
-const a11yPropTypes = { ...nativeA11yPropTypes,
+const a11yPropTypes = {
+  ...nativeA11yPropTypes,
   // React Native Web adds many a11y props that alias aria-* attributes
   // Types based on https://necolas.github.io/react-native-web/docs/accessibility/
   accessibilityActiveDescendant: _propTypes.default.string,
@@ -95,14 +91,15 @@ const a11yPropTypes = { ...nativeA11yPropTypes,
   accessibilityValueNow: _propTypes.default.number,
   accessibilityValueText: _propTypes.default.string
 };
-
 const a11yPropTypesByPlatform = _Platform.default.select({
   // React Native Web adds many a11y props that alias aria-* attributes
   // Types based on https://necolas.github.io/react-native-web/docs/accessibility/
   web: a11yPropTypes,
   // Ignore web-only props in native builds
   default: nativeA11yPropTypes
-}); // These RNW-only props only exist in RNW >=0.18. Catch them and map them according to platform
+});
+
+// These RNW-only props only exist in RNW >=0.18. Catch them and map them according to platform
 // so all props work on RN, RNW >=0.18 and RNW <=0.18, regardless of which they were written for:
 // - On native, bundle them into objects, like `accessibilityValue: { max: 100 }`
 // - On web, split them into both of:
@@ -110,8 +107,6 @@ const a11yPropTypesByPlatform = _Platform.default.select({
 //   - The corresponding RNW >=0.18 prop, like `accessibilityValueNow`, which in some cases does more
 //     than just add the aria-* (e.g. `accessibilityDisabled` adds `disabled` if element supports it,
 //     and future releases might add more features here).
-
-
 const rwnPropMappings = {
   // Former accessibilityValue props.
   accessibilityValueMax: value => _Platform.default.select({
@@ -219,14 +214,13 @@ const rwnPropMappings = {
     }
   })
 };
-
 if (_Platform.default.OS === 'web') {
-  const mapIfDefined = (value, fn) => value === undefined ? undefined : fn(value); // On Web only, these React Native object props need manual mapping in RNW >=0.18
+  const mapIfDefined = (value, fn) => value === undefined ? undefined : fn(value);
+
+  // On Web only, these React Native object props need manual mapping in RNW >=0.18
   // which dropped support for the React Native shape of these props.
   // Re-use our RNW 0.18 prop mappings to support both RNW <0.18 (aria-*) and
   // new features added in >=0.18 (e.g. for accessibilityDisabled).
-
-
   rwnPropMappings.accessibilityValue = function () {
     let {
       max,
@@ -234,13 +228,13 @@ if (_Platform.default.OS === 'web') {
       now,
       text
     } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    return { ...mapIfDefined(max, rwnPropMappings.accessibilityValueMax),
+    return {
+      ...mapIfDefined(max, rwnPropMappings.accessibilityValueMax),
       ...mapIfDefined(min, rwnPropMappings.accessibilityValueMin),
       ...mapIfDefined(now, rwnPropMappings.accessibilityValueNow),
       ...mapIfDefined(text, rwnPropMappings.accessibilityValueText)
     };
   };
-
   rwnPropMappings.accessibilityState = function () {
     let {
       busy,
@@ -249,7 +243,8 @@ if (_Platform.default.OS === 'web') {
       expanded,
       selected
     } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    return { ...mapIfDefined(busy, rwnPropMappings.accessibilityBusy),
+    return {
+      ...mapIfDefined(busy, rwnPropMappings.accessibilityBusy),
       ...mapIfDefined(checked, rwnPropMappings.accessibilityChecked),
       ...mapIfDefined(disabled, rwnPropMappings.accessibilityDisabled),
       ...mapIfDefined(expanded, rwnPropMappings.accessibilityExpanded),
@@ -257,29 +252,29 @@ if (_Platform.default.OS === 'web') {
     };
   };
 }
-
 var _default = {
   /**
    * Proptypes for recognised React Native accessiblity (a11y) props.
    * Spread this in the propTypes of components that accept React Native a11y props.
    */
   types: a11yPropTypes,
-
   /**
    * Filters a props object, returning only recognised React Native accessiblity (a11y) props.
    *
    * Where components accept React Native a11y props, pass { ...rest } from its props to this,
    * then spread the returned object into the component's props (usually its outer container).
    */
-  select: (0, _getPropSelector.default)( // Allow all React Native accessibility props
-  a11yPropTypesByPlatform, // Allow any `aria-*` attribute on web; ignore them on native
-  _Platform.default.OS === 'web' && /^aria-/, // For the props added and deprecated in React Native Web 0.18, convert them to
+  select: (0, _getPropSelector.default)(
+  // Allow all React Native accessibility props
+  a11yPropTypesByPlatform,
+  // Allow any `aria-*` attribute on web; ignore them on native
+  _Platform.default.OS === 'web' && /^aria-/,
+  // For the props added and deprecated in React Native Web 0.18, convert them to
   // a form that is platform-appropriate and RNW-version safe
   (key, value) => {
     const rnwPropMapper = rwnPropMappings[key];
     return rnwPropMapper ? rnwPropMapper(value) : undefined;
   }),
-
   /**
    * Use this to disable focus for elements which are visually hidden but still rendered.
    */
@@ -289,8 +284,8 @@ var _default = {
     ..._Platform.default.select({
       web: {
         accessibilityHidden: true // web screenreaders
-
       },
+
       android: {
         importantForAccessibility: 'no-hide-descendants'
       },
@@ -299,7 +294,6 @@ var _default = {
       }
     })
   },
-
   /**
    * Generates an object of platform-appropriate a11y props describing an item that has an
    * ordered position in a set. Examples of usage by accessibility tools includes screenreaders

package/lib/utils/props/clickProps.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const clickHandlerMapping = {
   onClick: 'onPress',
   onMouseDown: 'onPressIn',
@@ -19,7 +16,6 @@ var _default = {
    * Web-oriented HTML click handlers that may be mapped to React Native press handlers
    */
   types: Object.fromEntries(Object.keys(clickHandlerMapping).map(mouseName => [mouseName, _propTypes.default.func])),
-
   /**
    * Takes a set of props and converts HTML mouse click oriented event handlers to closest
    * equivalent React Native press event handler.

package/lib/utils/props/componentPropType.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = componentPropType;
-
 /**
  * Returns a prop type validator which checks whether a prop is either a component or an array of
  * components of a given type, based on their `name` or `displayName` properties.
@@ -16,54 +15,41 @@ exports.default = componentPropType;
  */
 function componentPropType(passedName) {
   const passedNames = typeof passedName === 'string' ? [passedName] : passedName;
-
   const checkProp = (props, propName, componentName) => {
     var _props$propName$type, _props$propName$type2;
-
     if (props[propName] === undefined || props[propName] === null) {
       return undefined;
     }
-
     if (Array.isArray(props[propName])) {
       // Iterates through every child and try to find the first element that does not match the passed name
       // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean
       return props[propName].map((_, index) => checkProp(props[propName], index, componentName)).find(Boolean);
     }
-
     const nameInProp = ((_props$propName$type = props[propName].type) === null || _props$propName$type === void 0 ? void 0 : _props$propName$type.displayName) || ((_props$propName$type2 = props[propName].type) === null || _props$propName$type2 === void 0 ? void 0 : _props$propName$type2.name);
-
     if (!nameInProp || !passedNames.includes(nameInProp)) {
       const propDescription = nameInProp ? `Component ${nameInProp}` : typeof props[propName];
       return new Error(`${componentName}: ${propDescription} was passed to \`${propName}\` prop; should be ${passedNames.join(' or ')}`);
     }
-
     return undefined;
   };
-
   const checkRequired = (props, propName, componentName) => {
     if (props[propName] === undefined) {
       return new Error(`The prop \`${propName}\` is marked as required in \`${componentName}\`, but its value is ${props[propName]}.`);
     }
-
     return undefined;
   };
-
   const createValidate = isRequired => {
     if (isRequired) {
       return (props, propName, componentName) => {
         const checkForError = checkProp(props, propName, componentName);
-
         if (checkForError) {
           return checkForError;
         }
-
         return checkRequired(props, propName, componentName);
       };
     }
-
     return checkProp;
   };
-
   const validate = createValidate();
   validate.isRequired = createValidate(true);
   return validate;

package/lib/utils/props/copyPropTypes.js

@@ -4,11 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var _default = _propTypes.default.oneOf(['en', 'fr']);
-
 exports.default = _default;

package/lib/utils/props/getPropSelector.js

@@ -4,20 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = getPropSelector;
-
 var _lodash = _interopRequireDefault(require("lodash.merge"));
-
 var _hasOwnProperty = _interopRequireDefault(require("../hasOwnProperty"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @callback PropSelectorCallback - a callback called for each prop passed to a component
  * @param {string} key - the key for the prop to be tested
  * @param {*} value - the value of the prop being passed in to the component
  * @returns {object|undefined}
  */
-
 /**
  * @param {PropSelectorCallback} callback
  * @param {object} items
@@ -28,12 +23,15 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const applyCallback = (callback, items, key, value) => {
   // If there's no callback, continue and look up keys as normal
   if (typeof callback !== 'function') return undefined;
-  const newItems = callback(key, value); // If the callback doesn't return anything, continue and look up keys as normal
+  const newItems = callback(key, value);
 
-  if (!newItems) return undefined; // If the callback returns items, merge them in, deep merging props that are objects
+  // If the callback doesn't return anything, continue and look up keys as normal
+  if (!newItems) return undefined;
 
+  // If the callback returns items, merge them in, deep merging props that are objects
   return (0, _lodash.default)({}, items, newItems);
 };
+
 /**
  * Generates a function to filter an object of props down to a subset of allowed props, with
  * optional prop alteration and re-mapping via an optional callback.
@@ -43,14 +41,15 @@ const applyCallback = (callback, items, key, value) => {
  * @param {PropSelectorCallback} callback - optional function taking `(key, value)` returning either undefined or an object of new props to merge in
  * @returns {object} - valid props for this component
  */
-
-
 function getPropSelector(propTypes, regexp, callback) {
   return props => Object.entries(props).reduce((items, _ref) => {
     let [key, value] = _ref;
-    return (// If there's a callback and it matches something, applyCallback merges it in; return that
-      applyCallback(callback, items, key, value) || ( // If there's no callback match, check if this prop is valid and merge it in if it is
-      (0, _hasOwnProperty.default)(propTypes, key) || regexp && regexp.test(key) ? { ...items,
+    return (
+      // If there's a callback and it matches something, applyCallback merges it in; return that
+      applyCallback(callback, items, key, value) || (
+      // If there's no callback match, check if this prop is valid and merge it in if it is
+      (0, _hasOwnProperty.default)(propTypes, key) || regexp && regexp.test(key) ? {
+        ...items,
         [key]: value
       } : items)
     );