refactor(app): migrate useHomePipettes to local-resources

app/src/local-resources/instruments/hooks/index.ts

@@ -0,0 +1,5 @@
+export * from './useGripperDisplayName'
+export * from './useHomePipettes'
+export * from './usePipetteModelSpecs'
+export * from './usePipetteNameSpecs'
+export * from './usePipetteSpecsv2'

app/src/local-resources/instruments/hooks/useGripperDisplayName.ts

@@ -0,0 +1,19 @@
+import { getGripperDisplayName, GRIPPER_MODELS } from '@opentrons/shared-data'
+import { useIsOEMMode } from '/app/resources/robot-settings'
+
+import type { GripperModel } from '@opentrons/shared-data'
+
+export function useGripperDisplayName(gripperModel: GripperModel): string {
+  const isOEMMode = useIsOEMMode()
+
+  let brandedDisplayName = ''
+
+  // check to only call display name helper for a gripper model
+  if (GRIPPER_MODELS.includes(gripperModel)) {
+    brandedDisplayName = getGripperDisplayName(gripperModel)
+  }
+
+  const anonymizedDisplayName = brandedDisplayName.replace('Flex ', '')
+
+  return isOEMMode ? anonymizedDisplayName : brandedDisplayName
+}

app/src/organisms/DropTipWizardFlows/hooks/useHomePipettes.ts → app/src/local-resources/instruments/hooks/useHomePipettes.ts

@@ -1,12 +1,13 @@
 import { useRobotControlCommands } from '/app/resources/maintenance_runs'
 
 import type { CreateCommand } from '@opentrons/shared-data'
+
 import type {
   UseRobotControlCommandsProps,
   UseRobotControlCommandsResult,
 } from '/app/resources/maintenance_runs'
 
-interface UseHomePipettesResult {
+export interface UseHomePipettesResult {
   isHoming: UseRobotControlCommandsResult['isExecuting']
   homePipettes: UseRobotControlCommandsResult['executeCommands']
 }
@@ -15,7 +16,7 @@ export type UseHomePipettesProps = Pick<
   UseRobotControlCommandsProps,
   'pipetteInfo' | 'onSettled'
 >
-// TODO(jh, 09-12-24): Find a better place for this hook to live.
+
 // Home pipettes except for plungers.
 export function useHomePipettes(
   props: UseHomePipettesProps

app/src/local-resources/instruments/hooks/usePipetteModelSpecs.ts

@@ -0,0 +1,24 @@
+import { getPipetteModelSpecs } from '@opentrons/shared-data'
+
+import { usePipetteNameSpecs } from './usePipetteNameSpecs'
+
+import type {
+  PipetteModel,
+  PipetteModelSpecs,
+  PipetteName,
+} from '@opentrons/shared-data'
+
+export function usePipetteModelSpecs(
+  model: PipetteModel
+): PipetteModelSpecs | null {
+  const modelSpecificFields = getPipetteModelSpecs(model)
+  const pipetteNameSpecs = usePipetteNameSpecs(
+    modelSpecificFields?.name as PipetteName
+  )
+
+  if (modelSpecificFields == null || pipetteNameSpecs == null) {
+    return null
+  }
+
+  return { ...modelSpecificFields, displayName: pipetteNameSpecs.displayName }
+}

app/src/local-resources/instruments/hooks/usePipetteNameSpecs.ts

@@ -0,0 +1,26 @@
+import { getPipetteNameSpecs } from '@opentrons/shared-data'
+
+import { useIsOEMMode } from '/app/resources/robot-settings'
+
+import type { PipetteName, PipetteNameSpecs } from '@opentrons/shared-data'
+
+export function usePipetteNameSpecs(
+  name: PipetteName
+): PipetteNameSpecs | null {
+  const isOEMMode = useIsOEMMode()
+  const pipetteNameSpecs = getPipetteNameSpecs(name)
+
+  if (pipetteNameSpecs == null) {
+    return null
+  }
+
+  const brandedDisplayName = pipetteNameSpecs.displayName
+  const anonymizedDisplayName = pipetteNameSpecs.displayName.replace(
+    'Flex ',
+    ''
+  )
+
+  const displayName = isOEMMode ? anonymizedDisplayName : brandedDisplayName
+
+  return { ...pipetteNameSpecs, displayName }
+}

app/src/local-resources/instruments/hooks/usePipetteSpecsv2.ts

@@ -0,0 +1,27 @@
+import { getPipetteSpecsV2 } from '@opentrons/shared-data'
+
+import { useIsOEMMode } from '/app/resources/robot-settings'
+
+import type {
+  PipetteModel,
+  PipetteName,
+  PipetteV2Specs,
+} from '@opentrons/shared-data'
+
+export function usePipetteSpecsV2(
+  name?: PipetteName | PipetteModel
+): PipetteV2Specs | null {
+  const isOEMMode = useIsOEMMode()
+  const pipetteSpecs = getPipetteSpecsV2(name)
+
+  if (pipetteSpecs == null) {
+    return null
+  }
+
+  const brandedDisplayName = pipetteSpecs.displayName
+  const anonymizedDisplayName = pipetteSpecs.displayName.replace('Flex ', '')
+
+  const displayName = isOEMMode ? anonymizedDisplayName : brandedDisplayName
+
+  return { ...pipetteSpecs, displayName }
+}

app/src/organisms/Desktop/Devices/ProtocolRun/ProtocolRunHeader/RunHeaderModalContainer/modals/ProtocolDropTipModal.tsx

@@ -16,14 +16,12 @@ import {
 } from '@opentrons/components'
 
 import { TextOnlyButton } from '/app/atoms/buttons'
-import { useHomePipettes } from '/app/organisms/DropTipWizardFlows'
+import { useHomePipettes } from '/app/local-resources/instruments'
 
 import type { PipetteData } from '@opentrons/api-client'
 import type { IconProps } from '@opentrons/components'
-import type {
-  UseHomePipettesProps,
-  TipAttachmentStatusResult,
-} from '/app/organisms/DropTipWizardFlows'
+import type { UseHomePipettesProps } from '/app/local-resources/instruments'
+import type { TipAttachmentStatusResult } from '/app/organisms/DropTipWizardFlows'
 
 type UseProtocolDropTipModalProps = Pick<
   UseHomePipettesProps,

app/src/organisms/Desktop/Devices/ProtocolRun/ProtocolRunHeader/RunHeaderModalContainer/modals/__tests__/ProtocolDropTipModal.test.tsx

@@ -4,15 +4,15 @@ import { renderHook, act, screen, fireEvent } from '@testing-library/react'
 
 import { renderWithProviders } from '/app/__testing-utils__'
 import { i18n } from '/app/i18n'
-import { useHomePipettes } from '/app/organisms/DropTipWizardFlows'
+import { useHomePipettes } from '/app/local-resources/instruments'
 import {
   useProtocolDropTipModal,
   ProtocolDropTipModal,
 } from '../ProtocolDropTipModal'
 
 import type { Mock } from 'vitest'
 
-vi.mock('/app/organisms/DropTipWizardFlows')
+vi.mock('/app/local-resources/instruments')
 
 describe('useProtocolDropTipModal', () => {
   let props: Parameters<typeof useProtocolDropTipModal>[0]

app/src/organisms/DropTipWizardFlows/TipsAttachedModal.tsx

@@ -14,11 +14,12 @@ import { FLEX_ROBOT_TYPE } from '@opentrons/shared-data'
 import { SmallButton } from '/app/atoms/buttons'
 import { OddModal } from '/app/molecules/OddModal'
 import { DropTipWizardFlows, useDropTipWizardFlows } from '.'
-import { useHomePipettes } from './hooks'
+import { useHomePipettes } from '/app/local-resources/instruments'
 
 import type { HostConfig } from '@opentrons/api-client'
 import type { OddModalHeaderBaseProps } from '/app/molecules/OddModal/types'
-import type { UseHomePipettesProps, PipetteWithTip } from './hooks'
+import type { UseHomePipettesProps } from '/app/local-resources/instruments'
+import type { PipetteWithTip } from './hooks'
 import type { PipetteDetails } from '/app/resources/maintenance_runs'
 
 type TipsAttachedModalProps = Pick<UseHomePipettesProps, 'onSettled'> & {

app/src/organisms/DropTipWizardFlows/hooks/index.ts

@@ -1,6 +1,5 @@
 export * from './errors'
 export * from './useDropTipWithType'
-export * from './useHomePipettes'
 export * from './useTipAttachmentStatus'
 export * from './useDropTipLocations'
 export { useDropTipRouting } from './useDropTipRouting'

app/src/organisms/DropTipWizardFlows/index.ts

@@ -1,10 +1,6 @@
 export * from './DropTipWizardFlows'
-export { useTipAttachmentStatus, useHomePipettes } from './hooks'
+export { useTipAttachmentStatus } from './hooks'
 export * from './TipsAttachedModal'
 
-export type {
-  UseHomePipettesProps,
-  TipAttachmentStatusResult,
-  PipetteWithTip,
-} from './hooks'
+export type { TipAttachmentStatusResult, PipetteWithTip } from './hooks'
 export type { FixitCommandTypeUtils } from './types'