@telus-uds/components-base 1.66.0 → 1.67.1

package/lib/ThemeProvider/useThemeTokens.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useThemeTokensCallback = exports.useThemeTokens = void 0;
-
 var _react = require("react");
-
 var _useTheme = _interopRequireDefault(require("./useTheme"));
-
 var _utils = require("./utils");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @typedef {import('../utils/props/variantProp.js').AppearanceSet} AppearanceSet
  * @typedef {import('../utils/props/tokens.js').TokensProp} TokensProp
@@ -54,6 +49,7 @@ const useThemeTokens = function (componentName) {
   const themeTokens = (0, _utils.getThemeTokens)(componentTheme, tokens, variants, states);
   return themeTokens;
 };
+
 /**
  * Returns a memoised tokens getter function that gets tokens similar to calling useThemeTokens.
  * Scenarios where `useThemeTokensCallback` should be used instead of `useThemeTokens` include:
@@ -106,10 +102,7 @@ const useThemeTokens = function (componentName) {
  *      tokenOverrides in rare cases where tokens overrides are also generated outside hook scope,
  *      e.g. if one theme tokens callback needs to pass certain token overrides to another.
  */
-
-
 exports.useThemeTokens = useThemeTokens;
-
 const useThemeTokensCallback = function (componentName) {
   let tokens = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   let variants = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -122,5 +115,4 @@ const useThemeTokensCallback = function (componentName) {
   }, [componentTheme, tokens, variants]);
   return getThemeTokensCallback;
 };
-
 exports.useThemeTokensCallback = useThemeTokensCallback;

package/lib/ThemeProvider/utils/index.js

@@ -3,9 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-
 var _styles = require("./styles");
-
 Object.keys(_styles).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _styles[key]) return;
@@ -16,9 +14,7 @@ Object.keys(_styles).forEach(function (key) {
     }
   });
 });
-
 var _themeTokens = require("./theme-tokens");
-
 Object.keys(_themeTokens).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _themeTokens[key]) return;

package/lib/ThemeProvider/utils/styles.js

@@ -7,17 +7,14 @@ exports.applyOuterBorder = void 0;
 exports.applyShadowToken = applyShadowToken;
 exports.applyTextStyles = applyTextStyles;
 exports.verticalAlignRow = verticalAlignRow;
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _systemConstants = require("@telus-uds/system-constants");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * React-Native specific implementations of style patterns that
  * don't map directly to cross-platform design token values.
  */
+
 // Make design tokens fit React Native's text styles' specific requirements and quirks
 function applyTextStyles(_ref) {
   let {
@@ -35,27 +32,24 @@ function applyTextStyles(_ref) {
     },
     ...rest
   } = _ref;
-  const styles = { ...rest
+  const styles = {
+    ...rest
   };
   const {
     forceAbsoluteFontSizing
   } = themeOptions;
-
   if (fontSize) {
     // If relative font sizes are needed, catch and calculate them here
     styles.fontSize = _Platform.default.OS === 'web' && !forceAbsoluteFontSizing ? `${fontSize / _systemConstants.fontBasePixels}rem` : fontSize;
   }
-
   if (typeof lineHeight === 'number') {
     // React Native expects absolute line heights but multipliers are better as design tokens
     styles.lineHeight = lineHeight * (fontSize || _systemConstants.fontBasePixels);
   }
-
   if (typeof letterSpacing === 'number' && letterSpacing) {
     // Same as for line heights - React Native expects absolute letter spacing value
     styles.letterSpacing = letterSpacing * (fontSize || _systemConstants.fontBasePixels);
   }
-
   if (fontName) {
     // Don't set undefined font families. May need some validation here that the font is available.
     // Android doesn't recognise font weights natively so apply custom font weights via `fontFamily`.
@@ -65,16 +59,17 @@ function applyTextStyles(_ref) {
     // Font weight support in Android is limited to 'bold' or anything else === 'normal'.
     styles.fontWeight = _Platform.default.OS === 'android' && Number(fontWeight) > 400 ? 'bold' : fontWeight;
   }
-
   if (fontColor) {
     styles.color = fontColor;
-  } // TODO: look into calculating typographic spacing with PixelRatio.getFontScale()
+  }
+
+  // TODO: look into calculating typographic spacing with PixelRatio.getFontScale()
   // Do while implementing advanced typography e.g. paragraph etc
   // https://github.com/telus/universal-design-system/issues/89
 
-
   return styles;
 }
+
 /**
  * React Native's in-built shadow support is limited. Take an object describing an ideal shadow and
  * return a platform-appropriate implementation that gets close to the described effect.
@@ -88,20 +83,15 @@ function applyTextStyles(_ref) {
  * @param {number}  shadowToken.spread
  * @return {object}
  */
-
-
 function applyShadowToken(shadowToken) {
   if (!shadowToken) return {};
-
   const applyShadow = _Platform.default.select({
     web: () => applyWebShadow(shadowToken),
     ios: () => applyIosShadow(shadowToken),
     android: () => applyAndroidShadow(shadowToken)
   });
-
   return applyShadow();
 }
-
 function applyWebShadow(_ref2) {
   let {
     inset,
@@ -117,7 +107,6 @@ function applyWebShadow(_ref2) {
   };
   return boxShadow;
 }
-
 function applyAndroidShadow(shadowToken) {
   const {
     color,
@@ -125,23 +114,20 @@ function applyAndroidShadow(shadowToken) {
     spread,
     offsetY,
     offsetX
-  } = shadowToken; // Android shadows are very limited and workarounds are hacky. Use the built-in `elevation` API unless
+  } = shadowToken;
+  // Android shadows are very limited and workarounds are hacky. Use the built-in `elevation` API unless
   // shadow design is radically different to a simple top-down shadow (e.g. horizontal, upward, or inset)
-
   if (!inset && offsetY >= 0 && offsetY >= offsetX) {
     return {
       // Can't match other platforms, but can give longer shadows to elements designed for longer shadows
       elevation: spread + offsetY,
       shadowColor: color // Only applies on Android >= 9 and React Native >= 0.64.0
-
     };
-  } // TODO: maybe use a library or workaround to increase capabilities.
+  }
+  // TODO: maybe use a library or workaround to increase capabilities.
   // https://github.com/telus/universal-design-system/issues/535
-
-
   return {};
 }
-
 function applyIosShadow(_ref3) {
   let {
     inset,
@@ -155,15 +141,15 @@ function applyIosShadow(_ref3) {
   // TODO: maybe use a library or workaround for inset shadows. This is a sizable task and would
   // involve changing component implementations to use a custom view, can't be done with styles alone.
   // https://github.com/telus/universal-design-system/issues/535
-  if (inset) return {}; // React Native iOS doesn't support spread. Where there's an offset, can approximate positive spread by
+  if (inset) return {};
+
+  // React Native iOS doesn't support spread. Where there's an offset, can approximate positive spread by
   // increasing the (positive or negative) offset by the spread. This makes the shadow reach the point it
   // would if spread was supported (with a side effect that its start is further "under" the element).
-
   const nudgeBySpread = offset => {
     if (!offset || spread <= 0) return 0;
     return offset > 0 ? spread : spread * -1;
   };
-
   return {
     shadowColor: color,
     shadowOffset: {
@@ -172,7 +158,6 @@ function applyIosShadow(_ref3) {
     },
     shadowRadius: blur,
     shadowOpacity: 1 // opacity is applied via RGBA in the `color` token
-
   };
 }
 
@@ -181,7 +166,6 @@ const verticalAlignToFlexRowAlign = {
   middle: 'center',
   bottom: 'flex-end'
 };
-
 function verticalAlignRow(verticalAlign) {
   let reverse = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   return {
@@ -189,20 +173,16 @@ function verticalAlignRow(verticalAlign) {
     alignItems: verticalAlignToFlexRowAlign[verticalAlign]
   };
 }
-
 const calculateBorderRadius = (borderRadius, outerBorderGap, outerBorderWidth) => {
   if (borderRadius) {
     return borderRadius + outerBorderGap + outerBorderWidth;
   }
-
   return null;
 };
 /**
  * Use on an outer container to create an outer border with an optional gap around it
  * that matches the border radius of any inner border.
  */
-
-
 const applyOuterBorder = _ref4 => {
   let {
     outerBorderColor,
@@ -226,5 +206,4 @@ const applyOuterBorder = _ref4 => {
     borderColor: outerBorderColor
   };
 };
-
 exports.applyOuterBorder = applyOuterBorder;

package/lib/ThemeProvider/utils/theme-tokens.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.validateThemeTokensVersion = exports.validateThemeTokens = exports.toArray = exports.resolveThemeTokens = exports.mergeAppearances = exports.getThemeTokens = exports.getComponentTheme = exports.doesThemeRuleApply = exports.doesThemeConditionApply = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _satisfies = _interopRequireDefault(require("semver/functions/satisfies"));
-
 var _package = _interopRequireDefault(require("../../../package.json"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @typedef {import('../../utils/props/variantProp.js').AppearanceSet} AppearanceSet
  * @typedef {import('../../utils/props/tokens.js').TokensProp} TokensProp
@@ -22,42 +17,34 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * General utilities around working with theme tokens
  */
+
 const getComponentTheme = (theme, componentName) => {
   var _theme$metadata;
-
   // Give clear and understandable error messages for common dev errors, for example,
   // typo in component name, missing export or accessing old version of theme
   if (!theme) {
     throw new Error(`Called useTheme's getStyle on "${componentName}" with no theme provided`);
   }
-
   const themeName = ((_theme$metadata = theme.metadata) === null || _theme$metadata === void 0 ? void 0 : _theme$metadata.name) || '';
-
   if (!theme.components) {
     throw new Error(`Theme "${themeName}" has no components defined (looking for "${componentName}")`);
   }
-
   const componentTheme = theme.components[componentName];
-
   if (!componentTheme) {
     throw new Error(`Theme "${themeName}" does not have styles for component "${componentName}"`);
   }
-
   return componentTheme;
 };
-
 exports.getComponentTheme = getComponentTheme;
-
 const doesThemeConditionApply = (_ref, appearances) => {
   let [key, value] = _ref;
   // use null rather than undefined so we can serialise the value in themes
   const appearanceValue = appearances[key] ?? null;
   return Array.isArray(value) ? value.includes(appearanceValue) : value === appearanceValue;
 };
-
 exports.doesThemeConditionApply = doesThemeConditionApply;
-
 const doesThemeRuleApply = (rule, appearances) => Object.entries(rule.if).every(condition => doesThemeConditionApply(condition, appearances));
+
 /**
  * Turns a tokens prop (which may be either a tokens object or a tokens getter function)
  * into one resolved tokens object, based on current appearances state.
@@ -74,24 +61,21 @@ const doesThemeRuleApply = (rule, appearances) => Object.entries(rule.if).every(
  * @param {TokensProp} [tokenOverrides] - optional set of tokens or tokens getter function to override the default
  * @returns {TokensSet} - object containing resolved tokens with overrides applied
  */
-
-
 exports.doesThemeRuleApply = doesThemeRuleApply;
-
 const resolveThemeTokens = function (defaultTokens) {
   let appearances = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   let tokenOverrides = arguments.length > 2 ? arguments[2] : undefined;
-
   const resolve = tokens => typeof tokens === 'function' ? tokens(appearances) : tokens;
-
   if (!tokenOverrides) return resolve(defaultTokens);
   return Object.entries(resolve(tokenOverrides)).reduce((mergedTokens, _ref2) => {
     let [tokenName, tokenValue] = _ref2;
-    return tokenValue === undefined ? mergedTokens : { ...mergedTokens,
+    return tokenValue === undefined ? mergedTokens : {
+      ...mergedTokens,
       [tokenName]: tokenValue
     };
   }, resolve(defaultTokens));
 };
+
 /**
  * Gives a prop types error if a set of resolved tokens doesn't match a provided prop
  * types validator.
@@ -103,19 +87,16 @@ const resolveThemeTokens = function (defaultTokens) {
  * @param {function} validator - PropTypes validator function
  * @param {string} componentName - identifier to display in PropType error messages
  */
-
-
 exports.resolveThemeTokens = resolveThemeTokens;
-
 const validateThemeTokens = (themeTokens, validator, componentName) => {
   _propTypes.default.checkPropTypes({
     tokens: validator
   }, {
     tokens: themeTokens
   }, 'resolved token', componentName);
-
   return themeTokens;
 };
+
 /**
  * Merges variants over states. Must be merged in that order to allow static showcases of a state,
  * e.g. `<Button variant={{ pressed: true }} />` where button's pressed state is `false` by default.
@@ -125,17 +106,16 @@ const validateThemeTokens = (themeTokens, validator, componentName) => {
  * @param {AppearanceSet} [states]
  * @returns {AppearanceSet}
  */
-
-
 exports.validateThemeTokens = validateThemeTokens;
-
 const mergeAppearances = function () {
   let variants = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   let states = arguments.length > 1 ? arguments[1] : undefined;
-  return states ? { ...states,
+  return states ? {
+    ...states,
     ...variants
   } : variants;
 };
+
 /**
  * Get a set of theme tokens by applying a theme's component rules based on a component's variants and state.
  *
@@ -147,10 +127,7 @@ const mergeAppearances = function () {
  * @param {object} [states] - object containing current state options for this component instance
  * @returns {object} Set of resolved theme tokens
  */
-
-
 exports.mergeAppearances = mergeAppearances;
-
 const getThemeTokens = function (_ref3, tokensProp) {
   let {
     rules = [],
@@ -158,18 +135,19 @@ const getThemeTokens = function (_ref3, tokensProp) {
   } = _ref3;
   let variants = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   let states = arguments.length > 3 ? arguments[3] : undefined;
-  const appearances = mergeAppearances(variants, states); // TODO: if in dev mode, validate the appearances and provided propTokens
-  // Get the theme's default tokens set and merge tokens from applicable theme rules over it
+  const appearances = mergeAppearances(variants, states);
+  // TODO: if in dev mode, validate the appearances and provided propTokens
 
-  const themeTokens = rules.reduce((mergedTokens, rule) => doesThemeRuleApply(rule, appearances) ? { ...mergedTokens,
+  // Get the theme's default tokens set and merge tokens from applicable theme rules over it
+  const themeTokens = rules.reduce((mergedTokens, rule) => doesThemeRuleApply(rule, appearances) ? {
+    ...mergedTokens,
     ...rule.tokens
   } : mergedTokens, defaultThemeTokens);
   return resolveThemeTokens(themeTokens, appearances, tokensProp);
 };
-
 exports.getThemeTokens = getThemeTokens;
-
 const toArray = strOrArr => Array.isArray(strOrArr) ? strOrArr : [strOrArr];
+
 /**
  * Throws an error if the theme was built with an incompatible version of @telus-uds/system-theme-tokens
  *
@@ -181,16 +159,11 @@ const toArray = strOrArr => Array.isArray(strOrArr) ? strOrArr : [strOrArr];
  *
  * @param {object} theme - UDS theme built for react-native
  */
-
-
 exports.toArray = toArray;
-
 const validateThemeTokensVersion = theme => {
   var _theme$metadata2;
-
   const expectedThemeTokensVersion = _package.default.dependencies['@telus-uds/system-theme-tokens'];
   const actualThemeTokensVersion = theme === null || theme === void 0 ? void 0 : (_theme$metadata2 = theme.metadata) === null || _theme$metadata2 === void 0 ? void 0 : _theme$metadata2.themeTokensVersion;
-
   if (!(0, _satisfies.default)(actualThemeTokensVersion, expectedThemeTokensVersion)) {
     throw new Error(`Invalid UDS token schema version detected.
 
@@ -199,5 +172,4 @@ The UDS base components ${_package.default.name} v${_package.default.version} ar
 If you see this error than most likely you have attempted to install ${_package.default.name} and a UDS theme manually because you are building a multi-brand application. If you are building a single brand application, consider installing the brand specific design system package such as @telus-uds/ds-allium. For more information, see https://github.com/telus/universal-design-system/blob/main/docs/docs/multi-brand-usage.md`);
   }
 };
-
 exports.validateThemeTokensVersion = validateThemeTokensVersion;

package/lib/Timeline/Timeline.js

@@ -4,27 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
-
 var _ThemeProvider = require("../ThemeProvider");
-
 var _utils = require("../utils");
-
 var _ViewportProvider = require("../ViewportProvider");
-
 var _jsxRuntime = require("react/jsx-runtime");
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const selectDotStyles = _ref => {
   let {
     dotWidth,
@@ -41,7 +30,6 @@ const selectDotStyles = _ref => {
     borderColor: timelineColor
   };
 };
-
 const selectConnectorStyles = _ref2 => {
   let {
     timelineConnectorColor,
@@ -54,7 +42,6 @@ const selectConnectorStyles = _ref2 => {
     backgroundColor: timelineConnectorColor
   };
 };
-
 const selectTimelineContainerStyle = _ref3 => {
   let {
     timelineContainerDirection
@@ -63,7 +50,6 @@ const selectTimelineContainerStyle = _ref3 => {
     flexDirection: timelineContainerDirection
   };
 };
-
 const selectLineItemStyles = _ref4 => {
   let {
     lineItemAlign,
@@ -79,7 +65,6 @@ const selectLineItemStyles = _ref4 => {
     overflow: 'hidden'
   };
 };
-
 const selectLineItemContainer = _ref5 => {
   let {
     lineItemContainerDirection,
@@ -90,7 +75,6 @@ const selectLineItemContainer = _ref5 => {
     flex: lineContainerFlexSize
   };
 };
-
 const selectItemContentStyles = (_ref6, isLastChild) => {
   let {
     itemContentFlexSize,
@@ -103,8 +87,8 @@ const selectItemContentStyles = (_ref6, isLastChild) => {
     marginRight: !isLastChild && itemContentMarginRight
   };
 };
-
 const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.viewProps]);
+
 /**
  * Timeline is a component that displays either a horizontal or vertical list of the
  * children components passed by props
@@ -117,7 +101,6 @@ const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_u
  * ## A11y guidelines
  * Timeline link supports all the common a11y props.
  */
-
 const Timeline = /*#__PURE__*/(0, _react.forwardRef)((_ref7, ref) => {
   let {
     tokens,
@@ -132,20 +115,23 @@ const Timeline = /*#__PURE__*/(0, _react.forwardRef)((_ref7, ref) => {
   const themeTokens = (0, _ThemeProvider.useThemeTokens)('Timeline', tokens, variant, {
     viewport
   });
-  const containerProps = { ...selectProps(rest),
+  const containerProps = {
+    ...selectProps(rest),
     ...(0, _utils.getA11yPropsFromHtmlTag)(tag, rest.accessibilityRole || 'list'),
     accessibilityLabel
   };
-  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, { ...containerProps,
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+    ...containerProps,
     ref: ref,
     style: selectTimelineContainerStyle(themeTokens),
     children: children.map((child, index) => {
       var _child$props;
-
-      const childrenProps = { ...(0, _utils.getA11yPropsFromHtmlTag)(childrenTag, (child === null || child === void 0 ? void 0 : (_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.accessibilityRole) || 'listitem')
+      const childrenProps = {
+        ...(0, _utils.getA11yPropsFromHtmlTag)(childrenTag, (child === null || child === void 0 ? void 0 : (_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.accessibilityRole) || 'listitem')
       };
       return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
-        style: selectLineItemContainer(themeTokens) // eslint-disable-next-line react/no-array-index-key
+        style: selectLineItemContainer(themeTokens)
+        // eslint-disable-next-line react/no-array-index-key
         ,
         ...childrenProps,
         children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
@@ -164,21 +150,19 @@ const Timeline = /*#__PURE__*/(0, _react.forwardRef)((_ref7, ref) => {
   });
 });
 Timeline.displayName = 'Timeline';
-Timeline.propTypes = { ...selectedSystemPropTypes,
+Timeline.propTypes = {
+  ...selectedSystemPropTypes,
   tokens: (0, _utils.getTokensPropType)('Timeline'),
   variant: _utils.variantProp.propType,
-
   /**
    * A list of components that will be rendered either horizontally or vertically
    */
   children: _propTypes.default.arrayOf(_propTypes.default.node).isRequired,
-
   /**
    * A required accessibility label that needs to be passed to be used on List
    * which is applied as normal for a React Native accessibilityLabel prop.
    */
   accessibilityLabel: _propTypes.default.string.isRequired,
-
   /**
    * Sets the HTML tag of the outer container and the children. By default `'li'` for the children
    * and `'ul'` for the container

package/lib/Timeline/index.js

@@ -4,10 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _Timeline = _interopRequireDefault(require("./Timeline"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var _default = _Timeline.default;
 exports.default = _default;