@opentrons/shared-data 0.1.5 → 0.1.6-alpha.11

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

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

package/lib/js/constants.d.ts

@@ -1,5 +1,5 @@
 import type { CutoutFixtureId, CutoutId, AddressableAreaName } from '../deck';
-import type { ModuleType } from './types';
+import type { ModuleModel, ModuleType } 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;
@@ -20,11 +20,14 @@ export declare const TEMPERATURE_MODULE_V2: 'temperatureModuleV2';
 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 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_MODELS: ("gripperV1" | "gripperV1.1" | "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 OT2_DISPLAY_NAME: 'Opentrons OT-2';
 export declare const FLEX_DISPLAY_NAME: 'Opentrons Flex';
 export declare const FLEX: 'FLEX';
 export declare const GEN2: 'GEN2';
@@ -38,15 +41,17 @@ export declare const MAGNETIC_MODULE_TYPE: 'magneticModuleType';
 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 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: ("thermocyclerModuleV1" | "thermocyclerModuleV2")[];
+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 MAGNETIC_BLOCK_MODELS: "magneticBlockV1"[];
-export declare const MODULE_MODELS: ("magneticModuleV1" | "magneticModuleV2" | "temperatureModuleV1" | "temperatureModuleV2" | "thermocyclerModuleV1" | "thermocyclerModuleV2" | "heaterShakerModuleV1" | "magneticBlockV1")[];
-export declare const MODULE_MODELS_OT2_ONLY: ("magneticModuleV1" | "magneticModuleV2" | "temperatureModuleV1" | "thermocyclerModuleV1")[];
-export declare const MODULE_TYPES: ("magneticModuleType" | "temperatureModuleType" | "thermocyclerModuleType" | "heaterShakerModuleType" | "magneticBlockType")[];
+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 GEN_ONE_MULTI_PIPETTES: string[];
 export declare const IDENTITY_VECTOR: {
     x: number;
@@ -93,6 +98,10 @@ export declare const SINGLE_LEFT_CUTOUTS: CutoutId[];
 export declare const SINGLE_CENTER_CUTOUTS: CutoutId[];
 export declare const SINGLE_RIGHT_CUTOUTS: CutoutId[];
 export declare const STAGING_AREA_CUTOUTS: CutoutId[];
+export declare const TEMPERATURE_MODULE_CUTOUTS: CutoutId[];
+export declare const HEATER_SHAKER_CUTOUTS: CutoutId[];
+export declare const THERMOCYCLER_MODULE_CUTOUTS: CutoutId[];
+export declare const ABSORBANCE_READER_CUTOUTS: CutoutId[];
 export declare const WASTE_CHUTE_CUTOUT: 'cutoutD3';
 export declare const A1_ADDRESSABLE_AREA: 'A1';
 export declare const A2_ADDRESSABLE_AREA: 'A2';
@@ -122,6 +131,49 @@ export declare const ONE_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA: '1ChannelWasteChu
 export declare const EIGHT_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA: '8ChannelWasteChute';
 export declare const NINETY_SIX_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA: '96ChannelWasteChute';
 export declare const GRIPPER_WASTE_CHUTE_ADDRESSABLE_AREA: 'gripperWasteChute';
+export declare const THERMOCYCLER_ADDRESSABLE_AREA: 'thermocyclerModuleV2';
+export declare const HEATERSHAKER_A1_ADDRESSABLE_AREA: 'heaterShakerV1A1';
+export declare const HEATERSHAKER_B1_ADDRESSABLE_AREA: 'heaterShakerV1B1';
+export declare const HEATERSHAKER_C1_ADDRESSABLE_AREA: 'heaterShakerV1C1';
+export declare const HEATERSHAKER_D1_ADDRESSABLE_AREA: 'heaterShakerV1D1';
+export declare const HEATERSHAKER_A3_ADDRESSABLE_AREA: 'heaterShakerV1A3';
+export declare const HEATERSHAKER_B3_ADDRESSABLE_AREA: 'heaterShakerV1B3';
+export declare const HEATERSHAKER_C3_ADDRESSABLE_AREA: 'heaterShakerV1C3';
+export declare const HEATERSHAKER_D3_ADDRESSABLE_AREA: 'heaterShakerV1D3';
+export declare const TEMPERATURE_MODULE_A1_ADDRESSABLE_AREA: 'temperatureModuleV2A1';
+export declare const TEMPERATURE_MODULE_B1_ADDRESSABLE_AREA: 'temperatureModuleV2B1';
+export declare const TEMPERATURE_MODULE_C1_ADDRESSABLE_AREA: 'temperatureModuleV2C1';
+export declare const TEMPERATURE_MODULE_D1_ADDRESSABLE_AREA: 'temperatureModuleV2D1';
+export declare const TEMPERATURE_MODULE_A3_ADDRESSABLE_AREA: 'temperatureModuleV2A3';
+export declare const TEMPERATURE_MODULE_B3_ADDRESSABLE_AREA: 'temperatureModuleV2B3';
+export declare const TEMPERATURE_MODULE_C3_ADDRESSABLE_AREA: 'temperatureModuleV2C3';
+export declare const TEMPERATURE_MODULE_D3_ADDRESSABLE_AREA: 'temperatureModuleV2D3';
+export declare const MAGNETIC_BLOCK_A1_ADDRESSABLE_AREA: 'magneticBlockV1A1';
+export declare const MAGNETIC_BLOCK_B1_ADDRESSABLE_AREA: 'magneticBlockV1B1';
+export declare const MAGNETIC_BLOCK_C1_ADDRESSABLE_AREA: 'magneticBlockV1C1';
+export declare const MAGNETIC_BLOCK_D1_ADDRESSABLE_AREA: 'magneticBlockV1D1';
+export declare const MAGNETIC_BLOCK_A2_ADDRESSABLE_AREA: 'magneticBlockV1A2';
+export declare const MAGNETIC_BLOCK_B2_ADDRESSABLE_AREA: 'magneticBlockV1B2';
+export declare const MAGNETIC_BLOCK_C2_ADDRESSABLE_AREA: 'magneticBlockV1C2';
+export declare const MAGNETIC_BLOCK_D2_ADDRESSABLE_AREA: 'magneticBlockV1D2';
+export declare const MAGNETIC_BLOCK_A3_ADDRESSABLE_AREA: 'magneticBlockV1A3';
+export declare const MAGNETIC_BLOCK_B3_ADDRESSABLE_AREA: 'magneticBlockV1B3';
+export declare const MAGNETIC_BLOCK_C3_ADDRESSABLE_AREA: 'magneticBlockV1C3';
+export declare const MAGNETIC_BLOCK_D3_ADDRESSABLE_AREA: 'magneticBlockV1D3';
+export declare const ABSORBANCE_READER_D3_ADDRESSABLE_AREA: 'absorbanceReaderV1D3';
+export declare const ABSORBANCE_READER_C3_ADDRESSABLE_AREA: 'absorbanceReaderV1C3';
+export declare const ABSORBANCE_READER_B3_ADDRESSABLE_AREA: 'absorbanceReaderV1B3';
+export declare const ABSORBANCE_READER_A3_ADDRESSABLE_AREA: 'absorbanceReaderV1A3';
+export declare const ABSORBANCE_READER_LID_DOCK_A4_ADDRESSABLE_AREA: 'absorbanceReaderV1LidDockA4';
+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 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_USB_MODULE_ADDRESSABLE_AREAS: AddressableAreaName[];
+export declare const FLEX_MODULE_ADDRESSABLE_AREAS: AddressableAreaName[];
 export declare const ADDRESSABLE_AREA_1: '1';
 export declare const ADDRESSABLE_AREA_2: '2';
 export declare const ADDRESSABLE_AREA_3: '3';
@@ -147,10 +199,24 @@ export declare const WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE: 'wasteChuteRight
 export declare const WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE: 'wasteChuteRightAdapterNoCover';
 export declare const STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE: 'stagingAreaSlotWithWasteChuteRightAdapterCovered';
 export declare const STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE: 'stagingAreaSlotWithWasteChuteRightAdapterNoCover';
+export declare const HEATERSHAKER_MODULE_V1_FIXTURE: 'heaterShakerModuleV1';
+export declare const TEMPERATURE_MODULE_V2_FIXTURE: 'temperatureModuleV2';
+export declare const MAGNETIC_BLOCK_V1_FIXTURE: 'magneticBlockV1';
+export declare const STAGING_AREA_SLOT_WITH_MAGNETIC_BLOCK_V1_FIXTURE: 'stagingAreaSlotWithMagneticBlockV1';
+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 MODULE_FIXTURES_BY_MODEL: {
+    [moduleModel in ModuleModel]?: CutoutFixtureId[];
+};
+export declare const FLEX_USB_MODULE_FIXTURES: CutoutFixtureId[];
+export declare const MAGNETIC_BLOCK_FIXTURES: CutoutFixtureId[];
 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 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";

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

@@ -0,0 +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';
+export { ot2DeckDefV5, ot2DeckDefShortFixedTrashV5, flexDeckDefV5 };

package/lib/js/fixtures.d.ts

@@ -1,5 +1,6 @@
-import type { CutoutFixtureId, CutoutId, OT2CutoutId } from '../deck';
-import type { AddressableArea, CoordinateTuple, DeckDefinition } from './types';
+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;
@@ -12,5 +13,17 @@ export declare const FLEX_SINGLE_SLOT_BY_CUTOUT_ID: {
 };
 export declare function getPositionFromSlotId(slotId: string, deckDef: DeckDefinition): CoordinateTuple | null;
 export declare function getAddressableAreaFromSlotId(slotId: string, deckDef: DeckDefinition): AddressableArea | null;
-export declare function getFixtureDisplayName(cutoutFixtureId: CutoutFixtureId | null): string;
-export declare const isAddressableAreaStandardSlot: (addressableAreaId: string, deckDef: DeckDefinition) => boolean;
+export declare function getCutoutFixtureIdsForModuleModel(moduleModel: ModuleModel): CutoutFixtureId[];
+export declare function getCutoutFixturesForModuleModel(moduleModel: ModuleModel, deckDef: DeckDefinition): CutoutFixture[];
+export declare function getFixtureIdByCutoutIdFromModuleAnchorCutoutId(anchorCutoutId: CutoutId | null, moduleFixtures: CutoutFixture[]): {
+    [cutoutId in CutoutId]?: CutoutFixtureId;
+};
+export declare function getFixtureIdByCutoutIdFromModuleSlotName(slotName: string, moduleFixtures: CutoutFixture[], // cutout fixtures for a specific module model
+deckDef: DeckDefinition): {
+    [cutoutId in CutoutId]?: CutoutFixtureId;
+};
+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 const isAddressableAreaStandardSlot: (addressableAreaName: AddressableAreaName, deckDef: DeckDefinition) => boolean;

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

@@ -0,0 +1,2 @@
+import simpleAnalysisFileFixture from './simpleAnalysisFile.json';
+export { simpleAnalysisFileFixture };

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+import type { ValueRunTimeParameter } from '../types';
+/**
+ * Formats the runtime parameter's default value.
+ *
+ * @param {RunTimeParameter} runTimeParameter - The runtime parameter whose default value is to be formatted.
+ * @param {Function} [t] - An optional function for localization.
+ *
+ * @returns {string} The formatted default value of the runtime parameter.
+ *
+ */
+export declare const formatRunTimeParameterDefaultValue: (runTimeParameter: ValueRunTimeParameter, t?: any) => string;

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

@@ -0,0 +1,23 @@
+import type { RunTimeParameter } from '../types';
+/**
+ * Formats the runtime parameter's minimum and maximum values.
+ *
+ * @param {RunTimeParameter} runTimeParameter - The runtime parameter whose min and max values are to be formatted.
+ *
+ * @returns {string} The formatted min-max value of the runtime parameter.
+ *
+ * @example
+ * const runTimeParameter = {
+ *    value: 6.5,
+ *   displayName: 'EtoH Volume',
+ *     variableName: 'ETOH_VOLUME',
+ *     description: '70% ethanol volume',
+ *     type: 'float',
+ *     suffix: 'mL',
+ *     min: 1.5,
+ *     max: 10.0,
+ *     default: 6.5,
+ * }
+ * console.log(formatRunTimeParameterMinMax(runTimeParameter)); // "1.5-10.0"
+ */
+export declare const formatRunTimeParameterMinMax: (runTimeParameter: RunTimeParameter) => string;

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

@@ -0,0 +1,11 @@
+import type { RunTimeParameter } from '../types';
+/**
+ * Formats the runtime parameter value.
+ *
+ * @param {ValueRunTimeParameter} runTimeParameter - The value runtime parameter to be formatted.
+ * @param {Function} t - A function for localization.
+ *
+ * @returns {string} The formatted runtime parameter value.
+ *
+ */
+export declare const formatRunTimeParameterValue: (runTimeParameter: RunTimeParameter, t: any) => string;

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

@@ -0,0 +1,2 @@
+import type { DeckSlotId } from '../types';
+export declare const getAreFlexSlotsAdjacent: (slot1: DeckSlotId, slot2: DeckSlotId) => boolean;

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

@@ -0,0 +1,2 @@
+import type { LabwareDefinition2 } from '..';
+export declare function getFixedTrashLabwareDefinition(): LabwareDefinition2;

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

@@ -0,0 +1,3 @@
+import type { DeckSlotId } from '../types';
+export declare const FLEX_GRID: string[][];
+export declare const getFlexSurroundingSlots: (slot: DeckSlotId, stagingAreaSlots: DeckSlotId[]) => DeckSlotId[];

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

@@ -1,4 +1,4 @@
-import { ModuleType, ModuleOrientation } from '../types';
+import type { ModuleOrientation } from '../types';
 export interface ModuleVizDims {
     xOffset: number;
     yOffset: number;
@@ -9,7 +9,6 @@ export interface ModuleVizDims {
     childXDimension: number;
     childYDimension: number;
 }
-export declare const getModuleVizDims: (orientation: ModuleOrientation, moduleType: ModuleType) => ModuleVizDims;
 type DeckSlot = string;
 export declare const inferModuleOrientationFromSlot: (slot: DeckSlot) => ModuleOrientation;
 export declare const inferModuleOrientationFromXCoordinate: (xCoordinate: number) => ModuleOrientation;

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

@@ -1,6 +1,6 @@
-import type { AddressableAreaName, CutoutId } from '../../deck';
+import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../../deck';
 import type { ProtocolAnalysisOutput } from '../../protocol';
-import type { CutoutConfig, CutoutFixture, DeckDefinition, DeckConfiguration, CompletedProtocolAnalysis } from '../types';
+import type { CutoutConfig, CutoutFixture, DeckDefinition, DeckConfiguration, CompletedProtocolAnalysis, CutoutFixtureGroup } from '../types';
 export interface CutoutConfigProtocolSpec extends CutoutConfig {
     requiredAddressableAreas: AddressableAreaName[];
 }
@@ -10,5 +10,6 @@ export declare function getSimplestDeckConfigForProtocol(protocolAnalysis: Compl
 export declare function getCutoutFixturesForAddressableAreas(addressableAreas: AddressableAreaName[], cutoutFixtures: CutoutFixture[]): CutoutFixture[];
 export declare function getCutoutFixturesForCutoutId(cutoutId: CutoutId, cutoutFixtures: CutoutFixture[]): CutoutFixture[];
 export declare function getCutoutIdForSlotName(slotName: string, deckDef: DeckDefinition): CutoutId | null;
+export declare function getFixtureGroupForCutoutFixture(cutoutFixtureId: CutoutFixtureId, cutoutFixtures: CutoutFixture[]): CutoutFixtureGroup;
 export declare function getCutoutIdForAddressableArea(addressableArea: AddressableAreaName, cutoutFixtures: CutoutFixture[]): CutoutId | null;
 export declare function getSimplestFixtureForAddressableAreas(cutoutId: CutoutId, requiredAddressableAreas: AddressableAreaName[], allCutoutFixtures: CutoutFixture[]): CutoutFixture | null;

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

@@ -0,0 +1,2 @@
+import type { LabwareDefinition2 } from '..';
+export declare function getTipTypeFromTipRackDefinition(tipRackDef: LabwareDefinition2): string;

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

@@ -4,17 +4,28 @@ export { getWellTotalVolume } from './getWellTotalVolume';
 export { wellIsRect } from './wellIsRect';
 export { orderWells } from './orderWells';
 export { get96Channel384WellPlateWells } from './get96Channel384WellPlateWells';
+export { getTipTypeFromTipRackDefinition } from './getTipTypeFromTipRackDefinition';
+export * from './__fixtures__';
+export * from './parseProtocolCommands';
 export * from './parseProtocolData';
 export * from './volume';
 export * from './wellSets';
+export * from './getAreFlexSlotsAdjacent';
 export * from './getModuleVizDims';
 export * from './getVectorDifference';
 export * from './getVectorSum';
 export * from './getLoadedLabwareDefinitionsByUri';
+export * from './getFixedTrashLabwareDefinition';
 export * from './getOccludedSlotCountForModule';
 export * from './labwareInference';
 export * from './getAddressableAreasInProtocol';
+export * from './getFlexSurroundingSlots';
 export * from './getSimplestFlexDeckConfig';
+export * from './formatRunTimeParameterDefaultValue';
+export * from './formatRunTimeParameterValue';
+export * from './formatRunTimeParameterMinMax';
+export * from './orderRuntimeParameterRangeOptions';
+export * from './sortRunTimeParameters';
 export declare const getLabwareDefIsStandard: (def: LabwareDefinition2) => boolean;
 export declare const getLabwareDefURI: (def: LabwareDefinition2) => string;
 export declare const constructLabwareDefURI: (namespace: string, loadName: string, version: string) => string;
@@ -34,6 +45,7 @@ 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;
 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;

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

@@ -0,0 +1,17 @@
+import type { Choice } from '../types';
+export declare const isNumeric: (str: string) => boolean;
+/**
+ * This function sorts an array of strings in numerical and alphabetical order.
+ * @param {Choice[]} - The array of Choice
+ * Choice is an object like {displayName: 'Single channel 50µL', value: 'flex_1channel_50' }
+ * @returns {string} The ordered string with ","
+ *
+ * @example
+ * const numChoices = [
+ *    { displayName: '20', value: 20 },
+ *    { displayName: '16', value: 16 },
+ * ]
+ * console.log(orderRuntimeParameterRangeOptions(numChoices) // 16,20
+ *
+ */
+export declare const orderRuntimeParameterRangeOptions: (choices: Choice[]) => string;

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

@@ -0,0 +1,61 @@
+import type { LoadLabwareRunTimeCommand, LoadModuleRunTimeCommand, RunTimeCommand, LabwareLocation } from '../../command/types';
+import type { PipetteName } from '../pipettes';
+import type { Liquid, LoadedLabware, LoadedModule, LoadedPipette, ModuleModel, LabwareDefinition2 } from '../types';
+interface PipetteNamesByMount {
+    left: PipetteName | null;
+    right: PipetteName | null;
+}
+export declare function parseInitialPipetteNamesByMount(commands: RunTimeCommand[]): PipetteNamesByMount;
+export declare function parsePipetteEntity(commands: RunTimeCommand[]): LoadedPipette[];
+export declare function parseAllRequiredModuleModels(commands: RunTimeCommand[]): ModuleModel[];
+export declare function parseRequiredModulesEntity(commands: RunTimeCommand[]): LoadedModule[];
+interface LoadedLabwareBySlot {
+    [slotName: string]: LoadLabwareRunTimeCommand;
+}
+export declare function parseInitialLoadedLabwareBySlot(commands: RunTimeCommand[]): LoadedLabwareBySlot;
+export declare function getTopLabwareInfo(labwareId: string, loadLabwareCommands: LoadLabwareRunTimeCommand[], currentStackHeight?: number): {
+    topLabwareId: string;
+    topLabwareDefinition?: LabwareDefinition2;
+    topLabwareDisplayName?: string;
+};
+export declare function getLabwareStackCountAndLocation(topLabwareId: string, commands: RunTimeCommand[], initialQuantity?: number): {
+    labwareQuantity: number;
+    labwareLocation: LabwareLocation;
+};
+export interface LoadedLabwareByAdapter {
+    [labwareId: string]: LoadLabwareRunTimeCommand;
+}
+export declare function parseInitialLoadedLabwareByAdapter(commands: RunTimeCommand[]): LoadedLabwareByAdapter;
+interface LoadedLabwareByModuleId {
+    [moduleId: string]: LoadLabwareRunTimeCommand;
+}
+export declare function parseInitialLoadedLabwareByModuleId(commands: RunTimeCommand[]): LoadedLabwareByModuleId;
+export declare function parseInitialLoadedLabwareEntity(commands: RunTimeCommand[]): LoadedLabware[];
+interface LoadedModulesBySlot {
+    [slotName: string]: LoadModuleRunTimeCommand;
+}
+export declare function parseInitialLoadedModulesBySlot(commands: RunTimeCommand[]): LoadedModulesBySlot;
+export interface LiquidsById {
+    [liquidId: string]: {
+        displayName: string;
+        description: string;
+        displayColor?: string;
+    };
+}
+export interface ParsedLiquid extends Omit<Liquid, 'displayColor'> {
+    displayColor: string;
+}
+export declare function parseLiquidsInLoadOrder(liquids: Liquid[], commands: RunTimeCommand[]): ParsedLiquid[];
+interface LabwareLiquidInfo {
+    labwareId: string;
+    volumeByWell: {
+        [well: string]: number;
+    };
+}
+/** @deprecated instead use LabwareByLiquidId from components/src/hardware-sim/ProtocolDeck/types */
+export interface LabwareByLiquidId {
+    [liquidId: string]: LabwareLiquidInfo[];
+}
+/** @deprecated instead use getLabwareInfoByLiquidId from components/src/hardware-sim/ProtocolDeck/utils */
+export declare function parseLabwareInfoByLiquidId(commands: RunTimeCommand[]): LabwareByLiquidId;
+export {};

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

@@ -0,0 +1,9 @@
+import type { RunTimeParameter } from '..';
+/**
+ * This function sorts an array of runtime parameters. If a parameter of type 'csv_file' exists,
+ * it moves it to the beginning of the array.
+ *
+ * @param runTimeParameters - An array of runtime parameters.
+ * @returns A new array of runtime parameters with 'csv_file' type parameter at the beginning if it exists.
+ */
+export declare const sortRuntimeParameters: (runTimeParameters: RunTimeParameter[]) => RunTimeParameter[];

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

@@ -1,9 +1,27 @@
-import type { LabwareDefinition2, PipetteNameSpecs } from '../types';
+import type { LabwareDefinition2, NozzleLayoutConfig, PipetteV2Specs } from '../types';
 type WellSetByPrimaryWell = string[][];
+export interface NozzleLayoutDetails {
+    nozzleConfig: NozzleLayoutConfig;
+    activeNozzleCount: number;
+}
+export interface WellSetForMultiChannelParams {
+    labwareDef: LabwareDefinition2;
+    wellName: string;
+    channels: 8 | 96;
+    pipetteNozzleDetails?: NozzleLayoutDetails;
+}
 export interface WellSetHelpers {
     getAllWellSetsForLabware: (labwareDef: LabwareDefinition2) => WellSetByPrimaryWell;
-    getWellSetForMultichannel: (labwareDef: LabwareDefinition2, well: string, channels: 8 | 96) => string[] | null | undefined;
-    canPipetteUseLabware: (pipetteSpec: PipetteNameSpecs, labwareDef?: LabwareDefinition2, trashName?: string) => boolean;
+    /** Given a well for a labware, returns the well set it belongs to (or null)
+     * for 8-channel and 96-channel access.
+     * Ex: C2 for 96-flat => ['A2', 'B2', 'C2', ... 'H2']
+     * Or A1 for trough => ['A1', 'A1', 'A1', ...]
+     *
+     * @param {string[] | undefined} pipetteNozzleDetails If specified, return only the wells utilized by the active pipette
+     * nozzle configuration.
+     **/
+    getWellSetForMultichannel: (params: WellSetForMultiChannelParams) => string[] | null | undefined;
+    canPipetteUseLabware: (pipetteSpec: PipetteV2Specs, labwareDef?: LabwareDefinition2, trashName?: string) => boolean;
 }
 export declare const makeWellSetHelpers: () => WellSetHelpers;
 export {};

package/lib/js/index.d.ts

@@ -1,14 +1,17 @@
+export * from '../command';
+export * from '../deck';
+export * from '../protocol';
 export * from './constants';
+export * from './deck';
+export * from './errors';
+export * from './fixtures';
 export * from './getLabware';
+export * from './gripper';
 export * from './helpers';
-export * from './pipettes';
-export * from './types';
+export * from './labware';
 export * from './labwareTools';
 export * from './modules';
-export * from './fixtures';
-export * from './gripper';
-export * from '../protocol';
-export * from '../deck';
+export * from './pipettes';
+export * from './protocols';
 export * from './titleCase';
-export * from './errors';
-export * from './fixtures';
+export * from './types';

package/lib/js/labware.d.ts

@@ -0,0 +1,131 @@
+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 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 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 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 };