@opentrons/step-generation 0.3.3-alpha.0 → 0.3.5-alpha.0

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { ABSORBANCE_READER_TYPE, AddressableArea, CreateCommand, FLEX_STACKER_MODULE_TYPE, FlexStackerStoredLabwareGroup, HEATERSHAKER_MODULE_TYPE, Height, LabwareDefinition2, LabwareLocation, LabwareMovementStrategy, LoadedLabwareLocation, MAGNETIC_BLOCK_TYPE, MAGNETIC_MODULE_TYPE, ModuleModel, ModuleType, PipetteMount as Mount, NozzleConfigurationStyle, PipetteName, PipetteV2Specs, PositionReference, PrimaryNozzleConfigurationStyle, ShakeSpeedParams, StackerStoredLabwareDefinitionURIs, TCExtendedProfileParams, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, VACUUM_MODULE_TYPE, VacuumRunProfileParams, Width } from '@opentrons/shared-data';
+import type { ABSORBANCE_READER_TYPE, AddressableArea, CommonArgs, CreateCommand, FLEX_STACKER_MODULE_TYPE, FlexStackerStoredLabwareGroup, HEATERSHAKER_MODULE_TYPE, Height, LabwareDefinition2, LabwareLocation, LabwareMovementStrategy, LoadedLabwareLocation, MAGNETIC_BLOCK_TYPE, MAGNETIC_MODULE_TYPE, ModuleModel, ModuleType, PipetteMount as Mount, NozzleConfigurationStyle, OpentronsAIArgs, PipetteName, PipetteV2Specs, PositionReference, PrimaryNozzleConfigurationStyle, ShakeSpeedParams, StackerStoredLabwareDefinitionURIs, TCExtendedProfileParams, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, VACUUM_MODULE_TYPE, VacuumRunProfileParams, Width } from '@opentrons/shared-data';
 import type { AUTOMATIC, CLEAN, DIRTY, EMPTY, MANUAL, TEMPERATURE_APPROACHING_TARGET, TEMPERATURE_AT_TARGET, TEMPERATURE_DEACTIVATED, VACUUM_MODE_POWER, VACUUM_MODE_PRESSURE, VACUUM_VENT_CLOSED, VACUUM_VENT_OPEN } from './constants';
 export type DeckSlot = string;
 type THERMOCYCLER_STATE = 'thermocyclerState';
@@ -244,18 +244,6 @@ export interface InnerMixArgs {
 export interface InnerDelayArgs {
     seconds: number;
 }
-interface CommonArgs {
-    /** NOTE: stepNumber probably shouldn't be optional but making it optional
-     * for the sake of not having to make too many changes for PD 8.5.2
-     * this should be refactored to not be optional for PD 8.6.0
-     * making it optional saves a lot of changes in unit tests
-     */
-    stepNumber?: number;
-    /** Optional user-readable name for this step */
-    name?: string | null;
-    /** Optional user-readable description/notes for this step */
-    description?: string | null;
-}
 export type SharedTransferLikeArgs = CommonArgs & {
     tipRack: string;
     pipette: string;
@@ -670,7 +658,7 @@ export interface VacuumCloseVentStartProfileArgs extends CommonArgs {
 }
 export type VacuumArgs = VacuumPumpArgs | VacuumStartRunProfileArgs | VacuumOpenVentArgs | VacuumCloseVentArgs | VacuumStopPumpArgs;
 export type FlexStackerArgs = FlexStackerEmptyArgs | FlexStackerFillItemsArgs | FlexStackerRetrieveArgs | FlexStackerStoreArgs;
-export type CommandCreatorArgs = AbsorbanceReaderInitializeArgs | AbsorbanceReaderReadArgs | AbsorbanceReaderLidArgs | ConsolidateArgs | CaptureImageArgs | DistributeArgs | MixArgs | PauseArgs | WaitForModuleTaskArgs | TransferArgs | EngageMagnetArgs | DisengageMagnetArgs | SetTemperatureArgs | WaitForTemperatureArgs | DeactivateTemperatureArgs | ThermocyclerProfileStepArgs | ThermocyclerStateStepArgs | HeaterShakerArgs | MoveLabwareArgs | CommentArgs | FlexStackerArgs | VacuumArgs;
+export type CommandCreatorArgs = AbsorbanceReaderInitializeArgs | AbsorbanceReaderReadArgs | AbsorbanceReaderLidArgs | ConsolidateArgs | CaptureImageArgs | DistributeArgs | MixArgs | PauseArgs | WaitForModuleTaskArgs | TransferArgs | EngageMagnetArgs | DisengageMagnetArgs | SetTemperatureArgs | WaitForTemperatureArgs | DeactivateTemperatureArgs | ThermocyclerProfileStepArgs | ThermocyclerStateStepArgs | HeaterShakerArgs | MoveLabwareArgs | CommentArgs | FlexStackerArgs | VacuumArgs | OpentronsAIArgs;
 export interface LocationLiquidState {
     [ingredGroup: string]: {
         volume: number;

package/lib/utils/getCommandCreatorFromStepArgs.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreatorArgs, CurriedCommandCreator } from '../types';
+export declare const getCommandCreatorFromStepArgs: (args: CommandCreatorArgs) => CurriedCommandCreator | null;

package/lib/utils/getTransformedWellsForPartialColumn.d.ts

@@ -0,0 +1,6 @@
+import type { LabwareDefinition2, PartialPrimaryNozzles } from '@opentrons/shared-data';
+export declare const getTransformedWellsForPartialColumn: (args: {
+    labwareDef: LabwareDefinition2;
+    wells: string[];
+    primaryNozzle: PartialPrimaryNozzles;
+}) => string[];

package/lib/utils/index.d.ts

@@ -20,4 +20,5 @@ export * from './pythonFormat';
 export * from './safePipetteMovements';
 export * from './thermocyclerProfileConversions';
 export * from './traversals';
+export * from './getCommandCreatorFromStepArgs';
 export declare const uuid: () => string;

package/lib/utils/misc.d.ts

@@ -4,6 +4,7 @@ import type { CommandCreator, CurriedCommandCreator, FlexStackerModuleState, Inv
 export declare const AIR: '__air__';
 export declare const SOURCE_WELL_BLOWOUT_DESTINATION: 'source_well';
 export declare const DEST_WELL_BLOWOUT_DESTINATION: 'dest_well';
+export declare function getIsVacuumSpacer(def: LabwareDefinition2): boolean;
 type trashOrLabware = 'wasteChute' | 'trashBin' | 'labware' | null;
 export declare const getCutoutIdByAddressableArea: (addressableAreaName: AddressableAreaName, cutoutFixtureId: CutoutFixtureId, robotType: RobotType) => CutoutId;
 export declare function getWasteChuteAddressableAreaNamePip(channels: PipetteChannels): AddressableAreaName;
@@ -98,7 +99,11 @@ export declare const delayLocationHelper: CommandCreator<DelayLocationHelperArgs
 export declare const getSlotInLocationStack: (stack: string[] | null, isStacker?: boolean) => string;
 export declare const getTopLocationInStack: (stack?: string[]) => string;
 export declare const getNearestParentInStack: (stack: string[]) => string | null;
-export declare const getLargestStackInSlot: (labwareState: RobotState['labware'], slot: string) => string[];
+export declare const getLargestStackInSlot: (args: {
+    slot: string;
+    labwareState: RobotState['labware'];
+    modulesState: RobotState['modules'];
+}) => string[];
 /** Single-slot deck id (e.g. A3) for a staging-area slot (e.g. A4) on Flex. */
 export declare const getFlexStackerCutoutBaseDeckSlotId: (column4StagingSlotId: (typeof COLUMN_4_SLOTS)[number]) => string;
 export declare const column4StagingSlotIdFromFlexStackerShuttleAddressableArea: (addressableAreaName: AddressableAreaName) => (typeof COLUMN_4_SLOTS)[number] | null;
@@ -170,12 +175,15 @@ export declare const getIsRetractSafeForAirGap: (args: {
 }) => boolean;
 export declare const getStackForLabwareLocation: (locationSequence: LabwareLocationSequence) => string[];
 export declare function createStagingAreaForInvariantContext(params: LoadLidStackRunTimeCommand['params'] | LoadLabwareRunTimeCommand['params'] | LoadLidParams): StagingAreaEntities;
-export declare const getLabwareIdOnHopper: (labware: {
-    [labwareId: string]: LabwareTemporalProperties;
-}, moduleSlotLocation: string) => string;
 export declare const getIsSlotAHopper: (slot: string) => boolean;
 export declare const getIsSlotAVacuumDock: (slot: string) => boolean;
 export declare const getLabwareIdOnShuttle: (stackerState: FlexStackerModuleState) => string | null;
 export declare const labwareMatchesLabwareInHopper: (labwareId: string, invariantContext: InvariantContext, stackerState: FlexStackerModuleState | null) => boolean;
 export declare const getIsSpaceInHopper: (stackerState: FlexStackerModuleState | null, labwareEntities: LabwareEntities) => boolean;
+export declare const getLabwareHasLid: (args: {
+    labwareId: string;
+    labwareRobotState: RobotState['labware'];
+    labwareEntities: LabwareEntities;
+}) => boolean;
+export declare const getIsInPipettableLocation: (location: string) => boolean;
 export {};

package/lib/utils/pythonFileUtils.d.ts

@@ -1,7 +1,7 @@
 import type { ProtocolFile, RobotType } from '@opentrons/shared-data';
 import type { ChangeTipOptions, InvariantContext, LabwareEntities, LabwareLiquidState, LabwareTemporalProperties, LiquidEntities, ModuleEntities, ModuleTemporalProperties, PipetteEntities, Timeline, TimelineFrame, TrashBinEntities, WasteChuteEntities } from '../types';
-export declare const PAPI_VERSION = "2.28";
-export declare const PD_APPLICATION_VERSION = "8.11.0";
+export declare const PAPI_VERSION = "2.30";
+export declare const PD_APPLICATION_VERSION = "9.0.0";
 export declare function pythonImports(): string;
 export declare function pythonMetadata(fileMetadata: ProtocolFile<{}>['metadata'] & {
     protocolDesigner?: string;

package/lib/utils/safePipetteMovements.d.ts

@@ -1,4 +1,4 @@
-import type { AddressableArea, CoordinateTuple, CutoutId, LabwareDefinition, NozzleConfigurationStyle, PipetteChannels, PrimaryNozzleConfigurationStyle } from '@opentrons/shared-data';
+import type { AddressableArea, CoordinateTuple, CutoutId, LabwareDefinition, NozzleConfigurationStyle, PipetteChannels, PipetteV2Specs, PrimaryNozzleConfigurationStyle } from '@opentrons/shared-data';
 import type { InvariantContext, PipetteMovementSafetyStatus, Point, RobotState, TipState } from '../types';
 interface SlotInfo {
     addressableArea: AddressableArea | null;
@@ -42,4 +42,12 @@ export declare const getTargetTipsFromWellSets: (args: {
     channels: PipetteChannels;
     primaryNozzle: string;
 }) => string[];
+interface PipetteCenteringArgs {
+    wellTargetName: string;
+    primaryNozzle: PrimaryNozzleConfigurationStyle;
+    nozzleConfiguration: NozzleConfigurationStyle;
+    specs: PipetteV2Specs;
+    labwareDef: LabwareDefinition;
+}
+export declare const getPipetteCenteringFullOffset: (args: PipetteCenteringArgs) => Point;
 export {};

package/package.json

@@ -9,7 +9,7 @@
   },
   "name": "@opentrons/step-generation",
   "productName": "Opentrons Step Generation",
-  "version": "0.3.3-alpha.0",
+  "version": "0.3.5-alpha.0",
   "description": "Step generation",
   "main": "lib/index.cjs",
   "types": "lib/index.d.ts",
@@ -33,7 +33,7 @@
   "homepage": "https://github.com/Opentrons/opentrons",
   "license": "Apache-2.0",
   "dependencies": {
-    "@opentrons/shared-data": "0.3.3-alpha.0",
+    "@opentrons/shared-data": "0.3.5-alpha.0",
     "core-js": "3.2.1",
     "immer": "^10.1.3",
     "lodash": "4.18.1",