@opentrons/shared-data 0.1.6-alpha.9 → 0.1.7-alpha.1

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

@@ -1,5 +1,6 @@
-import type { CutoutFixtureId, CutoutId, AddressableAreaName } from '../deck';
-import type { ModuleModel, ModuleType } from './types';
+import type { WellOrigin } from '../command';
+import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../deck';
+import type { ModuleModel, ModuleType, PositionReference } from './types';
 export declare const SLOT_LENGTH_MM = 127.76;
 export declare const SLOT_WIDTH_MM = 85.48;
 export declare const SLOT_RENDER_WIDTH = 127.76;
@@ -21,12 +22,13 @@ 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';
 export declare const GRIPPER_V1_2: 'gripperV1.2';
 export declare const GRIPPER_V1_3: 'gripperV1.3';
-export declare const GRIPPER_MODELS: ("gripperV1" | "gripperV1.1" | "gripperV1.2" | "gripperV1.3")[];
+export declare const GRIPPER_MODELS: ("gripperV1.1" | "gripperV1.2" | "gripperV1.3" | "gripperV1")[];
 export declare const OT2_DISPLAY_NAME: 'Opentrons OT-2';
 export declare const FLEX_DISPLAY_NAME: 'Opentrons Flex';
 export declare const FLEX: 'FLEX';
@@ -42,16 +44,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 TEMPERATURE_MODULE_MODELS: ("temperatureModuleV2" | "temperatureModuleV1")[];
 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_OT2_ONLY: ("temperatureModuleV1" | "magneticModuleV1" | "magneticModuleV2" | "thermocyclerModuleV1")[];
-export declare const MODULE_TYPES: ("magneticModuleType" | "temperatureModuleType" | "heaterShakerModuleType" | "thermocyclerModuleType" | "magneticBlockType" | "absorbanceReaderType")[];
+export declare const MODULE_MODELS: ("thermocyclerModuleV2" | "heaterShakerModuleV1" | "temperatureModuleV2" | "magneticBlockV1" | "absorbanceReaderV1" | "flexStackerModuleV1" | "magneticModuleV1" | "magneticModuleV2" | "temperatureModuleV1" | "thermocyclerModuleV1")[];
+export declare const MODULE_MODELS_OT2_ONLY: ("magneticModuleV1" | "magneticModuleV2" | "temperatureModuleV1" | "thermocyclerModuleV1")[];
+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 +172,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 +204,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 +217,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 +230,18 @@ 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 POSITION_REFERENCE_TOP: 'well-top';
+export declare const POSITION_REFERENCE_BOTTOM: 'well-bottom';
+export declare const POSITION_REFERENCE_CENTER: 'well-center';
+export declare const POSITION_REFERENCE_LIQUID_MENISCUS: 'liquid-meniscus';
+export declare const WELL_ORIGIN_TOP: 'top';
+export declare const WELL_ORIGIN_BOTTOM: 'bottom';
+export declare const WELL_ORIGIN_CENTER: 'center';
+export declare const WELL_ORIGIN_MENISCUS: 'meniscus';
+export declare const POSITION_REFERENCE_MAPPED_TO_WELL_ORIGIN: Record<PositionReference, WellOrigin>;
+export declare const SAFE_MOVE_TO_WELL_OFFSET_FROM_TOP_MM = 2;

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

@@ -1,4 +1,4 @@
-import flexDeckDefV5 from '../../deck/definitions/5/ot3_standard.json';
-import ot2DeckDefV5 from '../../deck/definitions/5/ot2_standard.json';
 import ot2DeckDefShortFixedTrashV5 from '../../deck/definitions/5/ot2_short_trash.json';
+import ot2DeckDefV5 from '../../deck/definitions/5/ot2_standard.json';
+import flexDeckDefV5 from '../../deck/definitions/5/ot3_standard.json';
 export { ot2DeckDefV5, ot2DeckDefShortFixedTrashV5, flexDeckDefV5 };

package/lib/js/fixtures.d.ts

@@ -1,6 +1,6 @@
+import type { ModuleLocation } from '../command';
 import type { AddressableAreaName, CutoutFixtureId, CutoutId, OT2CutoutId } from '../deck';
 import type { AddressableArea, CoordinateTuple, CutoutFixture, DeckDefinition, ModuleModel } from './types';
-import type { ModuleLocation } from '../command';
 export declare function getCutoutDisplayName(cutout: CutoutId): string;
 export declare const OT2_CUTOUT_BY_SLOT_ID: {
     [slotId: string]: OT2CutoutId;
@@ -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/gripper.d.ts

@@ -1,3 +1,3 @@
-import type { GripperModel, GripperDefinition } from './types';
+import type { GripperDefinition, GripperModel } from './types';
 export declare const getGripperDef: (gripperModel: GripperModel) => GripperDefinition;
 export declare function getGripperDisplayName(gripperModel: GripperModel): string;

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

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

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/__tests__/liquidClasses.test.d.ts

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

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

@@ -1,4 +1,4 @@
-import type { RunTimeCommand, LabwareDefinition2 } from '..';
+import type { LabwareDefinition2, RunTimeCommand } from '..';
 export interface LabwareDefinitionsByUri {
     [defURI: string]: LabwareDefinition2;
 }

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

@@ -0,0 +1,2 @@
+import type { PositionReference } from '../types';
+export declare const getMmFromBottom: (zValue: number, reference: PositionReference, wellDepth: number | null) => number | null;

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

@@ -1,6 +1,6 @@
 import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../../deck';
 import type { ProtocolAnalysisOutput } from '../../protocol';
-import type { CutoutConfig, CutoutFixture, DeckDefinition, DeckConfiguration, CompletedProtocolAnalysis, CutoutFixtureGroup } from '../types';
+import type { CompletedProtocolAnalysis, CutoutConfig, CutoutFixture, CutoutFixtureGroup, DeckConfiguration, DeckDefinition } from '../types';
 export interface CutoutConfigProtocolSpec extends CutoutConfig {
     requiredAddressableAreas: AddressableAreaName[];
 }

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

@@ -1,2 +1,2 @@
-import type { Coordinates } from '../types';
-export declare function getVectorDifference(pointA: Coordinates, pointB: Coordinates): Coordinates;
+import type { Vector3D } from '../types';
+export declare function getVectorDifference(pointA: Vector3D, pointB: Vector3D): Vector3D;

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

@@ -1,2 +1,2 @@
-import type { Coordinates } from '../types';
-export declare function getVectorSum(pointA: Coordinates, pointB: Coordinates): Coordinates;
+import type { Vector3D } from '../types';
+export declare function getVectorSum(pointA: Vector3D, pointB: Vector3D): Vector3D;

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

@@ -0,0 +1,6 @@
+export declare function getWellRangeForLiquidLabwarePair(volumeByWell: {
+    [well: string]: number;
+}, labwareWellOrdering: string[][]): Array<{
+    wellName: string;
+    volume: number;
+}>;

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

@@ -1,4 +1,5 @@
-import type { DeckDefinition, LabwareDefinition2, ModuleModel, RobotType, ThermalAdapterName } from '../types';
+import type { CutoutId } from '../../deck/types/schemaV5';
+import type { DeckDefinition, LabwareDefinition2, LabwareDefinition3, LiquidClass, ModuleModel, RobotType, ThermalAdapterName } from '../types';
 export { getWellNamePerMultiTip } from './getWellNamePerMultiTip';
 export { getWellTotalVolume } from './getWellTotalVolume';
 export { wellIsRect } from './wellIsRect';
@@ -11,6 +12,7 @@ export * from './parseProtocolData';
 export * from './volume';
 export * from './wellSets';
 export * from './getAreFlexSlotsAdjacent';
+export * from './getMmFromBottom';
 export * from './getModuleVizDims';
 export * from './getVectorDifference';
 export * from './getVectorSum';
@@ -18,6 +20,8 @@ export * from './getLoadedLabwareDefinitionsByUri';
 export * from './getFixedTrashLabwareDefinition';
 export * from './getOccludedSlotCountForModule';
 export * from './labwareInference';
+export * from './linearInterpolate';
+export * from './liquidClasses';
 export * from './getAddressableAreasInProtocol';
 export * from './getFlexSurroundingSlots';
 export * from './getSimplestFlexDeckConfig';
@@ -26,9 +30,19 @@ export * from './formatRunTimeParameterValue';
 export * from './formatRunTimeParameterMinMax';
 export * from './orderRuntimeParameterRangeOptions';
 export * from './sortRunTimeParameters';
+export * from './parseAddressableArea';
+export * from './validateCustomLabwareHelper';
+export * from './getWellRangeForLiquidLabwarePair';
 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 +59,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 +70,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/labwareInference.d.ts

@@ -1,4 +1,4 @@
-import type { LabwareWell, LabwareWellShapeProperties, LabwareDefinition2, LabwareWellGroupMetadata, LabwareBrand } from '../types';
+import type { LabwareBrand, LabwareDefinition2, LabwareWell, LabwareWellGroupMetadata, LabwareWellShapeProperties } from '../types';
 export interface LabwareWellGroupProperties {
     xOffsetFromLeft: number;
     yOffsetFromTop: number;

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/liquidClasses.d.ts

@@ -0,0 +1,8 @@
+import type { PipetteV2Specs } from '..';
+export declare const getCorrectionVolume: (args: {
+    liquidClass: string | null;
+    pipetteSpecs: PipetteV2Specs;
+    tiprackDefUri: string;
+    targetVolume: number;
+    liquidHandlingAction: 'aspirate' | 'singleDispense' | 'multiDispense';
+}) => number;

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

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

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

@@ -1,6 +1,6 @@
-import type { LoadLabwareRunTimeCommand, LoadModuleRunTimeCommand, RunTimeCommand, LabwareLocation } from '../../command/types';
+import type { LabwareLocation, LoadLabwareRunTimeCommand, LoadModuleRunTimeCommand, RunTimeCommand } from '../../command/types';
 import type { PipetteName } from '../pipettes';
-import type { Liquid, LoadedLabware, LoadedModule, LoadedPipette, ModuleModel, LabwareDefinition2 } from '../types';
+import type { LabwareDefinition2, Liquid, LoadedLabware, LoadedModule, LoadedPipette, ModuleModel } from '../types';
 interface PipetteNamesByMount {
     left: PipetteName | null;
     right: PipetteName | 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

@@ -1,131 +1,19 @@
-import labwareSchemaV2 from '../labware/schemas/2.json';
-import fixture96Plate from '../labware/fixtures/2/fixture_96_plate.json';
 import fixture12Trough from '../labware/fixtures/2/fixture_12_trough.json';
 import fixture24Tuberack from '../labware/fixtures/2/fixture_24_tuberack.json';
-import fixtureTiprack10ul from '../labware/fixtures/2/fixture_tiprack_10_ul.json';
-import fixtureTiprack300ul from '../labware/fixtures/2/fixture_tiprack_300_ul.json';
+import fixture96Plate from '../labware/fixtures/2/fixture_96_plate.json';
+import fixture384Plate from '../labware/fixtures/2/fixture_384_plate.json';
+import fixtureCalibrationBlock from '../labware/fixtures/2/fixture_calibration_block.json';
 import fixtureTiprack1000ul from '../labware/fixtures/2/fixture_flex_96_tiprack_1000ul.json';
 import fixtureTiprackAdapter from '../labware/fixtures/2/fixture_flex_96_tiprack_adapter.json';
-import fixtureCalibrationBlock from '../labware/fixtures/2/fixture_calibration_block.json';
-import fixture384Plate from '../labware/fixtures/2/fixture_384_plate.json';
+import fixtureTiprack10ul from '../labware/fixtures/2/fixture_tiprack_10_ul.json';
+import fixtureTiprack300ul from '../labware/fixtures/2/fixture_tiprack_300_ul.json';
 import fixtureTrash from '../labware/fixtures/2/fixture_trash.json';
-import opentrons96Tiprack10UlV1Uncasted from '../labware/definitions/2/opentrons_96_tiprack_10ul/1.json';
+import labwareSchemaV2 from '../labware/schemas/2.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/labwareTools/index.d.ts

@@ -1,4 +1,4 @@
-import type { LabwareDefinition2 as Definition, LabwareMetadata as Metadata, LabwareDimensions as Dimensions, LabwareBrand as Brand, LabwareParameters as Params, LabwareWell as Well, LabwareWellProperties as InputWell, LabwareWellGroup as WellGroup, LabwareOffset as Offset, LabwareVolumeUnits as VolumeUnits, ModuleModel, LabwareOffset } from '../types';
+import type { LabwareBrand as Brand, LabwareDefinition2 as Definition, LabwareDimensions as Dimensions, LabwareWellProperties as InputWell, LabwareOffset, LabwareMetadata as Metadata, ModuleModel, LabwareOffset as Offset, LabwareParameters as Params, LabwareVolumeUnits as VolumeUnits, LabwareWell as Well, LabwareWellGroup as WellGroup } from '../types';
 export declare const DEFAULT_CUSTOM_NAMESPACE = "custom_beta";
 interface Cell {
     row: number;

package/lib/js/liquidClasses.d.ts

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

package/lib/js/modules.d.ts

@@ -1,4 +1,4 @@
-import type { ModuleModel, ModuleModelWithLegacy, ModuleType, ModuleDefinition } from './types';
+import type { ModuleDefinition, ModuleModel, ModuleModelWithLegacy, ModuleType } from './types';
 export declare const getModuleDef2: (moduleModel: ModuleModel) => ModuleDefinition;
 export declare function normalizeModuleModel(legacyModule: ModuleModelWithLegacy): ModuleModel;
 export declare function getModuleType(moduleModel: ModuleModel): ModuleType;

package/lib/js/pipettes.d.ts

@@ -1,6 +1,6 @@
-import pipetteNameSpecs from '../pipette/definitions/1/pipetteNameSpecs.json';
 import pipetteModelSpecs from '../pipette/definitions/1/pipetteModelSpecs.json';
-import type { PipetteV2Specs, PipetteNameSpecs, PipetteModelSpecs } from './types';
+import pipetteNameSpecs from '../pipette/definitions/1/pipetteNameSpecs.json';
+import type { PipetteModelSpecs, PipetteNameSpecs, PipetteV2Specs } from './types';
 type SortableProps = 'maxVolume' | 'channels';
 export type PipetteName = keyof typeof pipetteNameSpecs;
 export type PipetteModel = keyof typeof pipetteModelSpecs.config;
@@ -13,3 +13,4 @@ export declare const getIncompatiblePipetteNames: (currentPipette: PipetteName)
 export * from '../pipette/fixtures/name';
 export * from '../pipette/fixtures/index';
 export declare const getPipetteSpecsV2: (name?: PipetteName | PipetteModel) => PipetteV2Specs | null;
+export declare const getFlexNameConversion: (pipetteSpec: PipetteV2Specs) => string;