@spaced-out/ui-design-system 0.1.27 → 0.1.29

package/lib/utils/tokens.js.flow

@@ -1,82 +0,0 @@
-// @flow strict
-
-type TokenObject = {[key: string]: string};
-export type SortOrder = 'asc' | 'desc';
-export type SortBy = 'name' | 'value';
-
-/**
- *
- * This function takes in an object containing key-value pairs of tokens,
- * where values are strings representing numerical
- * values with optional percentage or viewport units. It also takes in an optional
- * sort order ('asc' or 'desc') and an optional sort by parameter ('name' or 'value').
- *
- * The function sorts the tokens by either their key names (if sortBy='name') or their
- * numerical values (if sortBy='value'). The sort order can be specified as
- * ascending (order='asc') or descending (order='desc').
- *
- * The function handles values with different units by comparing their numerical values.
- * If both values have the same unit, their numerical values are compared directly.
- * If their units are different, tokens with percentage values are considered greater than
- * those with viewport units, and tokens without a percentage or viewport unit are compared
- * based on their numerical values.
- *
- */
-export const getSortedTokenNames = (
-  obj: TokenObject,
-  order?: SortOrder = 'asc',
-  sortBy?: SortBy = 'value',
-): Array<string> => {
-  // Create an array from the object keys and sort the array
-  const sortedTokens = Object.keys(obj).sort((token1, token2) => {
-    const value1 = obj[token1];
-    const value2 = obj[token2];
-
-    // Convert value1 to a number
-    const numValue1 = parseFloat(value1);
-    // Convert value2 to a number
-    const numValue2 = parseFloat(value2);
-
-    if (sortBy === 'name') {
-      // Sorting by name
-      return order === 'asc'
-        ? token1.localeCompare(token2) // Compare key names directly
-        : token2.localeCompare(token1);
-    } else {
-      const isPercentage1 = value1.endsWith('%');
-      const isPercentage2 = value2.endsWith('%');
-      const isViewport1 = value1.endsWith('vw') || value1.endsWith('vh');
-      const isViewport2 = value2.endsWith('vw') || value2.endsWith('vh');
-
-      if ((isPercentage1 && isPercentage2) || (isViewport1 && isViewport2)) {
-        // If both tokens have the same unit (percentage or viewport), compare their numerical values
-        return order === 'asc' ? numValue1 - numValue2 : numValue2 - numValue1;
-      }
-
-      if (isPercentage1 && !isPercentage2) {
-        // Only token1 has a percentage value, consider it greater than token2
-        return order === 'asc' ? 1 : -1;
-      }
-
-      if (!isPercentage1 && isPercentage2) {
-        // Only token2 has a percentage value, consider it greater than token1
-        return order === 'asc' ? -1 : 1;
-      }
-
-      if (isViewport1 && !isViewport2) {
-        // Only token1 has a viewport unit value, consider it greater than token2
-        return order === 'asc' ? 1 : -1;
-      }
-
-      if (!isViewport1 && isViewport2) {
-        // Only token2 has a viewport unit value, consider it greater than token1
-        return order === 'asc' ? -1 : 1;
-      }
-
-      // Neither token has a percentage or viewport unit value, compare their numerical values
-      return order === 'asc' ? numValue1 - numValue2 : numValue2 - numValue1;
-    }
-  });
-
-  return sortedTokens;
-};