add more liquidEntities work

protocol-designer/src/file-data/selectors/fileCreator.ts

@@ -27,10 +27,12 @@ import { getFileMetadata, getRobotType } from './fileFields'
 import { getInitialRobotState, getRobotStateTimeline } from './commands'
 import { getLoadCommands } from './utils'
 
+import type { SecondOrderCommandAnnotation } from '@opentrons/shared-data/commandAnnotation/types'
 import type {
   PipetteEntity,
   LabwareEntities,
   PipetteEntities,
+  LiquidEntities,
 } from '@opentrons/step-generation'
 import type {
   CommandAnnotationV1Mixin,
@@ -43,10 +45,22 @@ import type {
   ProtocolBase,
   ProtocolFile,
 } from '@opentrons/shared-data'
+import type { DismissedWarningState } from '../../dismiss/reducers'
 import type { LabwareDefByDefURI } from '../../labware-defs'
 import type { Selector } from '../../types'
-import type { DesignerApplicationData } from '../../load-file/migration/utils/getLoadLiquidCommands'
-import type { SecondOrderCommandAnnotation } from '@opentrons/shared-data/commandAnnotation/types'
+
+export interface DesignerApplicationDataV8 {
+  ingredients: LiquidEntities
+  ingredLocations: {
+    [labwareId: string]: {
+      [wellName: string]: { [liquidId: string]: { volume: number } }
+    }
+  }
+  savedStepForms: Record<string, any>
+  orderedStepIds: string[]
+  pipetteTiprackAssignments: Record<string, string[]>
+  dismissedWarnings: DismissedWarningState
+}
 
 // TODO: BC: 2018-02-21 uncomment this assert, causes test failures
 // console.assert(!isEmpty(process.env.OT_PD_VERSION), 'Could not find application version!')
@@ -92,7 +106,7 @@ export const createFile: Selector<ProtocolFile> = createSelector(
   getRobotStateTimeline,
   getRobotType,
   dismissSelectors.getAllDismissedWarnings,
-  ingredSelectors.getLiquidGroupsById,
+  stepFormSelectors.getLiquidEntities,
   ingredSelectors.getLiquidsByLabwareId,
   stepFormSelectors.getSavedStepForms,
   stepFormSelectors.getOrderedStepIds,
@@ -108,7 +122,7 @@ export const createFile: Selector<ProtocolFile> = createSelector(
     robotStateTimeline,
     robotType,
     dismissedWarnings,
-    ingredients,
+    liquidEntities,
     ingredLocations,
     savedStepForms,
     orderedStepIds,
@@ -127,7 +141,7 @@ export const createFile: Selector<ProtocolFile> = createSelector(
       moduleEntities,
       labwareEntities,
       labwareNicknamesById,
-      ingredients,
+      liquidEntities,
       ingredLocations
     )
 
@@ -159,20 +173,20 @@ export const createFile: Selector<ProtocolFile> = createSelector(
             p.tiprackDefURI
         ),
         dismissedWarnings,
-        ingredients,
+        ingredients: liquidEntities,
         ingredLocations,
         savedStepForms,
         orderedStepIds: savedOrderedStepIds,
       },
     }
 
     const liquids: ProtocolFile['liquids'] = reduce(
-      ingredients,
+      liquidEntities,
       (acc, liquidData, liquidId) => {
         return {
           ...acc,
           [liquidId]: {
-            displayName: liquidData.name,
+            displayName: liquidData.displayName,
             description: liquidData.description ?? '',
             displayColor: liquidData.displayColor ?? swatchColors(liquidId),
           },
@@ -253,7 +267,7 @@ export const createFile: Selector<ProtocolFile> = createSelector(
       commandAnnotations,
     }
 
-    const protocolBase: ProtocolBase<DesignerApplicationData> = {
+    const protocolBase: ProtocolBase<DesignerApplicationDataV8> = {
       $otSharedSchema: '#/protocol/schemas/8',
       schemaVersion: 8,
       metadata: {

protocol-designer/src/file-data/selectors/utils.ts

@@ -20,8 +20,8 @@ import type {
   RobotState,
   ModuleEntities,
   TimelineFrame,
+  LiquidEntities,
 } from '@opentrons/step-generation'
-import type { LiquidGroupsById } from '../../labware-ingred/types'
 
 interface Pipettes {
   [pipetteId: string]: { name: PipetteName }
@@ -33,7 +33,7 @@ export const getLoadCommands = (
   moduleEntities: ModuleEntities,
   labwareEntities: LabwareEntities,
   labwareNicknamesById: Record<string, string>,
-  ingredients: LiquidGroupsById,
+  liquidEntities: LiquidEntities,
   ingredLocations: LabwareLiquidState
 ): CreateCommand[] => {
   const pipettes: Pipettes = mapValues(
@@ -161,7 +161,10 @@ export const getLoadCommands = (
     []
   )
 
-  const loadLiquidCommands = getLoadLiquidCommands(ingredients, ingredLocations)
+  const loadLiquidCommands = getLoadLiquidCommands(
+    liquidEntities,
+    ingredLocations
+  )
 
   const loadModuleCommands = map(
     initialRobotState.modules,

protocol-designer/src/labware-ingred/actions/actions.ts

@@ -203,9 +203,7 @@ export interface EditLiquidGroupAction {
 }
 // NOTE: with no ID, a new one is assigned
 export const editLiquidGroup: (
-  args: IngredInputs & {
-    liquidGroupId: string | null | undefined
-  }
+  args: IngredInputs
 ) => ThunkAction<EditLiquidGroupAction> = args => (dispatch, getState) => {
   const { liquidGroupId, ...payloadArgs } = args // NOTE: separate liquidGroupId for flow to understand unpacking :/
 

protocol-designer/src/labware-ingred/reducers/index.ts

@@ -296,7 +296,6 @@ export const ingredients: Reducer<IngredientsState, any> = handleActions(
     LOAD_FILE: (
       state: IngredientsState,
       action: LoadFileAction
-      //  TODO: get this info from loadLiquid
     ): IngredientsState => getPDMetadata(action.payload.file).ingredients,
   },
   {}
@@ -352,7 +351,6 @@ export const ingredLocations: Reducer<LocationsState, any> = handleActions(
     LOAD_FILE: (
       state: LocationsState,
       action: LoadFileAction
-      //  TODO: get this info from loadLiquid
     ): LocationsState => getPDMetadata(action.payload.file).ingredLocations,
   },
   {}

protocol-designer/src/labware-ingred/selectors.ts

@@ -5,7 +5,10 @@ import max from 'lodash/max'
 import reduce from 'lodash/reduce'
 import type { Selector } from 'reselect'
 import type { DropdownOption } from '@opentrons/components'
-import type { LabwareLiquidState, LiquidEntity } from '@opentrons/step-generation'
+import type {
+  LabwareLiquidState,
+  LiquidEntity,
+} from '@opentrons/step-generation'
 import type { CutoutId } from '@opentrons/shared-data'
 import type {
   RootState,
@@ -18,17 +21,16 @@ import type {
 import type {
   AllIngredGroupFields,
   IngredInputs,
-  OrderedLiquids,
   ZoomedIntoSlotInfoState,
 } from './types'
 import type { BaseState, DeckSlot } from './../types'
+
 // TODO: Ian 2019-02-15 no RootSlice, use BaseState
 interface RootSlice {
   labwareIngred: RootState
 }
 
 const rootSelector = (state: RootSlice): RootState => state.labwareIngred
-
 // NOTE: not intended for UI use! Use getLabwareNicknamesById for the string.
 const getLabwareNameInfo: Selector<RootSlice, ContainersState> = createSelector(
   rootSelector,
@@ -53,10 +55,10 @@ const getLiquidNamesById: Selector<
 > = createSelector(
   getLiquidGroupsById,
   ingredGroups =>
-    mapValues(ingredGroups, (ingred: LiquidEntity) => ingred.displayName) as Record<
-      string,
-      string
-    >
+    mapValues(
+      ingredGroups,
+      (ingred: LiquidEntity) => ingred.displayName
+    ) as Record<string, string>
 )
 const getLiquidSelectionOptions: Selector<
   RootSlice,
@@ -104,17 +106,7 @@ const allIngredientGroupFields: Selector<
     {}
   )
 )
-const allIngredientNamesIds: Selector<
-  RootSlice,
-  OrderedLiquids
-> = createSelector(getLiquidGroupsById, ingreds => {
-  return Object.keys(ingreds).map(ingredId => ({
-    ingredientId: ingredId,
-    name: ingreds[ingredId].displayName,
-    displayColor: ingreds[ingredId].displayColor,
-    liquidClass: ingreds[ingredId].liquidClass,
-  }))
-})
+
 const getLabwareSelectionMode: Selector<RootSlice, boolean> = createSelector(
   rootSelector,
   rootState => {
@@ -181,7 +173,6 @@ const getIsNewProtocol: Selector<RootSlice, boolean> = createSelector(
 // TODO: prune selectors
 export const selectors = {
   rootSelector,
-  getLiquidGroupsById,
   getLiquidsByLabwareId,
   getLiquidNamesById,
   getLabwareSelectionMode,
@@ -194,7 +185,6 @@ export const selectors = {
   getSelectedLiquidGroupState,
   getDrillDownLabwareId,
   allIngredientGroupFields,
-  allIngredientNamesIds,
   selectedAddLabwareSlot,
   getDeckHasLiquid,
   getLiquidDisplayColors,

protocol-designer/src/labware-ingred/types.ts

@@ -1,5 +1,9 @@
 import type { CutoutId, ModuleModel } from '@opentrons/shared-data'
-import type { DeckSlot, LiquidEntity, LocationLiquidState } from '@opentrons/step-generation'
+import type {
+  DeckSlot,
+  LiquidEntity,
+  LocationLiquidState,
+} from '@opentrons/step-generation'
 // TODO Ian 2018-02-19 make these shared in component library, standardize with Run App
 //  ===== LABWARE ===========
 export interface DisplayLabware {
@@ -21,16 +25,6 @@ export interface WellContents {
 }
 export type ContentsByWell = Record<string, WellContents> | null
 export type WellContentsByLabware = Record<string, ContentsByWell>
-// ==== INGREDIENTS ====
-// TODO(ND: 12/17/2024): add migration for liquids in >8.3.0
-export type OrderedLiquids = Array<{
-  ingredientId: string
-  displayName?: string | null
-  displayColor?: string | null
-  liquidClass?: string | null
-}>
-// TODO: Ian 2018-10-15 audit & rename these confusing types
-
 export type IngredInputs = LiquidEntity & {
   volume?: number | null
 }

protocol-designer/src/load-file/migration/utils/getLoadLiquidCommands.ts

@@ -2,6 +2,8 @@ import reduce from 'lodash/reduce'
 import { uuid } from '../../../utils'
 import type { LoadLiquidCreateCommand } from '@opentrons/shared-data/protocol/types/schemaV6/command/setup'
 import type { DismissedWarningState } from '../../../dismiss/reducers'
+import { DesignerApplicationDataV8 } from '../../../file-data/selectors'
+import { LiquidEntities, LiquidEntity } from '@opentrons/step-generation'
 
 export interface DesignerApplicationData {
   ingredients: Record<
@@ -24,7 +26,7 @@ export interface DesignerApplicationData {
 }
 
 export const getLoadLiquidCommands = (
-  ingredients?: DesignerApplicationData['ingredients'],
+  ingredients?: DesignerApplicationData['ingredients'] | LiquidEntities,
   ingredLocations?: DesignerApplicationData['ingredLocations']
 ): LoadLiquidCreateCommand[] => {
   let loadLiquidCommands: LoadLiquidCreateCommand[] = []

protocol-designer/src/organisms/AssignLiquidsModal/LiquidToolbox.tsx

@@ -19,6 +19,7 @@ import {
   Toolbox,
   TYPOGRAPHY,
 } from '@opentrons/components'
+import { getLiquidEntities } from '../../step-forms/selectors'
 import { LINK_BUTTON_STYLE } from '../../atoms'
 import { selectors as labwareIngredSelectors } from '../../labware-ingred/selectors'
 import * as wellContentsSelectors from '../../top-selectors/well-contents'
@@ -64,7 +65,7 @@ export function LiquidToolbox(props: LiquidToolboxProps): JSX.Element {
   const dispatch = useDispatch()
   const [showDefineLiquidModal, setDefineLiquidModal] = useState<boolean>(false)
   const [showBadFormState, setShowBadFormState] = useState<boolean>(false)
-  const liquids = useSelector(labwareIngredSelectors.allIngredientNamesIds)
+  const liquids = useSelector(getLiquidEntities)
   const labwareId = useSelector(labwareIngredSelectors.getSelectedLabwareId)
   const selectedWellGroups = useSelector(getSelectedWells)
   const nickNames = useSelector(getLabwareNicknamesById)
@@ -236,11 +237,11 @@ export function LiquidToolbox(props: LiquidToolboxProps): JSX.Element {
   const liquidInfo: LiquidInfo[] = uniqueLiquids
     .map(liquid => {
       const foundLiquid = Object.values(liquids).find(
-        id => id.ingredientId === liquid
+        id => id.liquidGroupId === liquid
       )
       return {
         liquidIndex: liquid,
-        name: foundLiquid?.name ?? '',
+        name: foundLiquid?.displayName ?? '',
         color: foundLiquid?.displayColor ?? '',
         liquidClassDisplayName: getLiquidClassDisplayName(
           foundLiquid?.liquidClass ?? null
@@ -347,8 +348,9 @@ export function LiquidToolbox(props: LiquidToolboxProps): JSX.Element {
                           render={({ field }) => {
                             const fullOptions: DropdownOption[] = liquidSelectionOptions.map(
                               option => {
-                                const liquid = liquids.find(
-                                  liquid => liquid.ingredientId === option.value
+                                const liquid = Object.values(liquids).find(
+                                  liquid =>
+                                    liquid.liquidGroupId === option.value
                                 )
 
                                 return {