@opentrons/step-generation 0.3.20-alpha.0 → 0.3.22-alpha.0

package/README.md

@@ -8,7 +8,7 @@
 
 ## Version
 
-`0.3.20-alpha.0`
+`0.3.22-alpha.0`
 
 ## License
 

package/lib/commandCreators/atomic/__tests__/absorbanceReaderInitialize.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/absorbanceReaderRead.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/heaterShakerCloseLatch.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/heaterShakerDeactivateHeater.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/heaterShakerSetTargetShakeSpeed.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/heaterShakerStopShake.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/absorbanceReaderCloseLid.d.ts

@@ -1,3 +1,2 @@
-import type { AbsorbanceReaderCloseLidCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const absorbanceReaderCloseLid: CommandCreator<AbsorbanceReaderCloseLidCreateCommand['params']>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const absorbanceReaderCloseLid: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/absorbanceReaderInitialize.d.ts

@@ -1,3 +1,2 @@
-import type { AbsorbanceReaderInitializeCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const absorbanceReaderInitialize: CommandCreator<AbsorbanceReaderInitializeCreateCommand['params']>;
+import type { AbsorbanceReaderInitializeStepGenArgs, CommandCreator } from '../../types';
+export declare const absorbanceReaderInitialize: CommandCreator<AbsorbanceReaderInitializeStepGenArgs>;

package/lib/commandCreators/atomic/absorbanceReaderOpenLid.d.ts

@@ -1,3 +1,2 @@
-import type { AbsorbanceReaderOpenLidCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const absorbanceReaderOpenLid: CommandCreator<AbsorbanceReaderOpenLidCreateCommand['params']>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const absorbanceReaderOpenLid: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/absorbanceReaderRead.d.ts

@@ -1,3 +1,2 @@
-import type { AbsorbanceReaderReadCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const absorbanceReaderRead: CommandCreator<AbsorbanceReaderReadCreateCommand['params']>;
+import type { AbsorbanceReaderReadStepGenArgs, CommandCreator } from '../../types';
+export declare const absorbanceReaderRead: CommandCreator<AbsorbanceReaderReadStepGenArgs>;

package/lib/commandCreators/atomic/aspirateInPlace.d.ts

@@ -1,3 +1,2 @@
-import type { AspirateInPlaceParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const aspirateInPlace: CommandCreator<AspirateInPlaceParams>;
+import type { AspirateInPlaceStepGenArgs, CommandCreator } from '../../types';
+export declare const aspirateInPlace: CommandCreator<AspirateInPlaceStepGenArgs>;

package/lib/commandCreators/atomic/aspirateWhileTracking.d.ts

@@ -1,3 +1,2 @@
-import type { AspirateWhileTrackingCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const aspirateWhileTracking: CommandCreator<AspirateWhileTrackingCreateCommand['params']>;
+import type { AspirateWhileTrackingStepGenArgs, CommandCreator } from '../../types';
+export declare const aspirateWhileTracking: CommandCreator<AspirateWhileTrackingStepGenArgs>;

package/lib/commandCreators/atomic/blowOutInPlace.d.ts

@@ -1,3 +1,2 @@
-import type { BlowoutInPlaceParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const blowOutInPlace: CommandCreator<BlowoutInPlaceParams>;
+import type { BlowOutInPlaceStepGenArgs, CommandCreator } from '../../types';
+export declare const blowOutInPlace: CommandCreator<BlowOutInPlaceStepGenArgs>;

package/lib/commandCreators/atomic/blowOutInWell.d.ts

@@ -1,3 +1,2 @@
-import type { BlowoutParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const blowOutInWell: CommandCreator<BlowoutParams>;
+import type { BlowOutInWellStepGenArgs, CommandCreator } from '../../types';
+export declare const blowOutInWell: CommandCreator<BlowOutInWellStepGenArgs>;

package/lib/commandCreators/atomic/configureForVolume.d.ts

@@ -1,3 +1,2 @@
-import type { ConfigureForVolumeParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const configureForVolume: CommandCreator<ConfigureForVolumeParams>;
+import type { CommandCreator, ConfigureForVolumeStepGenArgs } from '../../types';
+export declare const configureForVolume: CommandCreator<ConfigureForVolumeStepGenArgs>;

package/lib/commandCreators/atomic/configureNozzleLayout.d.ts

@@ -1,3 +1,2 @@
-import type { ConfigureNozzleLayoutParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const configureNozzleLayout: CommandCreator<ConfigureNozzleLayoutParams>;
+import type { CommandCreator, ConfigureNozzleLayoutStepGenArgs } from '../../types';
+export declare const configureNozzleLayout: CommandCreator<ConfigureNozzleLayoutStepGenArgs>;

package/lib/commandCreators/atomic/deactivateTemperature.d.ts

@@ -1,4 +1,3 @@
-import type { ModuleOnlyParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
 /** Disengage temperature target for specified module. */
-export declare const deactivateTemperature: CommandCreator<ModuleOnlyParams>;
+export declare const deactivateTemperature: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/dispenseInPlace.d.ts

@@ -1,7 +1,2 @@
-import type { DispenseInPlaceParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-interface DispenseInPlaceAtomicParams extends DispenseInPlaceParams {
-    isAirGap?: boolean;
-}
-export declare const dispenseInPlace: CommandCreator<DispenseInPlaceAtomicParams>;
-export {};
+import type { CommandCreator, DispenseInPlaceStepGenArgs } from '../../types';
+export declare const dispenseInPlace: CommandCreator<DispenseInPlaceStepGenArgs>;

package/lib/commandCreators/atomic/dispenseWhileTracking.d.ts

@@ -1,3 +1,2 @@
-import type { DispenseWhileTrackingParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const dispenseWhileTracking: CommandCreator<DispenseWhileTrackingParams>;
+import type { CommandCreator, DispenseWhileTrackingStepGenArgs } from '../../types';
+export declare const dispenseWhileTracking: CommandCreator<DispenseWhileTrackingStepGenArgs>;

package/lib/commandCreators/atomic/dropTip.d.ts

@@ -1,13 +1,6 @@
-import type { CommandCreator } from '../../types';
-interface DropTipArgs {
-    pipette: string;
-    wellName?: string;
-    dropTipLocation?: string;
-    isReturnTip?: boolean;
-}
+import type { CommandCreator, DropTipStepGenArgs } from '../../types';
 /**
  * Note that this command creator is now only applied to dropping tips into tipracks
  * For dropping tips into trash bins or waste chutes, use dropTipInWasteChute or dropTipInTrashBin
  */
-export declare const dropTip: CommandCreator<DropTipArgs>;
-export {};
+export declare const dropTip: CommandCreator<DropTipStepGenArgs>;

package/lib/commandCreators/atomic/heaterShakerCloseLatch.d.ts

@@ -1,3 +1,2 @@
-import type { ModuleOnlyParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const heaterShakerCloseLatch: CommandCreator<ModuleOnlyParams>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const heaterShakerCloseLatch: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/heaterShakerDeactivateHeater.d.ts

@@ -1,3 +1,2 @@
-import type { ModuleOnlyParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const heaterShakerDeactivateHeater: CommandCreator<ModuleOnlyParams>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const heaterShakerDeactivateHeater: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/heaterShakerOpenLatch.d.ts

@@ -1,3 +1,2 @@
-import type { ModuleOnlyParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const heaterShakerOpenLatch: CommandCreator<ModuleOnlyParams>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const heaterShakerOpenLatch: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/heaterShakerSetTargetShakeSpeed.d.ts

@@ -1,3 +1,2 @@
-import type { HeaterShakerSetAndWaitForShakeSpeedCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const heaterShakerSetTargetShakeSpeed: CommandCreator<HeaterShakerSetAndWaitForShakeSpeedCreateCommand['params']>;
+import type { CommandCreator, HeaterShakerSetTargetShakeSpeedStepGenArgs } from '../../types';
+export declare const heaterShakerSetTargetShakeSpeed: CommandCreator<HeaterShakerSetTargetShakeSpeedStepGenArgs>;

package/lib/commandCreators/atomic/heaterShakerStopShake.d.ts

@@ -1,3 +1,2 @@
-import type { ModuleOnlyParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const heaterShakerStopShake: CommandCreator<ModuleOnlyParams>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const heaterShakerStopShake: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/pickUpTip.d.ts

@@ -1,9 +1,2 @@
-import type { NozzleConfigurationStyle, PickUpTipParams, PrimaryNozzleConfigurationStyle } from '@opentrons/shared-data';
-import type { CommandCreator, TipTrackingOption } from '../../types';
-interface PickUpTipAtomicParams extends PickUpTipParams {
-    primaryNozzle: PrimaryNozzleConfigurationStyle;
-    nozzles: NozzleConfigurationStyle;
-    tipTrackingOption?: TipTrackingOption;
-}
-export declare const pickUpTip: CommandCreator<PickUpTipAtomicParams>;
-export {};
+import type { CommandCreator, PickUpTipStepGenArgs } from '../../types';
+export declare const pickUpTip: CommandCreator<PickUpTipStepGenArgs>;

package/lib/commandCreators/atomic/prepareToAspirate.d.ts

@@ -1,3 +1,2 @@
-import type { PrepareToAspirateParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const prepareToAspirate: CommandCreator<PrepareToAspirateParams>;
+import type { CommandCreator, PrepareToAspirateStepGenArgs } from '../../types';
+export declare const prepareToAspirate: CommandCreator<PrepareToAspirateStepGenArgs>;

package/lib/commandCreators/atomic/setTemperature.d.ts

@@ -1,4 +1,3 @@
-import type { TemperatureParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
+import type { CommandCreator, SetTemperatureStepGenArgs } from '../../types';
 /** Set temperature target for specified module. */
-export declare const setTemperature: CommandCreator<TemperatureParams>;
+export declare const setTemperature: CommandCreator<SetTemperatureStepGenArgs>;

package/lib/commandCreators/atomic/touchTip.d.ts

@@ -1,7 +1,2 @@
-import type { TouchTipParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-interface TouchTipAtomicParams extends Omit<TouchTipParams, 'wellLocation'> {
-    zOffsetFromTop: number;
-}
-export declare const touchTip: CommandCreator<TouchTipAtomicParams>;
-export {};
+import type { CommandCreator, TouchTipStepGenArgs } from '../../types';
+export declare const touchTip: CommandCreator<TouchTipStepGenArgs>;

package/lib/commandCreators/atomic/vacuumCloseVent.d.ts

@@ -1,2 +1,2 @@
-import type { CommandCreator, VacuumCloseVentArgs } from '../../types';
-export declare const vacuumCloseVent: CommandCreator<VacuumCloseVentArgs>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const vacuumCloseVent: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/vacuumOpenVent.d.ts

@@ -1,3 +1,2 @@
-import type { VacuumModuleOpenVentCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const vacuumOpenVent: CommandCreator<VacuumModuleOpenVentCreateCommand['params']>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const vacuumOpenVent: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/vacuumSetPumpPower.d.ts

@@ -1,2 +1,2 @@
-import type { CommandCreator, VacuumPumpPowerArgs } from '../../types';
-export declare const vacuumSetPumpPower: CommandCreator<VacuumPumpPowerArgs>;
+import type { CommandCreator, VacuumSetPumpPowerStepGenArgs } from '../../types';
+export declare const vacuumSetPumpPower: CommandCreator<VacuumSetPumpPowerStepGenArgs>;

package/lib/commandCreators/atomic/vacuumSetPumpPressure.d.ts

@@ -1,2 +1,2 @@
-import type { CommandCreator, VacuumPumpPressureArgs } from '../../types';
-export declare const vacuumSetPumpPressure: CommandCreator<VacuumPumpPressureArgs>;
+import type { CommandCreator, VacuumSetPumpPressureStepGenArgs } from '../../types';
+export declare const vacuumSetPumpPressure: CommandCreator<VacuumSetPumpPressureStepGenArgs>;

package/lib/commandCreators/atomic/vacuumStartRunProfile.d.ts

@@ -1,2 +1,2 @@
-import type { CommandCreator, VacuumStartRunProfileArgs } from '../../types';
-export declare const vacuumStartRunProfile: CommandCreator<VacuumStartRunProfileArgs>;
+import type { CommandCreator, VacuumStartRunProfileStepGenArgs } from '../../types';
+export declare const vacuumStartRunProfile: CommandCreator<VacuumStartRunProfileStepGenArgs>;

package/lib/commandCreators/atomic/vacuumStopPump.d.ts

@@ -1,3 +1,2 @@
-import type { VacuumModuleStopPumpCreateCommand } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
-export declare const vacuumStopPump: CommandCreator<VacuumModuleStopPumpCreateCommand['params']>;
+import type { CommandCreator, ModuleStepGenArgs } from '../../types';
+export declare const vacuumStopPump: CommandCreator<ModuleStepGenArgs>;

package/lib/commandCreators/atomic/waitForTemperature.d.ts

@@ -1,4 +1,3 @@
-import type { TemperatureParams } from '@opentrons/shared-data';
-import type { CommandCreator } from '../../types';
+import type { CommandCreator, WaitForTemperatureStepGenArgs } from '../../types';
 /** Set temperature target for specified module. */
-export declare const waitForTemperature: CommandCreator<TemperatureParams>;
+export declare const waitForTemperature: CommandCreator<WaitForTemperatureStepGenArgs>;

package/lib/constants.d.ts

@@ -57,4 +57,8 @@ export declare const VACUUM_VENT_SET_CLOSED: 'closed';
 export declare const VACUUM_DEACTIVATED: 'VACUUM_DEACTIVATED';
 export declare const VACUUM_AT_TARGET: 'VACUUM_AT_TARGET';
 export declare const VACUUM_SPACER_LOAD_NAMES: string[];
+export declare const MAX_STACKABLE_VACUUM_SPACERS = 3;
 export declare const VACUUM_DOCK_DISPLAY_LOCATION: 'A4';
+export declare const NOZZLE_STYLES: readonly string[];
+export declare const PRIMARY_NOZZLES: readonly string[];
+export declare const BACK_LEFT_NOZZLES: readonly string[];

package/lib/errorCreators.d.ts

@@ -29,6 +29,9 @@ export declare function tipVolumeExceeded(args: {
     volume: string | number;
     maxVolume: string | number;
 }): CommandCreatorError;
+export declare function invalidRuntimeParameter(args: {
+    parameterName: string;
+}): CommandCreatorError;
 export declare function pipetteVolumeExceeded(args: {
     actionName: string;
     volume: string | number;