Moved / renamed Spectrum utils (deephaven#1909)

packages/code-studio/src/styleguide/Pickers.tsx

@@ -1,13 +1,14 @@
 import React, { useCallback, useState } from 'react';
 import {
   Flex,
+  Item,
   Picker,
   PickerItemKey,
   Section,
   Text,
 } from '@deephaven/components';
 import { vsPerson } from '@deephaven/icons';
-import { Icon, Item } from '@adobe/react-spectrum';
+import { Icon } from '@adobe/react-spectrum';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { sampleSectionIdAndClasses } from './utils';
 

packages/components/src/index.ts

@@ -49,7 +49,6 @@ export * from './SelectValueList';
 export * from './shortcuts';
 export { default as SocketedButton } from './SocketedButton';
 export * from './spectrum';
-export * from './spectrum/utils';
 export * from './TableViewEmptyState';
 export * from './TextWithTooltip';
 export * from './theme';

packages/components/src/spectrum/picker/Picker.tsx

@@ -1,6 +1,6 @@
 import { Key, ReactNode, useCallback, useMemo } from 'react';
 import { DOMRef } from '@react-types/shared';
-import { Flex, Picker as SpectrumPicker, Text } from '@adobe/react-spectrum';
+import { Flex, Picker as SpectrumPicker } from '@adobe/react-spectrum';
 import {
   getPositionOfSelectedItem,
   findSpectrumPickerScrollArea,
@@ -24,9 +24,10 @@ import {
   TooltipOptions,
   PickerItemKey,
   getPickerItemKey,
-} from './PickerUtils';
+} from '../utils/itemUtils';
 import { PickerItemContent } from './PickerItemContent';
 import { Item, Section } from '../shared';
+import { Text } from '../Text';
 
 export type PickerProps = {
   children:

packages/components/src/spectrum/picker/index.ts

@@ -1,2 +1,2 @@
 export * from './Picker';
-export * from './PickerUtils';
+export * from './PickerItemContent';

packages/components/src/spectrum/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './itemUtils';
+export * from './themeUtils';

packages/components/src/spectrum/picker/PickerUtils.test.tsx → packages/components/src/spectrum/utils/itemUtils.test.tsx

@@ -14,8 +14,8 @@ import {
   PickerItem,
   PickerItemOrSection,
   PickerSection,
-} from './PickerUtils';
-import type { PickerProps } from './Picker';
+} from './itemUtils';
+import type { PickerProps } from '../picker/Picker';
 import { Item, Section } from '../shared';
 import { Text } from '../Text';
 

packages/components/src/spectrum/picker/PickerUtils.ts → packages/components/src/spectrum/utils/itemUtils.ts

@@ -123,12 +123,14 @@ export function isItemElement<T>(
  * @param node The node to check
  * @returns True if the node is a normalized item with keys array
  */
-export function isNormalizedItemsWithKeysList(
+export function isNormalizedItemsWithKeysList<
+  TItemOrSection extends PickerItemOrSection,
+>(
   node:
-    | PickerItemOrSection
-    | PickerItemOrSection[]
+    | TItemOrSection
+    | TItemOrSection[]
     | (NormalizedPickerItem | NormalizedPickerSection)[]
-): node is (NormalizedPickerItem | NormalizedPickerSection)[] {
+): node is NormalizedItemOrSection<TItemOrSection>[] {
   if (!Array.isArray(node)) {
     return false;
   }
@@ -234,9 +236,9 @@ function normalizeTextValue(item: PickerItem): string | undefined {
  * @param itemOrSection item to normalize
  * @returns NormalizedPickerItem object
  */
-function normalizePickerItem(
-  itemOrSection: PickerItemOrSection
-): NormalizedPickerItem | NormalizedPickerSection {
+function normalizePickerItem<TItemOrSection extends PickerItemOrSection>(
+  itemOrSection: TItemOrSection
+): NormalizedItemOrSection<TItemOrSection> {
   if (!isPickerItemOrSection(itemOrSection)) {
     log.debug(INVALID_PICKER_ITEM_ERROR_MESSAGE, itemOrSection);
     throw new Error(INVALID_PICKER_ITEM_ERROR_MESSAGE);
@@ -253,7 +255,7 @@ function normalizePickerItem(
 
     return {
       item: { key, title, items },
-    };
+    } as NormalizedItemOrSection<TItemOrSection>;
   }
 
   const key = normalizeItemKey(itemOrSection);
@@ -264,26 +266,30 @@ function normalizePickerItem(
 
   return {
     item: { key, content, textValue },
-  };
+  } as NormalizedItemOrSection<TItemOrSection>;
 }
 
+type NormalizedItemOrSection<TItemOrSection extends PickerItemOrSection> =
+  TItemOrSection extends PickerSection
+    ? NormalizedPickerSection
+    : NormalizedPickerItem;
+
 /**
  * Get normalized picker items from a picker item or array of picker items.
  * @param itemsOrSections A picker item or array of picker items
  * @returns An array of normalized picker items
  */
-export function normalizePickerItemList(
-  itemsOrSections:
-    | PickerItemOrSection
-    | PickerItemOrSection[]
-    | NormalizedPickerItem[]
-): (NormalizedPickerItem | NormalizedPickerSection)[] {
+export function normalizePickerItemList<
+  TItemOrSection extends PickerItemOrSection,
+>(
+  itemsOrSections: TItemOrSection | TItemOrSection[] | NormalizedPickerItem[]
+): NormalizedItemOrSection<TItemOrSection>[] {
   // If already normalized, just return as-is
   if (isNormalizedItemsWithKeysList(itemsOrSections)) {
-    return itemsOrSections;
+    return itemsOrSections as NormalizedItemOrSection<TItemOrSection>[];
   }
 
-  const itemsArray = Array.isArray(itemsOrSections)
+  const itemsArray: TItemOrSection[] = Array.isArray(itemsOrSections)
     ? itemsOrSections
     : [itemsOrSections];
 

packages/components/src/spectrum/utils.test.ts → packages/components/src/spectrum/utils/themeUtils.test.ts

@@ -1,4 +1,4 @@
-import { themeDHDefault } from './utils';
+import { themeDHDefault } from './themeUtils';
 
 describe('themeDHDefault', () => {
   it('should merge Spectrum default with DH custom styles', () => {

packages/components/src/spectrum/utils.ts → packages/components/src/spectrum/utils/themeUtils.ts

@@ -1,5 +1,5 @@
 import { theme } from '@react-spectrum/theme-default';
-import { themeSpectrumClassesCommon } from '../theme/theme-spectrum';
+import { themeSpectrumClassesCommon } from '../../theme/theme-spectrum';
 
 const { global, light, dark, medium, large } = theme;