@telus-uds/components-base 1.97.0 → 1.97.1

package/lib/ThemeProvider/useTheme.js

@@ -1,18 +1,11 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _react = require("react");
-var _ThemeProvider = require("./ThemeProvider");
+import { useContext } from 'react';
+import { ThemeContext } from './ThemeProvider';
 const useTheme = () => {
-  const theme = (0, _react.useContext)(_ThemeProvider.ThemeContext);
+  const theme = useContext(ThemeContext);
   // Fail fast if dev uses useTheme outside of ThemeProvider
   if (theme instanceof Error) {
     throw theme;
   }
   return theme;
 };
-var _default = useTheme;
-exports.default = _default;
+export default useTheme;

package/lib/ThemeProvider/useThemeTokens.js

@@ -1,13 +1,6 @@
-"use strict";
-
-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 }; }
+import { useCallback } from 'react';
+import useTheme from './useTheme';
+import { getComponentTheme, getThemeTokens, resolveThemeTokens, mergeAppearances } from './utils';
 /**
  * @typedef {import('../utils/props/variantProp.js').AppearanceSet} AppearanceSet
  * @typedef {import('../utils/props/tokens.js').TokensProp} TokensProp
@@ -40,13 +33,13 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {AppearanceSet} [states] - optional object containing current theme appearances dictated by user action or context
  * @returns {TokensSet} - the currently-applicable resolved set of theme tokens to apply
  */
-const useThemeTokens = function (componentName) {
+export const useThemeTokens = function (componentName) {
   let tokens = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   let variants = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   let states = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
-  const theme = (0, _useTheme.default)();
-  const componentTheme = (0, _utils.getComponentTheme)(theme, componentName);
-  const themeTokens = (0, _utils.getThemeTokens)(componentTheme, tokens, variants, states);
+  const theme = useTheme();
+  const componentTheme = getComponentTheme(theme, componentName);
+  const themeTokens = getThemeTokens(componentTheme, tokens, variants, states);
   return themeTokens;
 };
 
@@ -102,17 +95,15 @@ 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) {
+export const useThemeTokensCallback = function (componentName) {
   let tokens = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   let variants = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  const theme = (0, _useTheme.default)();
-  const componentTheme = (0, _utils.getComponentTheme)(theme, componentName);
-  const getThemeTokensCallback = (0, _react.useCallback)((states, tokenOverrides) => {
-    const appearances = (0, _utils.mergeAppearances)(variants, states);
-    const resolvedTokens = (0, _utils.resolveThemeTokens)(tokens, appearances, tokenOverrides);
-    return (0, _utils.getThemeTokens)(componentTheme, resolvedTokens, appearances);
+  const theme = useTheme();
+  const componentTheme = getComponentTheme(theme, componentName);
+  const getThemeTokensCallback = useCallback((states, tokenOverrides) => {
+    const appearances = mergeAppearances(variants, states);
+    const resolvedTokens = resolveThemeTokens(tokens, appearances, tokenOverrides);
+    return getThemeTokens(componentTheme, resolvedTokens, appearances);
   }, [componentTheme, tokens, variants]);
   return getThemeTokensCallback;
-};
-exports.useThemeTokensCallback = useThemeTokensCallback;
+};

package/lib/ThemeProvider/utils/index.js

@@ -1,27 +1,2 @@
-"use strict";
-
-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;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _styles[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;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _themeTokens[key];
-    }
-  });
-});
+export * from './styles';
+export * from './theme-tokens';

package/lib/ThemeProvider/utils/styles.js

@@ -1,22 +1,12 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-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.
  */
+import Platform from "react-native-web/dist/exports/Platform";
+import { fontBasePixels } from '@telus-uds/system-constants';
 
 // Make design tokens fit React Native's text styles' specific requirements and quirks
-function applyTextStyles(_ref) {
+export function applyTextStyles(_ref) {
   let {
     fontColor,
     fontSize,
@@ -40,15 +30,15 @@ function applyTextStyles(_ref) {
   } = 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;
+    styles.fontSize = Platform.OS === 'web' && !forceAbsoluteFontSizing ? `${fontSize / 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);
+    styles.lineHeight = lineHeight * (fontSize || fontBasePixels);
   }
   if (typeof letterSpacing === 'number' && letterSpacing) {
     // Same as for line heights - React Native expects absolute letter spacing value
-    styles.letterSpacing = letterSpacing * (fontSize || _systemConstants.fontBasePixels);
+    styles.letterSpacing = letterSpacing * (fontSize || fontBasePixels);
   }
   if (fontName) {
     // Don't set undefined font families. May need some validation here that the font is available.
@@ -57,7 +47,7 @@ function applyTextStyles(_ref) {
   } else if (fontWeight) {
     // If using system default font, apply the font weight directly.
     // Font weight support in Android is limited to 'bold' or anything else === 'normal'.
-    styles.fontWeight = _Platform.default.OS === 'android' && Number(fontWeight) > 400 ? 'bold' : fontWeight;
+    styles.fontWeight = Platform.OS === 'android' && Number(fontWeight) > 400 ? 'bold' : fontWeight;
   }
   if (fontColor) {
     styles.color = fontColor;
@@ -83,9 +73,9 @@ function applyTextStyles(_ref) {
  * @param {number}  shadowToken.spread
  * @return {object}
  */
-function applyShadowToken(shadowToken) {
+export function applyShadowToken(shadowToken) {
   if (!shadowToken) return {};
-  const applyShadow = _Platform.default.select({
+  const applyShadow = Platform.select({
     web: () => applyWebShadow(shadowToken),
     ios: () => applyIosShadow(shadowToken),
     android: () => applyAndroidShadow(shadowToken)
@@ -160,13 +150,12 @@ function applyIosShadow(_ref3) {
     shadowOpacity: 1 // opacity is applied via RGBA in the `color` token
   };
 }
-
 const verticalAlignToFlexRowAlign = {
   top: 'flex-start',
   middle: 'center',
   bottom: 'flex-end'
 };
-function verticalAlignRow(verticalAlign) {
+export function verticalAlignRow(verticalAlign) {
   let reverse = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   return {
     flexDirection: reverse ? 'row-reverse' : 'row',
@@ -183,7 +172,7 @@ const calculateBorderRadius = (borderRadius, outerBorderGap, outerBorderWidth) =
  * 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 => {
+export const applyOuterBorder = _ref4 => {
   let {
     outerBorderColor,
     outerBorderWidth = 0,
@@ -205,5 +194,4 @@ const applyOuterBorder = _ref4 => {
     borderWidth: outerBorderWidth,
     borderColor: outerBorderColor
   };
-};
-exports.applyOuterBorder = applyOuterBorder;
+};

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

@@ -1,13 +1,7 @@
-"use strict";
+import PropTypes from 'prop-types';
+import semVerSatisfies from 'semver/functions/satisfies';
+import pkg from '../../../package.json';
 
-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
@@ -18,7 +12,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * General utilities around working with theme tokens
  */
 
-const getComponentTheme = (theme, componentName) => {
+export 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
@@ -35,15 +29,13 @@ const getComponentTheme = (theme, componentName) => {
   }
   return componentTheme;
 };
-exports.getComponentTheme = getComponentTheme;
-const doesThemeConditionApply = (_ref, appearances) => {
+export 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));
+export 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)
@@ -61,8 +53,7 @@ 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) {
+export 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;
@@ -87,9 +78,8 @@ 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({
+export const validateThemeTokens = (themeTokens, validator, componentName) => {
+  PropTypes.checkPropTypes({
     tokens: validator
   }, {
     tokens: themeTokens
@@ -106,8 +96,7 @@ const validateThemeTokens = (themeTokens, validator, componentName) => {
  * @param {AppearanceSet} [states]
  * @returns {AppearanceSet}
  */
-exports.validateThemeTokens = validateThemeTokens;
-const mergeAppearances = function () {
+export const mergeAppearances = function () {
   let variants = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   let states = arguments.length > 1 ? arguments[1] : undefined;
   return states ? {
@@ -127,8 +116,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) {
+export const getThemeTokens = function (_ref3, tokensProp) {
   let {
     rules = [],
     tokens: defaultThemeTokens = {}
@@ -145,8 +133,7 @@ const getThemeTokens = function (_ref3, tokensProp) {
   } : mergedTokens, defaultThemeTokens);
   return resolveThemeTokens(themeTokens, appearances, tokensProp);
 };
-exports.getThemeTokens = getThemeTokens;
-const toArray = strOrArr => Array.isArray(strOrArr) ? strOrArr : [strOrArr];
+export 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
@@ -159,17 +146,15 @@ const toArray = strOrArr => Array.isArray(strOrArr) ? strOrArr : [strOrArr];
  *
  * @param {object} theme - UDS theme built for react-native
  */
-exports.toArray = toArray;
-const validateThemeTokensVersion = theme => {
+export 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)) {
+  const expectedThemeTokensVersion = pkg.dependencies['@telus-uds/system-theme-tokens'];
+  const actualThemeTokensVersion = theme === null || theme === void 0 || (_theme$metadata2 = theme.metadata) === null || _theme$metadata2 === void 0 ? void 0 : _theme$metadata2.themeTokensVersion;
+  if (!semVerSatisfies(actualThemeTokensVersion, expectedThemeTokensVersion)) {
     throw new Error(`Invalid UDS token schema version detected.
 
-The UDS base components ${_package.default.name} v${_package.default.version} are only compatible with UDS themes that are built with @telus-uds/system-theme-tokens version that is semver compatible with ${expectedThemeTokensVersion}. The current theme was built with @telus-uds/system-theme-tokens v${actualThemeTokensVersion}.
+The UDS base components ${pkg.name} v${pkg.version} are only compatible with UDS themes that are built with @telus-uds/system-theme-tokens version that is semver compatible with ${expectedThemeTokensVersion}. The current theme was built with @telus-uds/system-theme-tokens v${actualThemeTokensVersion}.
 
-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`);
+If you see this error than most likely you have attempted to install ${pkg.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

@@ -1,17 +1,11 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _propTypes = _interopRequireDefault(require("prop-types"));
-var _react = _interopRequireDefault(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 _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+import PropTypes from 'prop-types';
+import React from 'react';
+import Platform from "react-native-web/dist/exports/Platform";
+import View from "react-native-web/dist/exports/View";
+import { useThemeTokens } from '../ThemeProvider';
+import { getTokensPropType, variantProp, a11yProps, viewProps, selectSystemProps, getA11yPropsFromHtmlTag, layoutTags } from '../utils';
+import { useViewport } from '../ViewportProvider';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const selectDotStyles = _ref => {
   let {
     dotWidth,
@@ -85,7 +79,7 @@ const selectItemContentStyles = (_ref6, isLastChild) => {
     marginRight: !isLastChild && itemContentMarginRight
   };
 };
-const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.viewProps]);
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
 
 /**
  * Timeline is a component that displays either a horizontal or vertical list of the
@@ -99,7 +93,7 @@ const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_u
  * ## A11y guidelines
  * Timeline link supports all the common a11y props.
  */
-const Timeline = /*#__PURE__*/_react.default.forwardRef((_ref7, ref) => {
+const Timeline = /*#__PURE__*/React.forwardRef((_ref7, ref) => {
   let {
     tokens,
     variant = {},
@@ -109,37 +103,38 @@ const Timeline = /*#__PURE__*/_react.default.forwardRef((_ref7, ref) => {
     childrenTag = 'li',
     ...rest
   } = _ref7;
-  const viewport = (0, _ViewportProvider.useViewport)();
-  const themeTokens = (0, _ThemeProvider.useThemeTokens)('Timeline', tokens, variant, {
+  const viewport = useViewport();
+  const themeTokens = useThemeTokens('Timeline', tokens, variant, {
     viewport
   });
   const containerProps = {
     ...selectProps(rest),
-    ...(0, _utils.getA11yPropsFromHtmlTag)(tag, rest.accessibilityRole || 'list'),
+    ...getA11yPropsFromHtmlTag(tag, rest.accessibilityRole || 'list'),
     accessibilityLabel
   };
-  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+  return /*#__PURE__*/_jsx(View, {
     ...containerProps,
     ref: ref,
     style: selectTimelineContainerStyle(themeTokens),
     children: children.map((child, index) => {
       var _child$props;
+      const accessibilityRole = Platform.OS !== 'android' ? 'listitem' : undefined;
       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')
+        ...getA11yPropsFromHtmlTag(childrenTag, (child === null || child === void 0 || (_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.accessibilityRole) || accessibilityRole)
       };
-      return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+      return /*#__PURE__*/_jsxs(View, {
         style: selectLineItemContainer(themeTokens)
         // eslint-disable-next-line react/no-array-index-key
         ,
         ...childrenProps,
-        children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+        children: [/*#__PURE__*/_jsxs(View, {
           style: selectLineItemStyles(themeTokens),
-          children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+          children: [/*#__PURE__*/_jsx(View, {
             style: selectDotStyles(themeTokens)
-          }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+          }), /*#__PURE__*/_jsx(View, {
             style: selectConnectorStyles(themeTokens)
           })]
-        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+        }), /*#__PURE__*/_jsx(View, {
           style: selectItemContentStyles(themeTokens, index + 1 === children.length),
           children: child
         })]
@@ -150,17 +145,17 @@ const Timeline = /*#__PURE__*/_react.default.forwardRef((_ref7, ref) => {
 Timeline.displayName = 'Timeline';
 Timeline.propTypes = {
   ...selectedSystemPropTypes,
-  tokens: (0, _utils.getTokensPropType)('Timeline'),
-  variant: _utils.variantProp.propType,
+  tokens: getTokensPropType('Timeline'),
+  variant: variantProp.propType,
   /**
    * A list of components that will be rendered either horizontally or vertically
    */
-  children: _propTypes.default.arrayOf(_propTypes.default.node).isRequired,
+  children: PropTypes.arrayOf(PropTypes.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,
+  accessibilityLabel: PropTypes.string.isRequired,
   /**
    * Sets the HTML tag of the outer container and the children. By default `'li'` for the children
    * and `'ul'` for the container
@@ -168,8 +163,7 @@ Timeline.propTypes = {
    * If either `tag` or `childrenTag` is overridden, the other should be too, to avoid producing invalid HTML.
    *
    */
-  tag: _propTypes.default.oneOf(_utils.layoutTags),
-  childrenTag: _propTypes.default.oneOf(_utils.layoutTags)
+  tag: PropTypes.oneOf(layoutTags),
+  childrenTag: PropTypes.oneOf(layoutTags)
 };
-var _default = Timeline;
-exports.default = _default;
+export default Timeline;

package/lib/Timeline/index.js

@@ -1,10 +1,2 @@
-"use strict";
-
-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;
+import Timeline from './Timeline';
+export default Timeline;