@opentrons/step-generation 0.3.19-alpha.0 → 0.3.21-alpha.0

package/lib/types.d.ts

@@ -184,18 +184,33 @@ export type Ingredient = Omit<LiquidEntity, 'pythonName'>;
 export interface Ingredients {
     [liquidId: string]: Ingredient;
 }
-export type Choices = number[] | string[];
-export interface RuntimeParameter {
+interface RuntimeParameterBase {
     variableName: string;
     displayName: string;
-    type: 'boolean' | 'string' | 'float' | 'int' | 'csv';
-    default: string | number | boolean;
+    description?: string;
+}
+export interface NumericRuntimeParameter extends RuntimeParameterBase {
+    type: 'float' | 'int';
+    default: number;
     minimum?: number;
     maximum?: number;
-    choices?: Choices;
+    choices?: number[];
     unit?: string;
-    description?: string;
 }
+export interface BooleanRuntimeParameter extends RuntimeParameterBase {
+    type: 'boolean';
+    default: boolean;
+}
+export interface StringRuntimeParameter extends RuntimeParameterBase {
+    type: 'string';
+    default: string;
+    choices?: string[];
+}
+export interface CsvRuntimeParameter extends RuntimeParameterBase {
+    type: 'csv';
+    default: string;
+}
+export type RuntimeParameter = NumericRuntimeParameter | BooleanRuntimeParameter | StringRuntimeParameter | CsvRuntimeParameter;
 export interface RuntimeParameters {
     [variableName: string]: RuntimeParameter;
 }
@@ -752,7 +767,7 @@ export interface TimelineFrame {
     };
 }
 export type RobotState = TimelineFrame;
-export type ErrorType = 'ABSORBANCE_READER_LID_CLOSED' | 'ABSORBANCE_READER_NO_GRIPPER' | 'ABSORBANCE_READER_NO_INITIALIZATION' | 'CANNOT_MOVE_WITH_GRIPPER' | 'CLOSING_THERMOCYCLER_WITH_INVALID_LABWARE_LID' | 'DROP_TIP_LOCATION_DOES_NOT_EXIST' | 'EQUIPMENT_DOES_NOT_EXIST' | 'FLEX_STACKER_NO_GRIPPER' | 'GRIPPER_REQUIRED' | 'HEATER_SHAKER_EAST_WEST_LATCH_OPEN' | 'HEATER_SHAKER_EAST_WEST_MULTI_CHANNEL' | 'HEATER_SHAKER_IS_SHAKING' | 'HEATER_SHAKER_LATCH_CLOSED' | 'HEATER_SHAKER_LATCH_OPEN' | 'HEATER_SHAKER_NORTH_SOUTH__OF_NON_TIPRACK_WITH_MULTI_CHANNEL' | 'HEATER_SHAKER_NORTH_SOUTH_EAST_WEST_SHAKING' | 'HOPPER_EMPTY' | 'HOPPER_FULL' | 'INCOMPLETE_PICKUP' | 'INSUFFICIENT_TIPS' | 'INVALID_SLOT' | 'INVALID_WAIT_CONDITION' | 'LABWARE_DISCARDED_IN_TRASH' | 'LABWARE_DOES_NOT_EXIST' | 'LABWARE_OFF_DECK' | 'LABWARE_ON_ANOTHER_ENTITY' | 'LABWARE_ON_HOPPER' | 'LIVE_TASK_ERROR' | 'MISMATCHED_SOURCE_DEST_WELLS' | 'MISMATCHED_STACKER_LABWARE_TYPE' | 'MISSING_96_CHANNEL_TIPRACK_ADAPTER' | 'MISSING_MODULE' | 'MISSING_PROFILE_STEP' | 'MISSING_PUMP_ACTIVITY' | 'MISSING_STACKER_LABWARE_TYPE' | 'MISSING_TEMPERATURE_STEP' | 'MOVE_LOCATION_NOT_SPECIFIED' | 'MODULE_PIPETTE_COLLISION_DANGER' | 'MULTI_ASPIRATE_VOLUME_TOO_HIGH' | 'MULTI_DISPENSE_VOLUME_TOO_HIGH' | 'NEXT_TIPRACK_HAS_LID' | 'NO_TIP_ON_PIPETTE' | 'NO_TIP_SELECTED' | 'PIPETTE_DOES_NOT_EXIST' | 'PIPETTE_HAS_TIP' | 'PIPETTE_VOLUME_EXCEEDED' | 'PIPETTING_INTO_COLUMN_4' | 'POSSIBLE_PIPETTE_COLLISION_THERMOCYCLER_LID' | 'POSSIBLE_PIPETTE_COLLISION_OUTSIDE_DECK_EXTENTS' | 'POSSIBLE_PIPETTE_COLLISION_ADJACENT_ADDRESSABLE_AREA' | 'REMOVE_96_CHANNEL_TIPRACK_ADAPTER' | 'RETRACT_BELOW_ASPIRATE' | 'RETRACT_BELOW_DISPENSE' | 'RETURN_TIP_UNAVAILABLE' | 'SHUTTLE_FULL' | 'SHUTTLE_EMPTY' | 'STACK_TOO_HIGH' | 'SUBMERGE_BELOW_ASPIRATE' | 'SUBMERGE_BELOW_DISPENSE' | 'TALL_LABWARE_EAST_WEST_OF_HEATER_SHAKER' | 'THERMOCYCLER_BUSY_WITH_PROFILE' | 'THERMOCYCLER_LID_CLOSED' | 'TIP_VOLUME_EXCEEDED' | 'TIPRACK_LID_NOT_ALLOWED_ON_DECK' | 'TOO_MANY_TIPS' | 'VACUUM_UNDER_PRESSURE';
+export type ErrorType = 'ABSORBANCE_READER_LID_CLOSED' | 'ABSORBANCE_READER_NO_GRIPPER' | 'ABSORBANCE_READER_NO_INITIALIZATION' | 'CANNOT_MOVE_WITH_GRIPPER' | 'CLOSING_THERMOCYCLER_WITH_INVALID_LABWARE_LID' | 'DROP_TIP_LOCATION_DOES_NOT_EXIST' | 'EQUIPMENT_DOES_NOT_EXIST' | 'FLEX_STACKER_NO_GRIPPER' | 'GRIPPER_REQUIRED' | 'HEATER_SHAKER_EAST_WEST_LATCH_OPEN' | 'HEATER_SHAKER_EAST_WEST_MULTI_CHANNEL' | 'HEATER_SHAKER_IS_SHAKING' | 'HEATER_SHAKER_LATCH_CLOSED' | 'HEATER_SHAKER_LATCH_OPEN' | 'HEATER_SHAKER_NORTH_SOUTH__OF_NON_TIPRACK_WITH_MULTI_CHANNEL' | 'HEATER_SHAKER_NORTH_SOUTH_EAST_WEST_SHAKING' | 'HOPPER_EMPTY' | 'HOPPER_FULL' | 'INCOMPLETE_PICKUP' | 'INSUFFICIENT_TIPS' | 'INVALID_RUNTIME_PARAMETER' | 'INVALID_SLOT' | 'INVALID_WAIT_CONDITION' | 'LABWARE_DISCARDED_IN_TRASH' | 'LABWARE_DOES_NOT_EXIST' | 'LABWARE_OFF_DECK' | 'LABWARE_ON_ANOTHER_ENTITY' | 'LABWARE_ON_HOPPER' | 'LIVE_TASK_ERROR' | 'MISMATCHED_SOURCE_DEST_WELLS' | 'MISMATCHED_STACKER_LABWARE_TYPE' | 'MISSING_96_CHANNEL_TIPRACK_ADAPTER' | 'MISSING_MODULE' | 'MISSING_PROFILE_STEP' | 'MISSING_PUMP_ACTIVITY' | 'MISSING_STACKER_LABWARE_TYPE' | 'MISSING_TEMPERATURE_STEP' | 'MOVE_LOCATION_NOT_SPECIFIED' | 'MODULE_PIPETTE_COLLISION_DANGER' | 'MULTI_ASPIRATE_VOLUME_TOO_HIGH' | 'MULTI_DISPENSE_VOLUME_TOO_HIGH' | 'NEXT_TIPRACK_HAS_LID' | 'NO_TIP_ON_PIPETTE' | 'NO_TIP_SELECTED' | 'PIPETTE_DOES_NOT_EXIST' | 'PIPETTE_HAS_TIP' | 'PIPETTE_VOLUME_EXCEEDED' | 'PIPETTING_INTO_COLUMN_4' | 'POSSIBLE_PIPETTE_COLLISION_THERMOCYCLER_LID' | 'POSSIBLE_PIPETTE_COLLISION_OUTSIDE_DECK_EXTENTS' | 'POSSIBLE_PIPETTE_COLLISION_ADJACENT_ADDRESSABLE_AREA' | 'REMOVE_96_CHANNEL_TIPRACK_ADAPTER' | 'RETRACT_BELOW_ASPIRATE' | 'RETRACT_BELOW_DISPENSE' | 'RETURN_TIP_UNAVAILABLE' | 'SHUTTLE_FULL' | 'SHUTTLE_EMPTY' | 'STACK_TOO_HIGH' | 'SUBMERGE_BELOW_ASPIRATE' | 'SUBMERGE_BELOW_DISPENSE' | 'TALL_LABWARE_EAST_WEST_OF_HEATER_SHAKER' | 'THERMOCYCLER_BUSY_WITH_PROFILE' | 'THERMOCYCLER_LID_CLOSED' | 'TIP_VOLUME_EXCEEDED' | 'TIPRACK_LID_NOT_ALLOWED_ON_DECK' | 'TOO_MANY_TIPS' | 'VACUUM_UNDER_PRESSURE';
 export interface CommandCreatorError {
     message: string;
     type: ErrorType;

package/lib/utils/misc.d.ts

@@ -1,6 +1,6 @@
 import { COLUMN_4_SLOTS } from '../constants';
 import type { ActiveNozzleNumber, AddressableAreaName, BlowoutParams, CutoutFixtureId, CutoutId, LabwareDefinition2, LabwareLocationSequence, LoadLabwareRunTimeCommand, LoadLidParams, LoadLidStackRunTimeCommand, NozzleConfigurationStyle, PipetteChannels, PipetteV2Specs, PositionReference, PrimaryNozzleConfigurationStyle, RobotType } from '@opentrons/shared-data';
-import type { CommandCreator, CurriedCommandCreator, FlexStackerModuleState, InvariantContext, LabwareEntities, LabwareTemporalProperties, LocationLiquidState, ModuleEntities, PathOption, RobotState, SourceAndDest, StagingAreaEntities, TrashBinEntities, WasteChuteEntities } from '../types';
+import type { CommandCreator, CurriedCommandCreator, FlexStackerModuleState, InvariantContext, LabwareEntities, LabwareTemporalProperties, LocationLiquidState, ModuleEntities, PathOption, RobotState, RuntimeParameters, SourceAndDest, StagingAreaEntities, TrashBinEntities, WasteChuteEntities } from '../types';
 export declare const AIR: '__air__';
 export declare const SOURCE_WELL_BLOWOUT_DESTINATION: 'source_well';
 export declare const DEST_WELL_BLOWOUT_DESTINATION: 'dest_well';
@@ -187,4 +187,20 @@ export declare const getLabwareHasLid: (args: {
     labwareEntities: LabwareEntities;
 }) => boolean;
 export declare const getIsInPipettableLocation: (location: string) => boolean;
+/**
+ * Numbers pass through. Strings are runtime parameter variable names, and only
+ * float/int parameters resolve — `type` narrows `default` to `number`.
+ */
+export declare function resolveNumericRuntimeValue(value: number | string, runtimeParameters: RuntimeParameters): number | null;
+/**
+ * A string id is literal unless it names a runtime parameter. Only string
+ * parameters resolve — `type` narrows `default` to `string`. Any other
+ * parameter type is invalid.
+ */
+export declare function resolveStringRuntimeValue(value: string, runtimeParameters: RuntimeParameters): string | null;
+/**
+ * Booleans pass through. Strings are runtime parameter variable names, and only
+ * boolean parameters resolve — `type` narrows `default` to `boolean`.
+ */
+export declare function resolveBooleanRuntimeValue(value: boolean | string, runtimeParameters: RuntimeParameters): boolean | null;
 export {};

package/lib/utils/pythonFileUtils.d.ts

@@ -1,5 +1,5 @@
 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';
+import type { ChangeTipOptions, InvariantContext, LabwareEntities, LabwareLiquidState, LabwareTemporalProperties, LiquidEntities, ModuleEntities, ModuleTemporalProperties, PipetteEntities, RuntimeParameters, Timeline, TimelineFrame, TrashBinEntities, WasteChuteEntities } from '../types';
 export declare const PAPI_VERSION = "2.31";
 export declare const PD_APPLICATION_VERSION = "9.0.1";
 export declare function pythonImports(): string;
@@ -28,3 +28,4 @@ export declare const getSetStoredLabware: (moduleEntities: ModuleEntities, labwa
 }, modules: {
     [moduleId: string]: ModuleTemporalProperties;
 }, robotStateTimeline: Timeline) => string;
+export declare function getRunTimeParameters(runtimeParameters: RuntimeParameters): string;

package/package.json

@@ -9,7 +9,7 @@
   },
   "name": "@opentrons/step-generation",
   "productName": "Opentrons Step Generation",
-  "version": "0.3.19-alpha.0",
+  "version": "0.3.21-alpha.0",
   "description": "Step generation",
   "main": "lib/index.cjs",
   "types": "lib/index.d.ts",
@@ -37,7 +37,7 @@
     "immer": "^10.1.3",
     "lodash": "4.18.1",
     "uuid": "14.0.0",
-    "@opentrons/shared-data": "0.3.19-alpha.0"
+    "@opentrons/shared-data": "0.3.21-alpha.0"
   },
   "devDependencies": {
     "@types/lodash": "4.17.24"