@opentrons/shared-data 0.1.6-alpha.8 → 0.1.7-alpha.0

package/lib/js/__tests__/liquidClassSchema.test.d.ts

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

package/lib/js/__tests__/sharedGeometryGroups.d.ts

@@ -0,0 +1,16 @@
+/** Labware that are expected to have the exact same inner well geometry. */
+export declare const SHARED_GEOMETRY_GROUPS: SharedGeometryGroups;
+interface SharedGeometryGroups {
+    [humanReadableGroupName: string]: SharedGeometryEntry[];
+}
+/**
+ * If a plain string, the string is the load name of the labware. In this case, the
+ * labware must have exactly one key within innerLabwareGeometry.
+ *
+ * If an object, the object contains the load name and the specific key within
+ * innerLabwareGeometry. */
+export type SharedGeometryEntry = string | {
+    loadName: string;
+    geometryKey: string;
+};
+export {};

package/lib/js/constants.d.ts

@@ -21,6 +21,7 @@ export declare const THERMOCYCLER_MODULE_V1: 'thermocyclerModuleV1';
 export declare const THERMOCYCLER_MODULE_V2: 'thermocyclerModuleV2';
 export declare const HEATERSHAKER_MODULE_V1: 'heaterShakerModuleV1';
 export declare const ABSORBANCE_READER_V1: 'absorbanceReaderV1';
+export declare const FLEX_STACKER_MODULE_V1: 'flexStackerModuleV1';
 export declare const MAGNETIC_BLOCK_V1: 'magneticBlockV1';
 export declare const GRIPPER_V1: 'gripperV1';
 export declare const GRIPPER_V1_1: 'gripperV1.1';
@@ -42,16 +43,18 @@ export declare const THERMOCYCLER_MODULE_TYPE: 'thermocyclerModuleType';
 export declare const HEATERSHAKER_MODULE_TYPE: 'heaterShakerModuleType';
 export declare const MAGNETIC_BLOCK_TYPE: 'magneticBlockType';
 export declare const ABSORBANCE_READER_TYPE: 'absorbanceReaderType';
+export declare const FLEX_STACKER_MODULE_TYPE: 'flexStackerModuleType';
 export declare const MAGNETIC_MODULE_MODELS: ("magneticModuleV1" | "magneticModuleV2")[];
 export declare const NON_CONNECTING_MODULE_TYPES: ModuleType[];
 export declare const TEMPERATURE_MODULE_MODELS: ("temperatureModuleV1" | "temperatureModuleV2")[];
 export declare const THERMOCYCLER_MODULE_MODELS: ("thermocyclerModuleV2" | "thermocyclerModuleV1")[];
 export declare const HEATERSHAKER_MODULE_MODELS: "heaterShakerModuleV1"[];
 export declare const ABSORBANCE_READER_MODELS: "absorbanceReaderV1"[];
+export declare const FLEX_STACKER_MODULE_MODELS: "flexStackerModuleV1"[];
 export declare const MAGNETIC_BLOCK_MODELS: "magneticBlockV1"[];
-export declare const MODULE_MODELS: ("thermocyclerModuleV2" | "temperatureModuleV1" | "temperatureModuleV2" | "magneticModuleV1" | "magneticModuleV2" | "thermocyclerModuleV1" | "heaterShakerModuleV1" | "magneticBlockV1" | "absorbanceReaderV1")[];
+export declare const MODULE_MODELS: ("thermocyclerModuleV2" | "temperatureModuleV1" | "temperatureModuleV2" | "magneticModuleV1" | "magneticModuleV2" | "thermocyclerModuleV1" | "heaterShakerModuleV1" | "magneticBlockV1" | "absorbanceReaderV1" | "flexStackerModuleV1")[];
 export declare const MODULE_MODELS_OT2_ONLY: ("temperatureModuleV1" | "magneticModuleV1" | "magneticModuleV2" | "thermocyclerModuleV1")[];
-export declare const MODULE_TYPES: ("magneticModuleType" | "temperatureModuleType" | "heaterShakerModuleType" | "thermocyclerModuleType" | "magneticBlockType" | "absorbanceReaderType")[];
+export declare const MODULE_TYPES: ("magneticModuleType" | "temperatureModuleType" | "heaterShakerModuleType" | "thermocyclerModuleType" | "magneticBlockType" | "absorbanceReaderType" | "flexStackerModuleType")[];
 export declare const GEN_ONE_MULTI_PIPETTES: string[];
 export declare const IDENTITY_VECTOR: {
     x: number;
@@ -168,12 +171,18 @@ export declare const ABSORBANCE_READER_LID_DOCK_A4_ADDRESSABLE_AREA: 'absorbance
 export declare const ABSORBANCE_READER_LID_DOCK_B4_ADDRESSABLE_AREA: 'absorbanceReaderV1LidDockB4';
 export declare const ABSORBANCE_READER_LID_DOCK_C4_ADDRESSABLE_AREA: 'absorbanceReaderV1LidDockC4';
 export declare const ABSORBANCE_READER_LID_DOCK_D4_ADDRESSABLE_AREA: 'absorbanceReaderV1LidDockD4';
+export declare const FLEX_STACKER_A4_ADDRESSABLE_AREA: 'flexStackerModuleV1A4';
+export declare const FLEX_STACKER_B4_ADDRESSABLE_AREA: 'flexStackerModuleV1B4';
+export declare const FLEX_STACKER_C4_ADDRESSABLE_AREA: 'flexStackerModuleV1C4';
+export declare const FLEX_STACKER_D4_ADDRESSABLE_AREA: 'flexStackerModuleV1D4';
 export declare const MAGNETIC_BLOCK_ADDRESSABLE_AREAS: AddressableAreaName[];
 export declare const TEMPERATURE_MODULE_ADDRESSABLE_AREAS: AddressableAreaName[];
 export declare const HEATERSHAKER_ADDRESSABLE_AREAS: AddressableAreaName[];
 export declare const ABSORBANCE_READER_ADDRESSABLE_AREAS: AddressableAreaName[];
+export declare const FLEX_STACKER_ADDRESSABLE_AREAS: AddressableAreaName[];
 export declare const FLEX_USB_MODULE_ADDRESSABLE_AREAS: AddressableAreaName[];
 export declare const FLEX_MODULE_ADDRESSABLE_AREAS: AddressableAreaName[];
+export declare const FLEX_STAGING_ADDRESSABLE_AREAS: AddressableAreaName[];
 export declare const ADDRESSABLE_AREA_1: '1';
 export declare const ADDRESSABLE_AREA_2: '2';
 export declare const ADDRESSABLE_AREA_3: '3';
@@ -194,6 +203,7 @@ export declare const SINGLE_LEFT_SLOT_FIXTURE: 'singleLeftSlot';
 export declare const SINGLE_CENTER_SLOT_FIXTURE: 'singleCenterSlot';
 export declare const SINGLE_RIGHT_SLOT_FIXTURE: 'singleRightSlot';
 export declare const STAGING_AREA_RIGHT_SLOT_FIXTURE: 'stagingAreaRightSlot';
+export declare const TRASH_BIN_FIXTURE: 'trashBin';
 export declare const TRASH_BIN_ADAPTER_FIXTURE: 'trashBinAdapter';
 export declare const WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE: 'wasteChuteRightAdapterCovered';
 export declare const WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE: 'wasteChuteRightAdapterNoCover';
@@ -206,6 +216,10 @@ export declare const STAGING_AREA_SLOT_WITH_MAGNETIC_BLOCK_V1_FIXTURE: 'stagingA
 export declare const THERMOCYCLER_V2_REAR_FIXTURE: 'thermocyclerModuleV2Rear';
 export declare const THERMOCYCLER_V2_FRONT_FIXTURE: 'thermocyclerModuleV2Front';
 export declare const ABSORBANCE_READER_V1_FIXTURE: 'absorbanceReaderV1';
+export declare const FLEX_STACKER_V1_FIXTURE: 'flexStackerModuleV1';
+export declare const FLEX_STACKER_WITH_WASTE_CHUTE_ADAPTER_COVERED_FIXTURE: 'flexStackerModuleV1WithWasteChuteRightAdapterCovered';
+export declare const FLEX_STACKER_WTIH_WASTE_CHUTE_ADAPTER_NO_COVER_FIXTURE: 'flexStackerModuleV1WithWasteChuteRightAdapterNoCover';
+export declare const FLEX_STACKER_WITH_MAG_BLOCK_FIXTURE: 'flexStackerModuleV1WithMagneticBlockV1';
 export declare const MODULE_FIXTURES_BY_MODEL: {
     [moduleModel in ModuleModel]?: CutoutFixtureId[];
 };
@@ -215,8 +229,12 @@ export declare const SINGLE_SLOT_FIXTURES: CutoutFixtureId[];
 export declare const WASTE_CHUTE_FIXTURES: CutoutFixtureId[];
 export declare const WASTE_CHUTE_ONLY_FIXTURES: CutoutFixtureId[];
 export declare const WASTE_CHUTE_STAGING_AREA_FIXTURES: CutoutFixtureId[];
+export declare const FLEX_STACKER_FIXTURES: CutoutFixtureId[];
 export declare const LOW_VOLUME_PIPETTES: string[];
-export declare const NON_USER_ADDRESSABLE_LABWARE: string[];
 export declare const DEFAULT_LIQUID_COLORS: string[];
 export declare const DEPRECATED_WHALE_GREY = "#9395a0";
 export declare const INTERACTIVE_WELL_DATA_ATTRIBUTE = "data-wellname";
+export declare const WELL_TOP: 'well-top';
+export declare const WELL_CENTER: 'well-center';
+export declare const WELL_BOTTOM: 'well-bottom';
+export declare const LIQUID_MENISCUS: 'liquid-meniscus';

package/lib/js/fixtures.d.ts

@@ -25,5 +25,7 @@ deckDef: DeckDefinition): {
 export declare function getCutoutIdsFromModuleSlotName(slotName: string, moduleFixtures: CutoutFixture[], // cutout fixtures for a specific module model
 deckDef: DeckDefinition): CutoutId[];
 export declare function getAddressableAreaNamesFromLoadedModule(moduleModel: ModuleModel, slotName: ModuleLocation['slotName'], deckDef: DeckDefinition): AddressableAreaName[];
-export declare function getFixtureDisplayName(cutoutFixtureId: CutoutFixtureId | null, usbPortNumber?: number): string;
+export declare function getFixtureDisplayName(cutoutFixtureId: CutoutFixtureId | null, usbPortNumber?: number | string): string;
+export declare const STANDARD_OT2_SLOTS: AddressableAreaName[];
+export declare const STANDARD_FLEX_SLOTS: AddressableAreaName[];
 export declare const isAddressableAreaStandardSlot: (addressableAreaName: AddressableAreaName, deckDef: DeckDefinition) => boolean;

package/lib/js/helpers/__tests__/index.test.d.ts

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

package/lib/js/helpers/__tests__/linearInterpolate.test.d.ts

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

package/lib/js/helpers/index.d.ts

@@ -1,4 +1,5 @@
-import type { DeckDefinition, LabwareDefinition2, ModuleModel, RobotType, ThermalAdapterName } from '../types';
+import type { DeckDefinition, LabwareDefinition2, LabwareDefinition3, LiquidClass, ModuleModel, RobotType, ThermalAdapterName } from '../types';
+import type { CutoutId } from '../../deck/types/schemaV5';
 export { getWellNamePerMultiTip } from './getWellNamePerMultiTip';
 export { getWellTotalVolume } from './getWellTotalVolume';
 export { wellIsRect } from './wellIsRect';
@@ -18,6 +19,7 @@ export * from './getLoadedLabwareDefinitionsByUri';
 export * from './getFixedTrashLabwareDefinition';
 export * from './getOccludedSlotCountForModule';
 export * from './labwareInference';
+export * from './linearInterpolate';
 export * from './getAddressableAreasInProtocol';
 export * from './getFlexSurroundingSlots';
 export * from './getSimplestFlexDeckConfig';
@@ -26,9 +28,18 @@ export * from './formatRunTimeParameterValue';
 export * from './formatRunTimeParameterMinMax';
 export * from './orderRuntimeParameterRangeOptions';
 export * from './sortRunTimeParameters';
+export * from './parseAddressableArea';
+export * from './validateCustomLabwareHelper';
 export declare const getLabwareDefIsStandard: (def: LabwareDefinition2) => boolean;
-export declare const getLabwareDefURI: (def: LabwareDefinition2) => string;
+export declare const getLabwareDefURI: (def: LabwareDefinition2 | LabwareDefinition3) => string;
 export declare const constructLabwareDefURI: (namespace: string, loadName: string, version: string) => string;
+export interface URIDetails {
+    loadName: string;
+    namespace: string;
+    version: number;
+}
+export declare const splitLabwareDefURI: (uri: string) => URIDetails;
+export declare const RETIRED_LABWARE: string[];
 export declare const getLabwareDisplayName: (labwareDef: LabwareDefinition2) => string;
 export declare const getTiprackVolume: (labwareDef: LabwareDefinition2) => number;
 export declare function getLabwareHasQuirk(labwareDef: LabwareDefinition2, quirk: string): boolean;
@@ -45,7 +56,9 @@ export declare function sortWells(a: string, b: string): number;
 export declare function splitWellsOnColumn(sortedArray: string[]): string[][];
 export declare const getWellDepth: (labwareDef: LabwareDefinition2, well: string) => number;
 export declare const getWellsDepth: (labwareDef: LabwareDefinition2, wells: string[]) => number;
-export declare const getWellDimension: (labwareDef: LabwareDefinition2, wells: string[], position: 'x' | 'y') => number;
+type XYPlaneDimension = 'x' | 'y';
+export declare const getWellDimension: (labwareDef: LabwareDefinition2, wells: string[], position: XYPlaneDimension) => number;
+export declare const getMinXYDimension: (labwareDef: LabwareDefinition2, wells: string[]) => number | null;
 export declare const getSlotHasMatingSurfaceUnitVector: (deckDef: DeckDefinition, addressableAreaName: string) => boolean;
 export declare const getAreSlotsHorizontallyAdjacent: (slotNameA?: string | null, slotNameB?: string | null) => boolean;
 export declare const getAreSlotsVerticallyAdjacent: (slotNameA?: string | null, slotNameB?: string | null) => boolean;
@@ -54,3 +67,5 @@ export declare const getIsLabwareAboveHeight: (labwareDef: LabwareDefinition2, h
 export declare const getAdapterName: (labwareLoadname: string) => ThermalAdapterName;
 export declare const getCalibrationAdapterLoadName: (moduleModel: ModuleModel) => string | null;
 export declare const getDeckDefFromRobotType: (robotType: RobotType) => DeckDefinition;
+export declare const getCutoutIdFromAddressableArea: (addressableAreaName: string, deckDefinition: DeckDefinition) => CutoutId | null;
+export declare const getSortedLiquidClassDefs: () => Record<string, LiquidClass>;

package/lib/js/helpers/linearInterpolate.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This function performs linear interpolation given a target x-value and an array of [x, y] known interpolation points.
+ * linearInterpolate will pre-sort interpolationPoints by x-value. If a value lies left or right of all passed
+ * interpolation points, the caller can optionally set a default to return. If no default left or right value is passed,
+ * linearInterpolate will return the left- or right-most point, depending on where the target falls.
+ *
+ * @param {number} target Target x-value for which to interpolate y-value.
+ * @param {Array<number, number>} interpolationPoints Array of [x, y] to use for interpolation.
+ * @param {number | null} [left] Value to use if target falls left of left-most interpolation point.
+ * @param {number | null} [right] Value to use if target falls right of right-most interpolation point.
+ *
+ * @returns {number | null} Interpolated y-value. Null if empty array of interpolation points passed.
+ */
+export declare const linearInterpolate: (target: number, interpolationPoints: Array<[number, number]>, left?: number | null, right?: number | null) => number | null;

package/lib/js/helpers/parseAddressableArea.d.ts

@@ -0,0 +1,4 @@
+import type { ModuleModel } from '../types';
+import type { AddressableAreaName } from '../../deck';
+export declare function getSlotFromAddressableAreaName(addressableArea: AddressableAreaName): string;
+export declare function getModuleModelFromAddressableArea(addressableArea: AddressableAreaName): ModuleModel | null;

package/lib/js/helpers/validateCustomLabwareHelper.d.ts

@@ -0,0 +1,9 @@
+import type { LabwareDefinition2 } from '..';
+/**
+ * This function is used to help validate that the wells and ordering matches in
+ * a custom labware definition in terms of the wellName and the wells length
+ *
+ * @param definition - a labware definition
+ * @returns A boolean for if they exist
+ */
+export declare const validateCustomLabwareHelper: (definition: LabwareDefinition2 | null) => boolean;

package/lib/js/index.d.ts

@@ -10,6 +10,7 @@ export * from './gripper';
 export * from './helpers';
 export * from './labware';
 export * from './labwareTools';
+export * from './liquidClasses';
 export * from './modules';
 export * from './pipettes';
 export * from './protocols';

package/lib/js/labware.d.ts

@@ -9,123 +9,11 @@ import fixtureTiprackAdapter from '../labware/fixtures/2/fixture_flex_96_tiprack
 import fixtureCalibrationBlock from '../labware/fixtures/2/fixture_calibration_block.json';
 import fixture384Plate from '../labware/fixtures/2/fixture_384_plate.json';
 import fixtureTrash from '../labware/fixtures/2/fixture_trash.json';
-import opentrons96Tiprack10UlV1Uncasted from '../labware/definitions/2/opentrons_96_tiprack_10ul/1.json';
 import type { LabwareDefByDefURI, LabwareDefinition2, LegacyLabwareDefByName } from './types';
-declare const opentrons1Trash3200MlFixedV1: LabwareDefinition2;
-declare const opentrons96PcrAdapterV1: LabwareDefinition2;
-declare const latestDefs: {
-    agilent1Reservoir290MlV1: LabwareDefinition2;
-    appliedbiosystemsmicroamp384Wellplate40UlV1: LabwareDefinition2;
-    armadillo96Wellplate200UlPcrFullSkirtV1: LabwareDefinition2;
-    armadillo96Wellplate200UlPcrFullSkirtV2: LabwareDefinition2;
-    axygen1Reservoir90MlV1: LabwareDefinition2;
-    biorad384Wellplate50UlV1: LabwareDefinition2;
-    biorad384Wellplate50UlV2: LabwareDefinition2;
-    biorad96Wellplate200UlPcrV1: LabwareDefinition2;
-    biorad96Wellplate200UlPcrV2: LabwareDefinition2;
-    corning12Wellplate69MlFlatV1: LabwareDefinition2;
-    corning12Wellplate69MlFlatV2: LabwareDefinition2;
-    corning24Wellplate34MlFlatV1: LabwareDefinition2;
-    corning24Wellplate34MlFlatV2: LabwareDefinition2;
-    corning384Wellplate112UlFlatV1: LabwareDefinition2;
-    corning384Wellplate112UlFlatV2: LabwareDefinition2;
-    corning48Wellplate16MlFlatV1: LabwareDefinition2;
-    corning48Wellplate16MlFlatV2: LabwareDefinition2;
-    corning6Wellplate168MlFlatV1: LabwareDefinition2;
-    corning6Wellplate168MlFlatV2: LabwareDefinition2;
-    corning96Wellplate360UlFlatV1: LabwareDefinition2;
-    corning96Wellplate360UlFlatV2: LabwareDefinition2;
-    eppendorf96Tiprack1000UlEptipsV1: LabwareDefinition2;
-    eppendorf96Tiprack10UlEptipsV1: LabwareDefinition2;
-    geb96Tiprack1000UlV1: LabwareDefinition2;
-    geb96Tiprack10UlV1: LabwareDefinition2;
-    nest12Reservoir15MlV1: LabwareDefinition2;
-    nest1Reservoir195MlV1: LabwareDefinition2;
-    nest1Reservoir195MlV2: LabwareDefinition2;
-    nest1Reservoir290MlV1: LabwareDefinition2;
-    nest96Wellplate100UlPcrFullSkirtV1: LabwareDefinition2;
-    nest96Wellplate100UlPcrFullSkirtV2: LabwareDefinition2;
-    nest96Wellplate200UlFlatV1: LabwareDefinition2;
-    nest96Wellplate200UlFlatV2: LabwareDefinition2;
-    nest96Wellplate2MlDeepV1: LabwareDefinition2;
-    nest96Wellplate2MlDeepV2: LabwareDefinition2;
-    opentrons10TuberackFalcon4X50Ml6X15MlConicalV1: LabwareDefinition2;
-    opentrons10TuberackFalcon4X50Ml6X15MlConicalAcrylicV1: LabwareDefinition2;
-    opentrons10TuberackNest4X50Ml6X15MlConicalV1: LabwareDefinition2;
-    opentrons15TuberackFalcon15MlConicalV1: LabwareDefinition2;
-    opentrons15TuberackNest15MlConicalV1: LabwareDefinition2;
-    opentrons1Trash3200MlFixedV1: LabwareDefinition2;
-    opentrons1Trash1100MlFixedV1: LabwareDefinition2;
-    opentrons1Trash850MlFixedV1: LabwareDefinition2;
-    opentrons24AluminumblockGeneric2MlScrewcapV1: LabwareDefinition2;
-    opentrons24AluminumblockGeneric2MlScrewcapV2: LabwareDefinition2;
-    opentrons24AluminumblockNest05MlScrewcapV1: LabwareDefinition2;
-    opentrons24AluminumblockNest15MlScrewcapV1: LabwareDefinition2;
-    opentrons24AluminumblockNest15MlSnapcapV1: LabwareDefinition2;
-    opentrons24AluminumblockNest2MlScrewcapV1: LabwareDefinition2;
-    opentrons24AluminumblockNest2MlSnapcapV1: LabwareDefinition2;
-    opentrons24TuberackEppendorf15MlSafelockSnapcapV1: LabwareDefinition2;
-    opentrons24TuberackEppendorf2MlSafelockSnapcapV1: LabwareDefinition2;
-    opentrons24TuberackEppendorf2MlSafelockSnapcapAcrylicV1: LabwareDefinition2;
-    opentrons24TuberackGeneric075MlSnapcapAcrylicV1: LabwareDefinition2;
-    opentrons24TuberackGeneric2MlScrewcapV1: LabwareDefinition2;
-    opentrons24TuberackNest05MlScrewcapV1: LabwareDefinition2;
-    opentrons24TuberackNest15MlScrewcapV1: LabwareDefinition2;
-    opentrons24TuberackNest15MlSnapcapV1: LabwareDefinition2;
-    opentrons24TuberackNest2MlScrewcapV1: LabwareDefinition2;
-    opentrons24TuberackNest2MlSnapcapV1: LabwareDefinition2;
-    opentrons40AluminumblockEppendorf24X2MlSafelockSnapcapGeneric16X02MlPcrStripV1: LabwareDefinition2;
-    opentrons6TuberackFalcon50MlConicalV1: LabwareDefinition2;
-    opentrons6TuberackNest50MlConicalV1: LabwareDefinition2;
-    opentrons96DeepWellTempModAdapterV1: LabwareDefinition2;
-    opentrons96AluminumblockBioradWellplate200UlV1: LabwareDefinition2;
-    opentrons96AluminumblockGenericPcrStrip200UlV1: LabwareDefinition2;
-    opentrons96AluminumblockGenericPcrStrip200UlV2: LabwareDefinition2;
-    opentrons96AluminumblockNestWellplate100UlV1: LabwareDefinition2;
-    opentrons96DeepWellAdapterV1: LabwareDefinition2;
-    opentrons96DeepWellAdapterNestWellplate2MlDeepV1: LabwareDefinition2;
-    opentrons96Filtertiprack1000UlV1: LabwareDefinition2;
-    opentrons96Filtertiprack10UlV1: LabwareDefinition2;
-    opentrons96Filtertiprack200UlV1: LabwareDefinition2;
-    opentrons96Filtertiprack20UlV1: LabwareDefinition2;
-    opentrons96FlatBottomAdapterV1: LabwareDefinition2;
-    opentrons96FlatBottomAdapterNestWellplate200UlFlatV1: LabwareDefinition2;
-    opentrons96PcrAdapterV1: LabwareDefinition2;
-    opentrons96PcrAdapterArmadilloWellplate200UlV1: LabwareDefinition2;
-    opentrons96PcrAdapterNestWellplate100UlPcrFullSkirtV1: LabwareDefinition2;
-    opentrons96Tiprack1000UlV1: LabwareDefinition2;
-    opentrons96Tiprack10UlV1: LabwareDefinition2;
-    opentrons96Tiprack20UlV1: LabwareDefinition2;
-    opentrons96Tiprack300UlV1: LabwareDefinition2;
-    opentrons96WellAluminumBlockV1: LabwareDefinition2;
-    opentrons96Wellplate200UlPcrFullSkirtV1: LabwareDefinition2;
-    opentrons96Wellplate200UlPcrFullSkirtV2: LabwareDefinition2;
-    opentronsAluminumFlatBottomPlateV1: LabwareDefinition2;
-    opentronsCalibrationAdapterHeatershakerModuleV1: LabwareDefinition2;
-    opentronsCalibrationAdapterTemperatureModuleV1: LabwareDefinition2;
-    opentronsCalibrationAdapterThermocyclerModuleV1: LabwareDefinition2;
-    opentronsCalibrationblockShortSideLeftV1: LabwareDefinition2;
-    opentronsCalibrationblockShortSideRightV1: LabwareDefinition2;
-    opentronsFlex96Filtertiprack1000UlV1: LabwareDefinition2;
-    opentronsFlex96Filtertiprack200UlV1: LabwareDefinition2;
-    opentronsFlex96Filtertiprack50UlV1: LabwareDefinition2;
-    opentronsFlex96Tiprack1000UlV1: LabwareDefinition2;
-    opentronsFlex96Tiprack200UlV1: LabwareDefinition2;
-    opentronsFlex96Tiprack50UlV1: LabwareDefinition2;
-    opentronsFlex96TiprackAdapterV1: LabwareDefinition2;
-    opentronsFlexDeckRiserV1: LabwareDefinition2;
-    opentronsFlexLidAbsorbancePlateReaderModuleV1: LabwareDefinition2;
-    opentronsToughPcrAutoSealingLidV1: LabwareDefinition2;
-    opentronsUniversalFlatAdapterV1: LabwareDefinition2;
-    opentronsUniversalFlatAdapterCorning384Wellplate112UlFlatV1: LabwareDefinition2;
-    thermoscientificnunc96Wellplate1300UlV1: LabwareDefinition2;
-    thermoscientificnunc96Wellplate2000UlV1: LabwareDefinition2;
-    tipone96Tiprack200UlV1: LabwareDefinition2;
-    usascientific12Reservoir22MlV1: LabwareDefinition2;
-    usascientific96Wellplate24MlDeepV1: LabwareDefinition2;
-};
-declare const getAllLabwareDefs: () => Record<keyof typeof latestDefs, LabwareDefinition2>;
+export declare const getAllLabwareDefs: () => Record<string, LabwareDefinition2>;
 export declare function getAllDefinitions(blockList?: string[]): LabwareDefByDefURI;
 export declare function getAllLegacyDefinitions(): LegacyLabwareDefByName;
-export { labwareSchemaV2, fixture96Plate, fixture12Trough, fixture24Tuberack, fixtureTiprack10ul, fixtureTiprack300ul, fixtureTiprack1000ul, fixtureTiprackAdapter, opentrons96PcrAdapterV1, opentrons1Trash3200MlFixedV1, fixtureTrash, fixture384Plate, fixtureCalibrationBlock, opentrons96Tiprack10UlV1Uncasted, };
-export { getAllLabwareDefs };
+export { labwareSchemaV2, fixture96Plate, fixture12Trough, fixture24Tuberack, fixtureTiprack10ul, fixtureTiprack300ul, fixtureTiprack1000ul, fixtureTiprackAdapter, fixtureTrash, fixture384Plate, fixtureCalibrationBlock, };
+export declare const opentrons96PcrAdapterV1: LabwareDefinition2;
+export declare const opentrons1Trash3200MlFixedV1: LabwareDefinition2;
+export declare const opentrons96Tiprack10UlV1Uncasted: LabwareDefinition2;

package/lib/js/liquidClasses.d.ts

@@ -0,0 +1,2 @@
+import type { LiquidClass } from '.';
+export declare const getAllLiquidClassDefs: () => Record<string, LiquidClass>;

package/lib/js/types.d.ts

@@ -1,7 +1,8 @@
-import type { MAGDECK, TEMPDECK, THERMOCYCLER, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2, TEMPERATURE_MODULE_V1, TEMPERATURE_MODULE_V2, THERMOCYCLER_MODULE_V1, THERMOCYCLER_MODULE_V2, HEATERSHAKER_MODULE_V1, ABSORBANCE_READER_V1, MAGNETIC_MODULE_TYPE, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, HEATERSHAKER_MODULE_TYPE, MAGNETIC_BLOCK_TYPE, ABSORBANCE_READER_TYPE, GEN1, GEN2, FLEX, LEFT, RIGHT, GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2, GRIPPER_V1_3, EXTENSION, MAGNETIC_BLOCK_V1 } from './constants';
-import type { RunTimeCommand, LabwareLocation } from '../command/types';
+import type { MAGDECK, TEMPDECK, THERMOCYCLER, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2, TEMPERATURE_MODULE_V1, TEMPERATURE_MODULE_V2, THERMOCYCLER_MODULE_V1, THERMOCYCLER_MODULE_V2, HEATERSHAKER_MODULE_V1, ABSORBANCE_READER_V1, MAGNETIC_MODULE_TYPE, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, HEATERSHAKER_MODULE_TYPE, MAGNETIC_BLOCK_TYPE, ABSORBANCE_READER_TYPE, GEN1, GEN2, FLEX, LEFT, RIGHT, GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2, GRIPPER_V1_3, EXTENSION, MAGNETIC_BLOCK_V1, FLEX_STACKER_MODULE_V1, FLEX_STACKER_MODULE_TYPE, WELL_BOTTOM, WELL_CENTER, WELL_TOP, LIQUID_MENISCUS } from './constants';
+import type { RunTimeCommand, LoadedLabwareLocation } from '../command/types';
 import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../deck';
 import type { PipetteName } from './pipettes';
+import type { CommandAnnotation } from '../commandAnnotation/types';
 export type RobotType = 'OT-2 Standard' | 'OT-3 Standard';
 export interface RobotDefinition {
     displayName: string;
@@ -36,7 +37,7 @@ export interface LabwareDefinition1 {
         [well: string]: WellDefinition;
     };
 }
-export type LabwareDisplayCategory = 'wellPlate' | 'tipRack' | 'tubeRack' | 'reservoir' | 'aluminumBlock' | 'trash' | 'other' | 'adapter' | 'lid';
+export type LabwareDisplayCategory = 'wellPlate' | 'tipRack' | 'tubeRack' | 'reservoir' | 'aluminumBlock' | 'trash' | 'other' | 'adapter' | 'lid' | 'system';
 export type LabwareVolumeUnits = 'µL' | 'mL' | 'L';
 export type WellBottomShape = 'flat' | 'u' | 'v';
 export interface LabwareMetadata {
@@ -62,6 +63,7 @@ export interface LabwareParameters {
     isTiprack: boolean;
     tipLength?: number;
     isMagneticModuleCompatible: boolean;
+    isDeckSlotCompatible?: boolean;
     magneticModuleEngageHeight?: number;
     quirks?: string[];
 }
@@ -145,7 +147,7 @@ export interface LabwareWellGroup {
     metadata: LabwareWellGroupMetadata;
     brand?: LabwareBrand;
 }
-export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance' | 'lid';
+export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance' | 'lid' | 'system';
 export interface LabwareDefinition2 {
     version: number;
     schemaVersion: 2;
@@ -161,9 +163,13 @@ export interface LabwareDefinition2 {
     allowedRoles?: LabwareRoles[];
     stackingOffsetWithLabware?: Record<string, LabwareOffset>;
     stackingOffsetWithModule?: Record<string, LabwareOffset>;
+    stackLimit?: number;
+    compatibleParentLabware?: string[];
+    innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
 }
 export interface LabwareDefinition3 {
     version: number;
+    $otSharedSchema: '#/labware/schemas/3';
     schemaVersion: 3;
     namespace: string;
     metadata: LabwareMetadata;
@@ -177,6 +183,8 @@ export interface LabwareDefinition3 {
     allowedRoles?: LabwareRoles[];
     stackingOffsetWithLabware?: Record<string, LabwareOffset>;
     stackingOffsetWithModule?: Record<string, LabwareOffset>;
+    stackLimit?: number;
+    compatibleParentLabware?: string[];
     innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
 }
 export interface LabwareDefByDefURI {
@@ -185,14 +193,15 @@ export interface LabwareDefByDefURI {
 export interface LegacyLabwareDefByName {
     [name: string]: LabwareDefinition1;
 }
-export type ModuleType = typeof MAGNETIC_MODULE_TYPE | typeof TEMPERATURE_MODULE_TYPE | typeof THERMOCYCLER_MODULE_TYPE | typeof HEATERSHAKER_MODULE_TYPE | typeof MAGNETIC_BLOCK_TYPE | typeof ABSORBANCE_READER_TYPE;
+export type ModuleType = typeof MAGNETIC_MODULE_TYPE | typeof TEMPERATURE_MODULE_TYPE | typeof THERMOCYCLER_MODULE_TYPE | typeof HEATERSHAKER_MODULE_TYPE | typeof MAGNETIC_BLOCK_TYPE | typeof ABSORBANCE_READER_TYPE | typeof FLEX_STACKER_MODULE_TYPE;
 export type MagneticModuleModel = typeof MAGNETIC_MODULE_V1 | typeof MAGNETIC_MODULE_V2;
 export type TemperatureModuleModel = typeof TEMPERATURE_MODULE_V1 | typeof TEMPERATURE_MODULE_V2;
 export type ThermocyclerModuleModel = typeof THERMOCYCLER_MODULE_V1 | typeof THERMOCYCLER_MODULE_V2;
 export type HeaterShakerModuleModel = typeof HEATERSHAKER_MODULE_V1;
 export type MagneticBlockModel = typeof MAGNETIC_BLOCK_V1;
 export type AbsorbanceReaderModel = typeof ABSORBANCE_READER_V1;
-export type ModuleModel = MagneticModuleModel | TemperatureModuleModel | ThermocyclerModuleModel | HeaterShakerModuleModel | MagneticBlockModel | AbsorbanceReaderModel;
+export type FlexStackerModuleModel = typeof FLEX_STACKER_MODULE_V1;
+export type ModuleModel = MagneticModuleModel | TemperatureModuleModel | ThermocyclerModuleModel | HeaterShakerModuleModel | MagneticBlockModel | AbsorbanceReaderModel | FlexStackerModuleModel;
 export type GripperModel = typeof GRIPPER_V1 | typeof GRIPPER_V1_1 | typeof GRIPPER_V1_2 | typeof GRIPPER_V1_3;
 export type ModuleModelWithLegacy = ModuleModel | typeof THERMOCYCLER | typeof MAGDECK | typeof TEMPDECK;
 export interface Dimensions {
@@ -327,6 +336,12 @@ export interface FlowRateSpec {
     min: number;
     max: number;
 }
+interface PlungerPositionsConfiguration {
+    top: number;
+    bottom: number;
+    blowout: number;
+    drop: number;
+}
 interface pressAndCamConfigurationValues {
     speed: number;
     distance: number;
@@ -368,12 +383,8 @@ export interface PipetteV2GeneralSpecs {
         run: number;
     };
     plungerPositionsConfigurations: {
-        default: {
-            top: number;
-            bottom: number;
-            blowout: number;
-            drop: number;
-        };
+        default: PlungerPositionsConfiguration;
+        lowVolumeDefault?: PlungerPositionsConfiguration;
     };
     availableSensors: {
         sensors: string[];
@@ -509,7 +520,7 @@ export interface LoadedLabware {
     id: string;
     loadName: string;
     definitionUri: string;
-    location: LabwareLocation;
+    location: LoadedLabwareLocation;
     offsetId?: string;
     displayName?: string;
 }
@@ -527,6 +538,98 @@ export interface Liquid {
     description: string;
     displayColor?: string;
 }
+type LiquidHandlingPropertyByVolume = number[][];
+export type PositionReference = typeof WELL_BOTTOM | typeof WELL_CENTER | typeof WELL_TOP | typeof LIQUID_MENISCUS;
+type BlowoutLocation = 'source' | 'destination' | 'trash';
+interface DelayParams {
+    duration: number;
+}
+interface DelayProperties {
+    enable: boolean;
+    params?: DelayParams;
+}
+interface TouchTipParams {
+    zOffset: number;
+    mmToEdge: number;
+    speed: number;
+}
+interface TouchTipProperties {
+    enable: boolean;
+    params?: TouchTipParams;
+}
+interface MixParams {
+    repetitions: number;
+    volume: number;
+}
+interface MixProperties {
+    enable: boolean;
+    params?: MixParams;
+}
+interface BlowoutParams {
+    location: BlowoutLocation;
+    flowRate: number;
+}
+interface BlowoutProperties {
+    enable: boolean;
+    params?: BlowoutParams;
+}
+interface Submerge {
+    positionReference: PositionReference;
+    offset: Coordinates;
+    speed: number;
+    delay: DelayProperties;
+}
+interface BaseRetract {
+    positionReference: PositionReference;
+    offset: Coordinates;
+    speed: number;
+    airGapByVolume: LiquidHandlingPropertyByVolume;
+    touchTip: TouchTipProperties;
+    delay: DelayProperties;
+}
+type RetractAspirate = BaseRetract;
+interface RetractDispense extends BaseRetract {
+    blowout: BlowoutProperties;
+}
+interface BaseLiquidHandlingProperties<RetractType> {
+    submerge: Submerge;
+    retract: RetractType;
+    positionReference: PositionReference;
+    offset: Coordinates;
+    flowRateByVolume: LiquidHandlingPropertyByVolume;
+    correctionByVolume: LiquidHandlingPropertyByVolume;
+    delay: DelayProperties;
+}
+export interface AspirateProperties extends BaseLiquidHandlingProperties<RetractAspirate> {
+    preWet: boolean;
+    mix: MixProperties;
+}
+export interface SingleDispenseProperties extends BaseLiquidHandlingProperties<RetractDispense> {
+    mix: MixProperties;
+    pushOutByVolume: LiquidHandlingPropertyByVolume;
+}
+export interface MultiDispenseProperties {
+    conditioningByVolume: LiquidHandlingPropertyByVolume;
+    disposalByVolume: LiquidHandlingPropertyByVolume;
+}
+interface ByTipTypeSetting {
+    tiprack: string;
+    aspirate: AspirateProperties;
+    singleDispense: SingleDispenseProperties;
+    multiDispense?: MultiDispenseProperties;
+}
+interface ByPipetteSetting {
+    pipetteModel: string;
+    byTipType: ByTipTypeSetting[];
+}
+export interface LiquidClass {
+    liquidClassName: string;
+    displayName: string;
+    description: string;
+    schemaVersion: number;
+    namespace: string;
+    byPipette: ByPipetteSetting[];
+}
 export interface AnalysisError {
     id: string;
     detail: string;
@@ -612,6 +715,7 @@ export interface CompletedProtocolAnalysis {
     errors: AnalysisError[];
     robotType?: RobotType | null;
     runTimeParameters?: RunTimeParameter[];
+    commandAnnotations?: CommandAnnotation[];
 }
 export interface ResourceFile {
     name: string;

package/lib/labware/definitions/{3 → 2}/agilent_1_reservoir_290ml/2.json

@@ -46,7 +46,7 @@
     },
     "namespace": "opentrons",
     "version": 2,
-    "schemaVersion": 3,
+    "schemaVersion": 2,
     "cornerOffsetFromSlot": {
         "x": 0,
         "y": 0,
@@ -57,22 +57,22 @@
             "sections": [
                 {
                     "shape": "cuboidal",
-                    "topXDimension": 107.25,
+                    "topXDimension": 107.5,
+                    "topYDimension": 71.25,
+                    "bottomXDimension": 106.79,
+                    "bottomYDimension": 71.0,
+                    "topHeight": 39.23,
+                    "bottomHeight": 2.0
+                },
+                {
+                    "shape": "cuboidal",
+                    "topXDimension": 106.79,
                     "topYDimension": 8,
                     "bottomXDimension": 101.25,
                     "bottomYDimension": 1.66,
                     "topHeight": 2,
-                    "bottomHeight": 8,
+                    "bottomHeight": 0,
                     "yCount": 8
-                },
-                {
-                    "shape": "cuboidal",
-                    "topXDimension": 107.5,
-                    "topYDimension": 71.25,
-                    "bottomXDimension": 107.25,
-                    "bottomYDimension": 71.0,
-                    "topHeight": 39.22,
-                    "bottomHeight": 2
                 }
             ]
         }