@opentrons/components 0.2.0-alpha.0 → 0.2.0-alpha.4

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getLoadCommandText.ts

@@ -1,173 +0,0 @@
-import find from 'lodash/find'
-
-import {
-  getAllLiquidClassDefs,
-  getModuleDisplayName,
-  getModuleType,
-  getOccludedSlotCountForModule,
-  getPipetteSpecsV2,
-  THERMOCYCLER_MODULE_V1,
-  THERMOCYCLER_MODULE_V2,
-} from '@opentrons/shared-data'
-
-import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
-import { getLabwareName } from '../getLabwareName'
-import { getLiquidDisplayName } from '../getLiquidDisplayName'
-import { getPipetteNameOnMount } from '../getPipetteNameOnMount'
-
-import type { GetCommandText } from '../..'
-
-export const getLoadCommandText = ({
-  command,
-  commandTextData,
-  robotType,
-  t,
-  allRunDefs,
-}: GetCommandText): string => {
-  switch (command?.commandType) {
-    case 'loadPipette': {
-      const pipetteModel =
-        commandTextData != null
-          ? getPipetteNameOnMount(
-              commandTextData.pipettes,
-              command.params.mount
-            )
-          : null
-      return t('load_pipette_protocol_setup', {
-        pipette_name:
-          pipetteModel != null
-            ? getPipetteSpecsV2(pipetteModel)?.displayName ?? ''
-            : '',
-        mount_name: command.params.mount === 'left' ? t('left') : t('right'),
-      })
-    }
-    case 'loadModule': {
-      const occludedSlotCount = getOccludedSlotCountForModule(
-        getModuleType(command.params.model),
-        robotType
-      )
-      let slotName = command.params.location.slotName
-      if (
-        THERMOCYCLER_MODULE_V2 === command.params.model ||
-        THERMOCYCLER_MODULE_V1 === command.params.model
-      ) {
-        slotName = 'A1 + B1'
-      }
-      return t('load_module_protocol_setup', {
-        count: occludedSlotCount,
-        module: getModuleDisplayName(command.params.model),
-        slot_name: slotName,
-      })
-    }
-    case 'loadLid':
-    case 'loadLabware': {
-      const location = getLabwareDisplayLocation({
-        location: command.result?.locationSequence ?? command.params.location,
-        robotType,
-        allRunDefs,
-        loadedLabwares: commandTextData?.labware ?? [],
-        loadedModules: commandTextData?.modules ?? [],
-        t,
-      })
-      const labwareName =
-        'displayName' in command.params && command.params.displayName != null
-          ? command.params.displayName
-          : command.result?.definition.metadata.displayName
-
-      // use in preposition for modules and slots, on for labware and adapters
-      let displayLocation = t('in_location', { location })
-      if (
-        command.params.location === 'offDeck' ||
-        command.params.location === 'systemLocation'
-      ) {
-        displayLocation = location
-      } else if ('labwareId' in command.params.location) {
-        displayLocation = t('on_location', { location })
-      }
-
-      return t('load_labware_to_display_location', {
-        labware: labwareName,
-        display_location: displayLocation,
-      })
-    }
-    case 'loadLidStack': {
-      // this will be the case if the system creates an empty stack to move lids onto
-      if (command.result?.definition == null) {
-        return t('load_lid_stack_empty')
-      }
-      const location =
-        command.result?.stackLocationSequence != null
-          ? getLabwareDisplayLocation({
-              location: command.result.stackLocationSequence,
-              robotType,
-              allRunDefs,
-              loadedLabwares: commandTextData?.labware ?? [],
-              loadedModules: commandTextData?.modules ?? [],
-              t,
-            })
-          : ''
-      // use in preposition for modules and slots, on for labware and adapters
-      let displayLocation = t('in_location', { location })
-      if (
-        command.params.location !== 'systemLocation' &&
-        command.params.location !== 'offDeck' &&
-        'labwareId' in command.params.location
-      ) {
-        displayLocation = t('on_location', { location })
-      }
-      const lidName = command.result.definition.metadata.displayName
-      const quantity = command.params.quantity
-      return t('load_lid_stack', {
-        quantity,
-        labware: lidName,
-        display_location: displayLocation,
-      })
-    }
-    case 'reloadLabware': {
-      const { labwareId } = command.params
-      const labware =
-        commandTextData != null
-          ? getLabwareName({
-              loadedLabwares: commandTextData?.labware ?? [],
-              labwareId,
-              allRunDefs,
-            })
-          : null
-      return t('reloading_labware', { labware })
-    }
-    case 'loadLiquid': {
-      const { liquidId, labwareId } = command.params
-      return t('load_liquids_info_protocol_setup', {
-        liquid:
-          commandTextData != null
-            ? getLiquidDisplayName(commandTextData.liquids ?? [], liquidId)
-            : null,
-        labware:
-          commandTextData != null
-            ? getLabwareName({
-                loadedLabwares: commandTextData?.labware ?? [],
-                labwareId,
-                allRunDefs,
-              })
-            : null,
-      })
-    }
-    case 'loadLiquidClass': {
-      const { liquidClassName } = command.params.liquidClassRecord
-      const liquidClassDisplayName = find(
-        getAllLiquidClassDefs(),
-        liquidClassDef => liquidClassDef.liquidClassName === liquidClassName
-      )?.displayName
-      return t('load_liquid_class', {
-        liquidClassDisplayName,
-      })
-    }
-    default: {
-      console.warn(
-        'LoadCommandText encountered a command with an unrecognized commandType: ',
-        command
-      )
-      return ''
-    }
-  }
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveLabwareCommandText.ts

@@ -1,108 +0,0 @@
-import { GRIPPER_WASTE_CHUTE_ADDRESSABLE_AREA } from '@opentrons/shared-data'
-
-import { getFinalLabwareLocation } from '../getFinalLabwareLocation'
-import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
-import { getLabwareName } from '../getLabwareName'
-
-import type { MoveLabwareRunTimeCommand } from '@opentrons/shared-data'
-import type { HandlesCommands } from '../types'
-
-export function getMoveLabwareCommandText({
-  command,
-  allRunDefs,
-  t,
-  commandTextData,
-  robotType,
-}: HandlesCommands<MoveLabwareRunTimeCommand>): string {
-  const { labwareId, newLocation, strategy } = command.params
-  let oldDisplayLocation = null
-  let newDisplayLocation = null
-  if (
-    command.result?.originLocationSequence != null &&
-    command.result?.immediateDestinationLocationSequence != null
-  ) {
-    oldDisplayLocation = getLabwareDisplayLocation({
-      location: command.result.originLocationSequence,
-      robotType,
-      allRunDefs,
-      loadedLabwares: commandTextData?.labware ?? [],
-      loadedModules: commandTextData?.modules ?? [],
-      t,
-    })
-    newDisplayLocation = getLabwareDisplayLocation({
-      location: command.result.immediateDestinationLocationSequence,
-      robotType,
-      allRunDefs,
-      loadedLabwares: commandTextData?.labware ?? [],
-      loadedModules: commandTextData?.modules ?? [],
-      t,
-    })
-  } else {
-    const allPreviousCommands = commandTextData?.commands.slice(
-      0,
-      commandTextData.commands.findIndex(c => c.id === command.id)
-    )
-    const oldLocation =
-      allPreviousCommands != null
-        ? getFinalLabwareLocation(labwareId, allPreviousCommands)
-        : null
-
-    oldDisplayLocation = getLabwareDisplayLocation({
-      location: oldLocation?.location,
-      robotType,
-      allRunDefs,
-      loadedLabwares: commandTextData?.labware ?? [],
-      loadedModules: commandTextData?.modules ?? [],
-      t,
-    })
-    newDisplayLocation = getLabwareDisplayLocation({
-      location: newLocation,
-      robotType,
-      allRunDefs,
-      loadedLabwares: commandTextData?.labware ?? [],
-      loadedModules: commandTextData?.modules ?? [],
-      t,
-    })
-  }
-
-  // add waste chute to i18n
-  const location = newDisplayLocation?.includes(
-    GRIPPER_WASTE_CHUTE_ADDRESSABLE_AREA
-  )
-    ? 'Waste Chute'
-    : newDisplayLocation
-
-  // system location is an off deck location we create lid stacks in and
-  // move them to and should not be exposed to the user
-  if (oldDisplayLocation === 'systemLocation') {
-    return t('move_lid_stack_to_deck', { slot_name: newDisplayLocation })
-  } else if (newDisplayLocation === 'systemLocation') {
-    return t('move_lid_stack_from_deck', { slot_name: oldDisplayLocation })
-  }
-
-  return strategy === 'usingGripper'
-    ? t('move_labware_using_gripper', {
-        labware:
-          commandTextData != null
-            ? getLabwareName({
-                allRunDefs,
-                loadedLabwares: commandTextData.labware ?? [],
-                labwareId,
-              })
-            : null,
-        old_location: oldDisplayLocation,
-        new_location: location,
-      })
-    : t('move_labware_manually', {
-        labware:
-          commandTextData != null
-            ? getLabwareName({
-                allRunDefs,
-                loadedLabwares: commandTextData.labware ?? [],
-                labwareId,
-              })
-            : null,
-        old_location: oldDisplayLocation,
-        new_location: location,
-      })
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveRelativeCommandText.ts

@@ -1,11 +0,0 @@
-import type { MoveRelativeRunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-export function getMoveRelativeCommandText({
-  command,
-  t,
-}: HandlesCommands<MoveRelativeRunTimeCommand>): string {
-  const { axis, distance } = command.params
-
-  return t('move_relative', { axis, distance })
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToAddressableAreaCommandText.ts

@@ -1,19 +0,0 @@
-import { getAddressableAreaDisplayName } from '../getAddressableAreaDisplayName'
-
-import type { MoveToAddressableAreaRunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-export function getMoveToAddressableAreaCommandText({
-  command,
-  commandTextData,
-  t,
-}: HandlesCommands<MoveToAddressableAreaRunTimeCommand>): string {
-  const addressableAreaDisplayName =
-    commandTextData != null
-      ? getAddressableAreaDisplayName(commandTextData.commands, command.id, t)
-      : null
-
-  return t('move_to_addressable_area', {
-    addressable_area: addressableAreaDisplayName,
-  })
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToAddressableAreaForDropTipCommandText.ts

@@ -1,19 +0,0 @@
-import { getAddressableAreaDisplayName } from '../getAddressableAreaDisplayName'
-
-import type { MoveToAddressableAreaForDropTipRunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-export function getMoveToAddressableAreaForDropTipCommandText({
-  command,
-  commandTextData,
-  t,
-}: HandlesCommands<MoveToAddressableAreaForDropTipRunTimeCommand>): string {
-  const addressableAreaDisplayName =
-    commandTextData != null
-      ? getAddressableAreaDisplayName(commandTextData.commands, command.id, t)
-      : null
-
-  return t('move_to_addressable_area_drop_tip', {
-    addressable_area: addressableAreaDisplayName,
-  })
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToCoordinatesCommandText.ts

@@ -1,11 +0,0 @@
-import type { MoveToCoordinatesRunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-export function getMoveToCoordinatesCommandText({
-  command,
-  t,
-}: HandlesCommands<MoveToCoordinatesRunTimeCommand>): string {
-  const { coordinates } = command.params
-
-  return t('move_to_coordinates', coordinates)
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToSlotCommandText.ts

@@ -1,11 +0,0 @@
-import type { MoveToSlotRunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-export function getMoveToSlotCommandText({
-  command,
-  t,
-}: HandlesCommands<MoveToSlotRunTimeCommand>): string {
-  const { slotName } = command.params
-
-  return t('move_to_slot', { slot_name: slotName })
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToWellCommandText.ts

@@ -1,62 +0,0 @@
-import { getFinalLabwareLocation } from '../getFinalLabwareLocation'
-import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
-import { getLabwareName } from '../getLabwareName'
-
-import type { MoveToWellRunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-export function getMoveToWellCommandText({
-  command,
-  allRunDefs,
-  t,
-  commandTextData,
-  robotType,
-}: HandlesCommands<MoveToWellRunTimeCommand>): string {
-  const { wellName, labwareId, wellLocation } = command.params
-  const {
-    x: xOffsetUnformatted,
-    y: yOffsetUnformatted,
-    z: zOffsetUnformatted,
-  } = wellLocation?.offset ?? { x: '', y: '', z: '' }
-  const allPreviousCommands = commandTextData?.commands.slice(
-    0,
-    commandTextData.commands.findIndex(c => c.id === command.id)
-  )
-  const labwareLocation =
-    allPreviousCommands != null
-      ? getFinalLabwareLocation(labwareId, allPreviousCommands)
-      : null
-
-  const displayLocation = getLabwareDisplayLocation({
-    loadedLabwares: commandTextData?.labware ?? [],
-    location: labwareLocation?.locationSequence ?? labwareLocation?.location,
-    robotType,
-    allRunDefs,
-    loadedModules: commandTextData?.modules ?? [],
-    t,
-  })
-
-  const xOffset =
-    typeof xOffsetUnformatted === 'number' ? xOffsetUnformatted?.toFixed(2) : ''
-  const yOffset =
-    typeof yOffsetUnformatted === 'number' ? yOffsetUnformatted?.toFixed(2) : ''
-  const zOffset =
-    typeof zOffsetUnformatted === 'number' ? zOffsetUnformatted?.toFixed(2) : ''
-
-  return t('move_to_well', {
-    wellName,
-    labware:
-      commandTextData != null
-        ? getLabwareName({
-            loadedLabwares: commandTextData.labware ?? [],
-            labwareId,
-            allRunDefs,
-          })
-        : null,
-    xOffset,
-    yOffset,
-    zOffset,
-    positionRelative: wellLocation?.origin,
-    displayLocation,
-  })
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getPipettingCommandText.ts

@@ -1,206 +0,0 @@
-import { getLabwareDefURI } from '@opentrons/shared-data'
-
-import { getAddressableAreaDisplayName } from '../getAddressableAreaDisplayName'
-import { getFinalMoveToAddressableAreaCmd } from '../getFinalAddressableAreaCmd'
-import { getFinalLabwareLocation } from '../getFinalLabwareLocation'
-import { getLabwareDefinitionsFromCommands } from '../getLabwareDefinitionsFromCommands'
-import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
-import { getLabwareName } from '../getLabwareName'
-import { getLoadedLabware } from '../getLoadedLabware'
-import { getWellRange } from '../getWellRange'
-
-import type { PipetteName, RunTimeCommand } from '@opentrons/shared-data'
-import type { GetCommandText } from '../..'
-
-export const getPipettingCommandText = ({
-  command,
-  allRunDefs,
-  commandTextData,
-  robotType,
-  t,
-}: GetCommandText): string => {
-  const labwareId =
-    command != null && 'labwareId' in command.params
-      ? (command.params.labwareId as string)
-      : ''
-  const wellName =
-    command != null && 'wellName' in command.params
-      ? command.params.wellName
-      : ''
-
-  const allPreviousCommands = commandTextData?.commands.slice(
-    0,
-    commandTextData.commands.findIndex(c => c.id === command?.id)
-  )
-  const labwareLocation =
-    allPreviousCommands != null
-      ? getFinalLabwareLocation(
-          labwareId,
-          allPreviousCommands as RunTimeCommand[]
-        )
-      : null
-
-  const displayLocation = getLabwareDisplayLocation({
-    loadedLabwares: commandTextData?.labware ?? [],
-    location: labwareLocation?.locationSequence ?? labwareLocation?.location,
-    robotType,
-    allRunDefs,
-    loadedModules: commandTextData?.modules ?? [],
-    t,
-  })
-
-  const labwareName =
-    commandTextData != null
-      ? getLabwareName({
-          loadedLabwares: commandTextData.labware ?? [],
-          labwareId,
-          allRunDefs,
-        })
-      : null
-
-  const volume = formatCmdParamDecimal(command, 'volume')
-  const flowRate = formatCmdParamDecimal(command, 'flowRate')
-  const pushOutVolume = formatCmdParamDecimal(command, 'pushOut')
-
-  switch (command?.commandType) {
-    case 'aspirate': {
-      return t('aspirate', {
-        well_name: wellName,
-        labware: labwareName,
-        labware_location: displayLocation,
-        volume,
-        flow_rate: flowRate,
-      })
-    }
-    case 'dispense': {
-      return pushOutVolume != null
-        ? t('dispense_push_out', {
-            well_name: wellName,
-            labware: labwareName,
-            labware_location: displayLocation,
-            volume,
-            flow_rate: flowRate,
-            push_out_volume: pushOutVolume,
-          })
-        : t('dispense', {
-            well_name: wellName,
-            labware: labwareName,
-            labware_location: displayLocation,
-            volume,
-            flow_rate: flowRate,
-          })
-    }
-    case 'blowout': {
-      return t('blowout', {
-        well_name: wellName,
-        labware: labwareName,
-        labware_location: displayLocation,
-        flow_rate: flowRate,
-      })
-    }
-    case 'dropTip': {
-      const loadedLabware =
-        commandTextData != null
-          ? getLoadedLabware(commandTextData.labware ?? [], labwareId)
-          : null
-      const labwareDefinitions =
-        commandTextData != null
-          ? getLabwareDefinitionsFromCommands(
-              commandTextData.commands as RunTimeCommand[]
-            )
-          : null
-      const labwareDef = labwareDefinitions?.find(
-        lw => getLabwareDefURI(lw) === loadedLabware?.definitionUri
-      )
-      return Boolean(labwareDef?.parameters.isTiprack)
-        ? t('return_tip', {
-            well_name: wellName,
-            labware: labwareName,
-            labware_location: displayLocation,
-          })
-        : t('drop_tip', {
-            well_name: wellName,
-            labware: labwareName,
-          })
-    }
-    case 'pickUpTip': {
-      const pipetteId = command.params.pipetteId
-      const pipetteName:
-        | PipetteName
-        | undefined = commandTextData?.pipettes.find(
-        pipette => pipette.id === pipetteId
-      )?.pipetteName
-
-      return t('pickup_tip', {
-        well_range:
-          allPreviousCommands != null
-            ? getWellRange(
-                pipetteId,
-                allPreviousCommands as RunTimeCommand[],
-                wellName as string,
-                pipetteName
-              )
-            : null,
-        labware: labwareName,
-        labware_location: displayLocation,
-      })
-    }
-    case 'dropTipInPlace': {
-      const cmd = getFinalMoveToAddressableAreaCmd(allPreviousCommands ?? [])
-
-      if (cmd != null) {
-        const displayName = getAddressableAreaDisplayName([cmd], cmd?.id, t)
-        return t('dropping_tip_in_trash', { trash: displayName })
-      } else {
-        return t('drop_tip_in_place')
-      }
-    }
-    case 'dispenseInPlace': {
-      return t('dispense_in_place', { volume, flow_rate: flowRate })
-    }
-    case 'blowOutInPlace': {
-      return t('blowout_in_place', { flow_rate: flowRate })
-    }
-    case 'aspirateInPlace': {
-      return t('aspirate_in_place', { volume, flow_rate: flowRate })
-    }
-    case 'airGapInPlace': {
-      return t('air_gap_in_place', { volume })
-    }
-    case 'sealPipetteToTip': {
-      return t('sealing_to_location', {
-        labware: labwareName,
-        location: displayLocation,
-      })
-    }
-    case 'unsealPipetteFromTip': {
-      return t('unsealing_from_location', {
-        labware: labwareName,
-        location: displayLocation,
-      })
-    }
-    case 'pressureDispense': {
-      return t('pressurizing_to_dispense', { volume, flow_rate: flowRate })
-    }
-    default: {
-      console.warn(
-        'PipettingCommandText encountered a command with an unrecognized commandType: ',
-        command
-      )
-      return ''
-    }
-  }
-}
-
-// Format the given command param to two decimals if it exists and can be cast as a number.
-const formatCmdParamDecimal = (
-  command: RunTimeCommand | null | undefined,
-  paramName: string
-): string | null =>
-  command?.params &&
-  paramName in command.params &&
-  command.params[paramName as keyof typeof command.params] != null
-    ? Number(command.params[paramName as keyof typeof command.params]).toFixed(
-        2
-      )
-    : null

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getPrepareToAspirateCommandText.ts

@@ -1,20 +0,0 @@
-import { getPipetteSpecsV2 } from '@opentrons/shared-data'
-
-import type { PrepareToAspirateRunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-export function getPrepareToAspirateCommandText({
-  command,
-  commandTextData,
-  t,
-}: HandlesCommands<PrepareToAspirateRunTimeCommand>): string {
-  const { pipetteId } = command.params
-  const pipetteName = commandTextData?.pipettes.find(
-    pip => pip.id === pipetteId
-  )?.pipetteName
-
-  return t('prepare_to_aspirate', {
-    pipette:
-      pipetteName != null ? getPipetteSpecsV2(pipetteName)?.displayName : '',
-  })
-}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getRailLightsCommandText.ts

@@ -1,15 +0,0 @@
-import type { RunTimeCommand } from '@opentrons/shared-data/command'
-import type { HandlesCommands } from '../types'
-
-type HandledCommands = Extract<RunTimeCommand, { commandType: 'setRailLights' }>
-
-export type GetRailLightsCommandText = HandlesCommands<HandledCommands>
-
-export function getRailLightsCommandText({
-  command,
-  t,
-}: GetRailLightsCommandText): string {
-  return command.params.on
-    ? t('turning_rail_lights_on')
-    : t('turning_rail_lights_off')
-}