@opentrons/shared-data 0.1.7-alpha.1 → 0.2.1-alpha.0

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

@@ -1,4 +1,4 @@
-import type { LabwareDefinition2 } from '..';
+import type { LabwareDefinition } 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
@@ -6,4 +6,4 @@ import type { LabwareDefinition2 } from '..';
  * @param definition - a labware definition
  * @returns A boolean for if they exist
  */
-export declare const validateCustomLabwareHelper: (definition?: LabwareDefinition2 | null) => boolean;
+export declare const validateCustomLabwareHelper: (definition?: LabwareDefinition | null) => boolean;

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

@@ -0,0 +1,14 @@
+import type { CoordinateTuple, Vector3D } from '../types';
+export declare const IDENTITY_VECTOR: Vector3D;
+/**
+ * Add an arbitrary number of vectors.
+ * e.g. `getVectorSum(a, b, c)` is a + b + c.
+ */
+export declare function getVectorSum(first: Vector3D, ...rest: Vector3D[]): Vector3D;
+/**
+ * Subtract an arbitrary number of vectors.
+ * e.g. `getVectorDifference(a, b, c)` is a - b - c.
+ */
+export declare function getVectorDifference(first: Vector3D, ...rest: Vector3D[]): Vector3D;
+export declare function getVectorInverse(vector: Vector3D): Vector3D;
+export declare function coordinateTupleToVector3D(coordinateTuple: CoordinateTuple): Vector3D;

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

@@ -1,17 +1,17 @@
-import type { LabwareDefinition2, NozzleLayoutConfig, PipetteV2Specs } from '../types';
+import type { LabwareDefinition, NozzleLayoutConfig, PipetteV2Specs } from '../types';
 type WellSetByPrimaryWell = string[][];
 export interface NozzleLayoutDetails {
     nozzleConfig: NozzleLayoutConfig;
     activeNozzleCount: number;
 }
 export interface WellSetForMultiChannelParams {
-    labwareDef: LabwareDefinition2;
+    labwareDef: LabwareDefinition;
     wellName: string;
     channels: 8 | 96;
     pipetteNozzleDetails?: NozzleLayoutDetails;
 }
 export interface WellSetHelpers {
-    getAllWellSetsForLabware: (labwareDef: LabwareDefinition2) => WellSetByPrimaryWell;
+    getAllWellSetsForLabware: (labwareDef: LabwareDefinition) => WellSetByPrimaryWell;
     /** 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']
@@ -21,7 +21,7 @@ export interface WellSetHelpers {
      * nozzle configuration.
      **/
     getWellSetForMultichannel: (params: WellSetForMultiChannelParams) => string[] | null | undefined;
-    canPipetteUseLabware: (pipetteSpec: PipetteV2Specs, labwareDef?: LabwareDefinition2, trashName?: string) => boolean;
+    canPipetteUseLabware: (pipetteSpec: PipetteV2Specs, labwareDef?: LabwareDefinition, trashName?: string) => boolean;
 }
 export declare const makeWellSetHelpers: () => WellSetHelpers;
 export {};

package/lib/js/labware.d.ts

@@ -9,11 +9,12 @@ 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 labwareSchemaV2 from '../labware/schemas/2.json';
-import type { LabwareDefByDefURI, LabwareDefinition2, LegacyLabwareDefByName } from './types';
+import labwareSchemaV3 from '../labware/schemas/3.json';
+import type { LabwareDef2ByDefURI, LabwareDefinition2, LegacyLabwareDefByName } from './types';
 export declare const getAllLabwareDefs: () => Record<string, LabwareDefinition2>;
-export declare function getAllDefinitions(blockList?: string[]): LabwareDefByDefURI;
+export declare function getAllDefinitions(blockList?: string[]): LabwareDef2ByDefURI;
 export declare function getAllLegacyDefinitions(): LegacyLabwareDefByName;
-export { labwareSchemaV2, fixture96Plate, fixture12Trough, fixture24Tuberack, fixtureTiprack10ul, fixtureTiprack300ul, fixtureTiprack1000ul, fixtureTiprackAdapter, fixtureTrash, fixture384Plate, fixtureCalibrationBlock, };
+export { labwareSchemaV2, labwareSchemaV3, 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

@@ -1,2 +1,6 @@
 import type { LiquidClass } from '.';
+export declare const WATER_LIQUID_CLASS_NAME = "waterV1";
+export declare const NONE_LIQUID_CLASS_NAME = "none";
+export declare const GLYCEROL_LIQUID_CLASS_NAME = "glycerol50V1";
+export declare const ETHANOL_LIQUID_CLASS_NAME = "ethanol80V1";
 export declare const getAllLiquidClassDefs: () => Record<string, LiquidClass>;

package/lib/js/modules.d.ts

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

package/lib/js/types.d.ts

@@ -1,7 +1,7 @@
 import type { LoadedLabwareLocation, RunTimeCommand } from '../command/types';
 import type { CommandAnnotation } from '../commandAnnotation/types';
 import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../deck';
-import type { ABSORBANCE_READER_TYPE, ABSORBANCE_READER_V1, EXTENSION, FLEX, FLEX_STACKER_MODULE_TYPE, FLEX_STACKER_MODULE_V1, GEN1, GEN2, GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2, GRIPPER_V1_3, HEATERSHAKER_MODULE_TYPE, HEATERSHAKER_MODULE_V1, LEFT, MAGDECK, MAGNETIC_BLOCK_TYPE, MAGNETIC_BLOCK_V1, MAGNETIC_MODULE_TYPE, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2, POSITION_REFERENCE_BOTTOM, POSITION_REFERENCE_CENTER, POSITION_REFERENCE_LIQUID_MENISCUS, POSITION_REFERENCE_TOP, RIGHT, TEMPDECK, TEMPERATURE_MODULE_TYPE, TEMPERATURE_MODULE_V1, TEMPERATURE_MODULE_V2, THERMOCYCLER, THERMOCYCLER_MODULE_TYPE, THERMOCYCLER_MODULE_V1, THERMOCYCLER_MODULE_V2 } from './constants';
+import type { ABSORBANCE_READER_TYPE, ABSORBANCE_READER_V1, AddressableAreaNamesWithFakes, AddressableAreaWithFakes, AreaTypeWithFakes, CutoutFixtureIdsWithFakes, EXTENSION, FLEX, FLEX_STACKER_MODULE_TYPE, FLEX_STACKER_MODULE_V1, GEN1, GEN2, GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2, GRIPPER_V1_3, HEATERSHAKER_MODULE_TYPE, HEATERSHAKER_MODULE_V1, LEFT, MAGDECK, MAGNETIC_BLOCK_TYPE, MAGNETIC_BLOCK_V1, MAGNETIC_MODULE_TYPE, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2, POSITION_REFERENCE_BOTTOM, POSITION_REFERENCE_CENTER, POSITION_REFERENCE_LIQUID_MENISCUS, POSITION_REFERENCE_TOP, RIGHT, TEMPDECK, TEMPERATURE_MODULE_TYPE, TEMPERATURE_MODULE_V1, TEMPERATURE_MODULE_V2, THERMOCYCLER, THERMOCYCLER_MODULE_TYPE, THERMOCYCLER_MODULE_V1, THERMOCYCLER_MODULE_V2 } from './constants';
 import type { PipetteName } from './pipettes';
 export type RobotType = 'OT-2 Standard' | 'OT-3 Standard';
 export interface RobotDefinition {
@@ -161,7 +161,20 @@ export interface AxisAlignedBoundingBox3D {
 }
 export interface Extents {
     total: AxisAlignedBoundingBox3D;
-    footprint: AxisAlignedBoundingBox2D;
+}
+export interface SlotFootprintAsChildFeature {
+    z: number;
+    backLeft: Vector2D;
+    frontRight: Vector2D;
+}
+export interface SlotFootprintAsParentFeature {
+    z: number;
+    backLeft: Vector2D;
+    frontRight: Vector2D;
+}
+export interface LocatingFeatures {
+    slotFootprintAsChild?: SlotFootprintAsChildFeature;
+    slotFootprintAsParent?: SlotFootprintAsParentFeature;
 }
 export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance' | 'lid' | 'system';
 export interface LabwareDefinition2 {
@@ -190,6 +203,7 @@ export interface LabwareDefinition3 {
     namespace: string;
     metadata: LabwareMetadata;
     extents: Extents;
+    features: LocatingFeatures;
     parameters: LabwareParameters;
     brand: LabwareBrand;
     ordering: string[][];
@@ -202,7 +216,8 @@ export interface LabwareDefinition3 {
     compatibleParentLabware?: string[];
     innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
 }
-export interface LabwareDefByDefURI {
+export type LabwareDefinition = LabwareDefinition2 | LabwareDefinition3;
+export interface LabwareDef2ByDefURI {
     [defUri: string]: LabwareDefinition2;
 }
 export interface LegacyLabwareDefByName {
@@ -244,10 +259,11 @@ export interface DeckCalibrationPoint {
     position: CoordinateTuple;
     displayName: string;
 }
+export type CutoutIdToCutoutFixtureId = {
+    [cutoutId in CutoutId]?: CutoutFixtureId;
+};
 export type CutoutFixtureGroup = {
-    [cutoutId in CutoutId]?: Array<{
-        [cutoutId in CutoutId]?: CutoutFixtureId;
-    }>;
+    [cutoutId in CutoutId]?: CutoutIdToCutoutFixtureId[];
 };
 export interface CutoutFixture {
     id: CutoutFixtureId;
@@ -258,7 +274,12 @@ export interface CutoutFixture {
     fixtureGroup: CutoutFixtureGroup;
     height: number;
 }
-type AreaType = 'slot' | 'movableTrash' | 'wasteChute' | 'fixedTrash' | 'stagingSlot' | 'lidDock';
+export interface FakeCutoutFixture extends Omit<CutoutFixture, 'id' | 'providesAddressableAreas'> {
+    id: CutoutFixtureIdsWithFakes;
+    providesAddressableAreas: Record<CutoutId, AddressableAreaNamesWithFakes[] | AddressableAreaName[]>;
+}
+export type CutoutFixtureWithFakes = FakeCutoutFixture | CutoutFixture;
+export type AreaType = 'slot' | 'movableTrash' | 'wasteChute' | 'fixedTrash' | 'stagingSlot' | 'lidDock' | 'thermocycler' | 'heaterShaker' | 'temperatureModule' | 'magneticBlock' | 'absorbanceReader' | 'flexStacker';
 export interface AddressableArea {
     id: AddressableAreaName;
     areaType: AreaType;
@@ -270,6 +291,10 @@ export interface AddressableArea {
     ableToDropTips?: boolean;
     matingSurfaceUnitVector?: UnitVectorTuple;
 }
+export interface FakeAddressableArea extends Omit<AddressableArea, 'id' | 'areaType'> {
+    id: AddressableAreaNamesWithFakes;
+    areaType: AreaTypeWithFakes;
+}
 export interface DeckMetadata {
     displayName: string;
     tags: string[];
@@ -291,6 +316,9 @@ export interface DeckLocations {
     cutouts: DeckCutout[];
     legacyFixtures: LegacyFixture[];
 }
+export interface DeckLocationsWithFakes extends Omit<DeckLocations, 'addressableAreas' | 'calibrationPoints' | 'legacyFixtures'> {
+    addressableAreas: AddressableAreaWithFakes[];
+}
 export interface DeckDefinition {
     otId: string;
     cornerOffsetFromOrigin: CoordinateTuple;
@@ -300,6 +328,10 @@ export interface DeckDefinition {
     metadata: DeckMetadata;
     cutoutFixtures: CutoutFixture[];
 }
+export interface DeckDefinitionWithFakes extends Omit<DeckDefinition, 'locations' | 'cutoutFixtures' | 'otId' | 'cornerOffsetFromOrigin' | 'dimensions' | 'metadata' | 'robot'> {
+    locations: DeckLocationsWithFakes;
+    cutoutFixtures: CutoutFixtureWithFakes[];
+}
 export interface ModuleDimensions {
     bareOverallHeight: number;
     overLabwareHeight: number;
@@ -331,12 +363,17 @@ export interface ModuleDefinition {
     quirks: string[];
     slotTransforms: SlotTransforms;
     compatibleWith: ModuleModel[];
-    twoDimensionalRendering: any;
 }
-export type AffineTransformMatrix = number[][];
+type AffineTransformRow = [number, number, number, number];
+export type AffineTransformMatrix = [
+    AffineTransformRow,
+    AffineTransformRow,
+    AffineTransformRow,
+    AffineTransformRow
+];
 export interface SlotTransforms {
-    [deckOtId: string]: {
-        [slotId: string]: {
+    [deckOtId: string]: undefined | {
+        [slotId: string]: undefined | {
             [transformKey in keyof ModuleDefinition]?: AffineTransformMatrix;
         };
     };
@@ -636,7 +673,7 @@ export interface ByTipTypeSetting {
     singleDispense: SingleDispenseProperties;
     multiDispense?: MultiDispenseProperties;
 }
-interface ByPipetteSetting {
+export interface ByPipetteSetting {
     pipetteModel: string;
     byTipType: ByTipTypeSetting[];
 }
@@ -796,5 +833,10 @@ export interface CutoutConfig {
     opentronsModuleSerialNumber?: string;
 }
 export type DeckConfiguration = CutoutConfig[];
+type CutoutConfigWithoutCutoutFixtureId = Omit<CutoutConfig, 'cutoutFixtureId'>;
+export interface CutoutConfigMap extends CutoutConfigWithoutCutoutFixtureId {
+    addressableAreaId: AddressableAreaNamesWithFakes;
+    cutoutFixtureId: CutoutFixtureIdsWithFakes;
+}
 export type NozzleLayoutConfig = 'single' | 'column' | 'row' | 'full' | 'subrect';
 export {};

package/lib/labware/fixtures/3/index.d.ts

@@ -0,0 +1,3 @@
+import fixture_2_plate from './fixture_2_plate.json';
+import fixture_corning_24_plate from './fixture_corning_24_plate.json';
+export { fixture_2_plate, fixture_corning_24_plate };

package/lib/protocol/types/schemaV8/index.d.ts

@@ -20,6 +20,22 @@ export interface CommandV10Mixin {
     commandSchemaId: 'opentronsCommandSchemaV10';
     commands: CreateCommand[];
 }
+export interface CommandV11Mixin {
+    commandSchemaId: 'opentronsCommandSchemaV11';
+    commands: CreateCommand[];
+}
+export interface CommandV12Mixin {
+    commandSchemaId: 'opentronsCommandSchemaV12';
+    commands: CreateCommand[];
+}
+export interface CommandV13Mixin {
+    commandSchemaId: 'opentronsCommandSchemaV13';
+    commands: CreateCommand[];
+}
+export interface CommandV14Mixin {
+    commandSchemaId: 'opentronsCommandSchemaV14';
+    commands: CreateCommand[];
+}
 export interface CommandAnnotationsStructure {
     commandAnnotationSchemaId: string;
     commandAnnotations: any[];
@@ -92,7 +108,7 @@ export interface ProtocolBase<DesignerApplicationData> {
         data?: DesignerApplicationData;
     };
 }
-export type ProtocolFile<DesignerApplicationData = {}> = ProtocolBase<DesignerApplicationData> & (OT2RobotMixin | OT3RobotMixin) & LabwareV2Mixin & LiquidV1Mixin & (CommandV8Mixin | CommandV9Mixin | CommandV10Mixin) & CommandAnnotationV1Mixin;
+export type ProtocolFile<DesignerApplicationData = {}> = ProtocolBase<DesignerApplicationData> & (OT2RobotMixin | OT3RobotMixin) & LabwareV2Mixin & LiquidV1Mixin & (CommandV8Mixin | CommandV9Mixin | CommandV10Mixin | CommandV11Mixin | CommandV12Mixin | CommandV13Mixin | CommandV14Mixin) & CommandAnnotationV1Mixin;
 export type ProtocolStructure = ProtocolBase<{}> & RobotStructure & LabwareStructure & LiquidStructure & CommandsStructure & CommandAnnotationsStructure;
 /**
  * This type interface is represents the output of the opentrons analyze cli tool