feat(protocol-designer, step-generation): wire flexStacker formToArgs (#20334)

# Overview

This PR wires up the stacker step form fields to step generation by
transforming forms to arguments and creates commands for all possible
stacker steps

## Test Plan and Hands on Testing

- wrote unit tests, will need to be smoke tested later

## Changelog

- added flex stacker command types for step generation
- connected commands to form

Author: rclarke0

protocol-designer/src/file-data/helpers/index.ts

@@ -103,9 +103,29 @@ export const commandCreatorFromStepArgs = (
         StepGeneration.absorbanceReaderCloseInitialize,
         args
       )
+    case 'flexStackerEmpty':
+      return StepGeneration.curryCommandCreator(
+        StepGeneration.flexStackerEmpty,
+        { ...args, strategy: 'logical' }
+      )
+    case 'flexStackerFillItems':
+      return StepGeneration.curryCommandCreator(
+        StepGeneration.flexStackerFill,
+        { ...args, strategy: 'manualWithPause' }
+      )
+    case 'flexStackerRetrieve':
+      return StepGeneration.curryCommandCreator(
+        StepGeneration.flexStackerRetrieve,
+        args
+      )
+    case 'flexStackerStore':
+      return StepGeneration.curryCommandCreator(
+        StepGeneration.flexStackerStore,
+        { ...args, strategy: 'automatic' }
+      )
   }
   // @ts-expect-error we've exhausted all command creators, but keeping this console warn
-  // for when we impelement the next command creator
+  // for when we implement the next command creator
   console.warn(`unhandled commandCreatorFnName: ${args.commandCreatorFnName}`)
   return null
 }

protocol-designer/src/steplist/formLevel/stepFormToArgs/flexStackerFormToArgs.ts

@@ -0,0 +1,43 @@
+import type { FlexStackerArgs } from '@opentrons/step-generation'
+import type { HydratedFlexStackerFormData } from '../../../form-types'
+import type { GetCastFormData } from '../../fieldLevel'
+
+export const flexStackerFormToArgs = (
+  castFormData: GetCastFormData<HydratedFlexStackerFormData>
+): FlexStackerArgs | null => {
+  const {
+    fillLabwareUri,
+    flexStackerFormType,
+    interventionMessage,
+    moduleId,
+    fillQuantity,
+  } = castFormData
+  switch (flexStackerFormType) {
+    case 'empty':
+      return {
+        moduleId: moduleId!,
+        commandCreatorFnName: 'flexStackerEmpty',
+        interventionMessage: interventionMessage,
+      }
+    case 'fill':
+      return {
+        moduleId: moduleId!,
+        commandCreatorFnName: 'flexStackerFillItems',
+        fillLabwareUri: fillLabwareUri,
+        fillQuantity: fillQuantity,
+      }
+    case 'retrieve':
+      return {
+        moduleId: moduleId!,
+        commandCreatorFnName: 'flexStackerRetrieve',
+      }
+    case 'store':
+      return {
+        moduleId: moduleId!,
+        commandCreatorFnName: 'flexStackerStore',
+      }
+
+    default:
+      return null
+  }
+}

protocol-designer/src/steplist/formLevel/stepFormToArgs/index.ts

@@ -4,6 +4,7 @@ import { castField } from '../../../steplist/fieldLevel'
 import { absorbanceReaderFormToArgs } from './absorbanceReaderFormToArgs'
 import { cameraFormToArgs } from './cameraFormToArgs'
 import { commentFormToArgs } from './commentFormToArgs'
+import { flexStackerFormToArgs } from './flexStackerFormToArgs'
 import { heaterShakerFormToArgs } from './heaterShakerFormToArgs'
 import { magnetFormToArgs } from './magnetFormToArgs'
 import { mixFormToArgs } from './mixFormToArgs'
@@ -85,6 +86,9 @@ export const stepFormToArgs = (
       stepArgs = absorbanceReaderFormToArgs(_castForm(hydratedForm))
       break
     }
+    case 'flexStacker': {
+      stepArgs = flexStackerFormToArgs(_castForm(hydratedForm))
+    }
   }
 
   if (stepArgs == null) {

protocol-designer/src/steplist/formLevel/stepFormToArgs/test/flexStackerFormToArgs.test.ts

@@ -0,0 +1,77 @@
+import { beforeEach, describe, expect, it } from 'vitest'
+
+import { flexStackerFormToArgs } from '../flexStackerFormToArgs'
+
+import type {
+  FlexStackerFormType,
+  HydratedFlexStackerFormData,
+} from '/protocol-designer/form-types'
+import type { GetCastFormData } from '/protocol-designer/steplist/fieldLevel'
+
+describe('flexStackerFormToArgs', () => {
+  let baseFormData: GetCastFormData<HydratedFlexStackerFormData>
+  beforeEach(() => {
+    baseFormData = {
+      stepType: 'flexStacker',
+      id: 'stacker-id',
+      fillLabwareUri: null,
+      fillQuantity: null,
+      flexStackerFormType: null,
+      interventionMessage: null,
+      moduleId: 'moduleId',
+      stepName: 'step name',
+      stepDetails: 'stacker fill step',
+      stepNumber: 1,
+    }
+  })
+  it('returns flex stacker empty command creator', () => {
+    const formData = {
+      ...baseFormData,
+      flexStackerFormType: 'empty' as FlexStackerFormType,
+      interventionMessage: 'empty message',
+    }
+    const expected = {
+      moduleId: 'moduleId',
+      commandCreatorFnName: 'flexStackerEmpty',
+      interventionMessage: 'empty message',
+    }
+    expect(flexStackerFormToArgs(formData)).toEqual(expected)
+  })
+  it('returns flex stacker fill command creator', () => {
+    const formData = {
+      ...baseFormData,
+      flexStackerFormType: 'fill' as FlexStackerFormType,
+      fillLabwareUri: 'labware',
+      fillQuantity: 1,
+    }
+    const expected = {
+      moduleId: 'moduleId',
+      commandCreatorFnName: 'flexStackerFillItems',
+      fillLabwareUri: 'labware',
+      fillQuantity: 1,
+    }
+    expect(flexStackerFormToArgs(formData)).toEqual(expected)
+  })
+  it('returns flex stacker retrieve command creator', () => {
+    const formData = {
+      ...baseFormData,
+      flexStackerFormType: 'retrieve' as FlexStackerFormType,
+    }
+    const expected = {
+      moduleId: 'moduleId',
+      commandCreatorFnName: 'flexStackerRetrieve',
+    }
+    expect(flexStackerFormToArgs(formData)).toEqual(expected)
+  })
+  it('returns flex stacker store command creator', () => {
+    const formData = {
+      ...baseFormData,
+      flexStackerFormType: 'store' as FlexStackerFormType,
+    }
+    const expected = {
+      moduleId: 'moduleId',
+      commandCreatorFnName: 'flexStackerStore',
+    }
+    expect(flexStackerFormToArgs(formData)).toEqual(expected)
+  })
+})

step-generation/src/commandCreators/atomic/index.ts

@@ -19,6 +19,10 @@ import { dispenseInPlace } from './dispenseInPlace'
 import { dropTip } from './dropTip'
 import { dropTipInPlace } from './dropTipInPlace'
 import { engageMagnet } from './engageMagnet'
+import { flexStackerEmpty } from './flexStackerEmpty'
+import { flexStackerFill } from './flexStackerFill'
+import { flexStackerRetrieve } from './flexStackerRetrieve'
+import { flexStackerStore } from './flexStackerStore'
 import { liquidProbe } from './liquidProbe'
 import { moveLabware } from './moveLabware'
 import { moveToAddressableArea } from './moveToAddressableArea'
@@ -52,6 +56,10 @@ export {
   dropTip,
   dropTipInPlace,
   engageMagnet,
+  flexStackerEmpty,
+  flexStackerFill,
+  flexStackerRetrieve,
+  flexStackerStore,
   liquidProbe,
   moveLabware,
   moveToAddressableArea,

step-generation/src/commandCreators/index.ts

@@ -29,6 +29,10 @@ export {
   dropTip,
   dropTipInPlace,
   engageMagnet,
+  flexStackerEmpty,
+  flexStackerFill,
+  flexStackerRetrieve,
+  flexStackerStore,
   moveLabware,
   moveToAddressableArea,
   moveToAddressableAreaForDropTip,

step-generation/src/index.ts

@@ -20,6 +20,10 @@ export {
   dropTipInTrash,
   dropTipInWasteChute,
   engageMagnet,
+  flexStackerEmpty,
+  flexStackerFill,
+  flexStackerRetrieve,
+  flexStackerStore,
   heaterShaker,
   mix,
   moveLabware,

step-generation/src/types.ts

@@ -634,6 +634,32 @@ export interface CaptureImageArgs extends CommonArgs {
   saturation: number
 }
 
+export interface FlexStackerEmptyArgs extends CommonArgs {
+  moduleId: string
+  commandCreatorFnName: 'flexStackerEmpty'
+  interventionMessage: string | null
+}
+export interface FlexStackerFillItemsArgs extends CommonArgs {
+  moduleId: string
+  commandCreatorFnName: 'flexStackerFillItems'
+  fillLabwareUri: string | null
+  fillQuantity: number | null
+}
+export interface FlexStackerStoreArgs extends CommonArgs {
+  moduleId: string
+  commandCreatorFnName: 'flexStackerStore'
+}
+export interface FlexStackerRetrieveArgs extends CommonArgs {
+  moduleId: string
+  commandCreatorFnName: 'flexStackerRetrieve'
+}
+
+export type FlexStackerArgs =
+  | FlexStackerEmptyArgs
+  | FlexStackerFillItemsArgs
+  | FlexStackerRetrieveArgs
+  | FlexStackerStoreArgs
+
 export type CommandCreatorArgs =
   | AbsorbanceReaderInitializeArgs
   | AbsorbanceReaderReadArgs
@@ -654,6 +680,7 @@ export type CommandCreatorArgs =
   | HeaterShakerArgs
   | MoveLabwareArgs
   | CommentArgs
+  | FlexStackerArgs
 
 export interface LocationLiquidState {
   [ingredGroup: string]: { volume: number }