@opentrons/shared-data 0.1.6-alpha.5 → 0.1.6-alpha.8

package/lib/js/types.d.ts

@@ -0,0 +1,678 @@
+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 { AddressableAreaName, CutoutFixtureId, CutoutId } from '../deck';
+import type { PipetteName } from './pipettes';
+export type RobotType = 'OT-2 Standard' | 'OT-3 Standard';
+export interface RobotDefinition {
+    displayName: string;
+    robotType: RobotType;
+    models: string[];
+}
+export interface WellDefinition {
+    diameter?: number;
+    depth?: number;
+    height: number;
+    length: number;
+    width: number;
+    x: number;
+    y: number;
+    z: number;
+    'total-liquid-volume': number;
+    geometryDefinitionId?: string | null;
+}
+export interface LabwareDefinition1 {
+    metadata: {
+        name: string;
+        format: string;
+        deprecated?: boolean;
+        displayName?: string;
+        displayCategory?: string;
+        isValidSource?: boolean;
+        isTiprack?: boolean;
+        tipVolume?: number;
+    };
+    ordering: string[][];
+    wells: {
+        [well: string]: WellDefinition;
+    };
+}
+export type LabwareDisplayCategory = 'wellPlate' | 'tipRack' | 'tubeRack' | 'reservoir' | 'aluminumBlock' | 'trash' | 'other' | 'adapter' | 'lid';
+export type LabwareVolumeUnits = 'µL' | 'mL' | 'L';
+export type WellBottomShape = 'flat' | 'u' | 'v';
+export interface LabwareMetadata {
+    displayName: string;
+    displayCategory: LabwareDisplayCategory;
+    displayVolumeUnits: LabwareVolumeUnits;
+    tags?: string[];
+}
+export interface LabwareDimensions {
+    xDimension: number;
+    yDimension: number;
+    zDimension: number;
+}
+export interface Coordinates {
+    x: number;
+    y: number;
+    z: number;
+}
+export type LabwareOffset = Coordinates;
+export interface LabwareParameters {
+    loadName: string;
+    format: string;
+    isTiprack: boolean;
+    tipLength?: number;
+    isMagneticModuleCompatible: boolean;
+    magneticModuleEngageHeight?: number;
+    quirks?: string[];
+}
+export interface LabwareBrand {
+    brand: string;
+    brandId?: string[];
+    links?: string[];
+}
+export interface CircularWellShape {
+    shape: 'circular';
+    diameter: number;
+}
+export interface RectangularWellShape {
+    shape: 'rectangular';
+    xDimension: number;
+    yDimension: number;
+}
+export type LabwareWellShapeProperties = CircularWellShape | RectangularWellShape;
+export type LabwareWellProperties = LabwareWellShapeProperties & {
+    depth: number;
+    totalLiquidVolume: number;
+};
+export type LabwareWell = LabwareWellProperties & {
+    x: number;
+    y: number;
+    z: number;
+    geometryDefinitionId?: string;
+};
+export interface SphericalSegment {
+    shape: 'spherical';
+    radiusOfCurvature: number;
+    topHeight: number;
+    bottomHeight: number;
+}
+export interface ConicalFrustum {
+    shape: 'conical';
+    bottomDiameter: number;
+    topDiameter: number;
+    topHeight: number;
+    bottomHeight: number;
+}
+export interface CuboidalFrustum {
+    shape: 'cuboidal';
+    bottomXDimension: number;
+    bottomYDimension: number;
+    topXDimension: number;
+    topYDimension: number;
+    topHeight: number;
+    bottomHeight: number;
+}
+export interface SquaredConeSegment {
+    shape: 'squaredcone';
+    bottomCrossSection: string;
+    circleDiameter: number;
+    rectangleXDimension: number;
+    rectangleYDimension: number;
+    topHeight: number;
+    bottomHeight: number;
+}
+export interface RoundedCuboidSegment {
+    shape: 'roundedcuboid';
+    bottomCrossSection: string;
+    circleDiameter: number;
+    rectangleXDimension: number;
+    rectangleYDimension: number;
+    topHeight: number;
+    bottomHeight: number;
+}
+export type WellSegment = CuboidalFrustum | ConicalFrustum | SquaredConeSegment | SphericalSegment | RoundedCuboidSegment;
+export interface InnerWellGeometry {
+    sections: WellSegment[];
+}
+export type LabwareWellMap = Record<string, LabwareWell>;
+export interface LabwareWellGroupMetadata {
+    displayName?: string;
+    displayCategory?: LabwareDisplayCategory;
+    wellBottomShape?: WellBottomShape;
+}
+export interface LabwareWellGroup {
+    wells: string[];
+    metadata: LabwareWellGroupMetadata;
+    brand?: LabwareBrand;
+}
+export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance' | 'lid';
+export interface LabwareDefinition2 {
+    version: number;
+    schemaVersion: 2;
+    namespace: string;
+    metadata: LabwareMetadata;
+    dimensions: LabwareDimensions;
+    cornerOffsetFromSlot: LabwareOffset;
+    parameters: LabwareParameters;
+    brand: LabwareBrand;
+    ordering: string[][];
+    wells: LabwareWellMap;
+    groups: LabwareWellGroup[];
+    allowedRoles?: LabwareRoles[];
+    stackingOffsetWithLabware?: Record<string, LabwareOffset>;
+    stackingOffsetWithModule?: Record<string, LabwareOffset>;
+}
+export interface LabwareDefinition3 {
+    version: number;
+    schemaVersion: 3;
+    namespace: string;
+    metadata: LabwareMetadata;
+    dimensions: LabwareDimensions;
+    cornerOffsetFromSlot: LabwareOffset;
+    parameters: LabwareParameters;
+    brand: LabwareBrand;
+    ordering: string[][];
+    wells: LabwareWellMap;
+    groups: LabwareWellGroup[];
+    allowedRoles?: LabwareRoles[];
+    stackingOffsetWithLabware?: Record<string, LabwareOffset>;
+    stackingOffsetWithModule?: Record<string, LabwareOffset>;
+    innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
+}
+export interface LabwareDefByDefURI {
+    [defUri: string]: LabwareDefinition2;
+}
+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 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 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 {
+    xDimension: number;
+    yDimension: number;
+    zDimension: number;
+}
+export interface DeckRobot {
+    model: RobotType;
+}
+export type CoordinateTuple = [number, number, number];
+export type UnitDirection = 1 | -1;
+export type UnitVectorTuple = [UnitDirection, UnitDirection, UnitDirection];
+export type DeckSlotId = string;
+export interface DeckSlot {
+    id: DeckSlotId;
+    position: CoordinateTuple;
+    matingSurfaceUnitVector?: UnitVectorTuple;
+    boundingBox: Dimensions;
+    displayName: string;
+    compatibleModules: ModuleType[];
+}
+export interface DeckCalibrationPoint {
+    id: string;
+    position: CoordinateTuple;
+    displayName: string;
+}
+export type CutoutFixtureGroup = {
+    [cutoutId in CutoutId]?: Array<{
+        [cutoutId in CutoutId]?: CutoutFixtureId;
+    }>;
+};
+export interface CutoutFixture {
+    id: CutoutFixtureId;
+    mayMountTo: CutoutId[];
+    displayName: string;
+    providesAddressableAreas: Record<CutoutId, AddressableAreaName[]>;
+    expectOpentronsModuleSerialNumber: boolean;
+    fixtureGroup: CutoutFixtureGroup;
+    height: number;
+}
+type AreaType = 'slot' | 'movableTrash' | 'wasteChute' | 'fixedTrash' | 'stagingSlot' | 'lidDock';
+export interface AddressableArea {
+    id: AddressableAreaName;
+    areaType: AreaType;
+    offsetFromCutoutFixture: CoordinateTuple;
+    boundingBox: Dimensions;
+    displayName: string;
+    compatibleModuleTypes: ModuleType[];
+    ableToDropLabware?: boolean;
+    ableToDropTips?: boolean;
+    matingSurfaceUnitVector?: UnitVectorTuple;
+}
+export interface DeckMetadata {
+    displayName: string;
+    tags: string[];
+}
+export interface DeckCutout {
+    id: CutoutId;
+    position: CoordinateTuple;
+    displayName: string;
+}
+export interface LegacyFixture {
+    id: string;
+    slot: string;
+    labware: string;
+    displayName: string;
+}
+export interface DeckLocations {
+    addressableAreas: AddressableArea[];
+    calibrationPoints: DeckCalibrationPoint[];
+    cutouts: DeckCutout[];
+    legacyFixtures: LegacyFixture[];
+}
+export interface DeckDefinition {
+    otId: string;
+    cornerOffsetFromOrigin: CoordinateTuple;
+    dimensions: CoordinateTuple;
+    robot: DeckRobot;
+    locations: DeckLocations;
+    metadata: DeckMetadata;
+    cutoutFixtures: CutoutFixture[];
+}
+export interface ModuleDimensions {
+    bareOverallHeight: number;
+    overLabwareHeight: number;
+    xDimension: number;
+    yDimension: number;
+    footprintXDimension?: number;
+    footprintYDimension?: number;
+    labwareInterfaceXDimension?: number;
+    labwareInterfaceYDimension?: number;
+    lidHeight?: number;
+}
+export interface ModuleCalibrationPoint {
+    x: number;
+    y: number;
+    z?: number;
+}
+export interface ModuleLayer {
+    name: string;
+    pathDValues: string[];
+}
+export interface ModuleDefinition {
+    moduleType: ModuleType;
+    model: ModuleModel;
+    labwareOffset: Coordinates;
+    dimensions: ModuleDimensions;
+    cornerOffsetFromSlot: Coordinates;
+    calibrationPoint: ModuleCalibrationPoint;
+    displayName: string;
+    quirks: string[];
+    slotTransforms: SlotTransforms;
+    compatibleWith: ModuleModel[];
+    twoDimensionalRendering: any;
+}
+export type AffineTransformMatrix = number[][];
+export interface SlotTransforms {
+    [deckOtId: string]: {
+        [slotId: string]: {
+            [transformKey in keyof ModuleDefinition]?: AffineTransformMatrix;
+        };
+    };
+}
+export type ModuleOrientation = 'left' | 'right';
+export type PipetteChannels = 1 | 8 | 96;
+export type PipetteDisplayCategory = typeof GEN1 | typeof GEN2 | typeof FLEX;
+export type PipetteMount = typeof LEFT | typeof RIGHT;
+export type GantryMount = typeof LEFT | typeof RIGHT | typeof EXTENSION;
+export interface FlowRateSpec {
+    value: number;
+    min: number;
+    max: number;
+}
+interface pressAndCamConfigurationValues {
+    speed: number;
+    distance: number;
+    current: number;
+    tipOverlaps: {
+        [version: string]: {
+            [labwareURI: string]: number;
+        };
+    };
+}
+export interface PipetteV2GeneralSpecs {
+    displayName: string;
+    model: string;
+    displayCategory: PipetteDisplayCategory;
+    validNozzleMaps: {
+        maps: {
+            [nozzleMapKey: string]: string[];
+        };
+    };
+    pickUpTipConfigurations: {
+        pressFit: {
+            presses: number;
+            increment: number;
+            configurationsByNozzleMap: {
+                [nozzleMapKey: string]: {
+                    [tipType: string]: pressAndCamConfigurationValues;
+                };
+            };
+        };
+    };
+    dropTipConfigurations: {
+        plungerEject: {
+            current: number;
+            speed: number;
+        };
+    };
+    plungerMotorConfigurations: {
+        idle: number;
+        run: number;
+    };
+    plungerPositionsConfigurations: {
+        default: {
+            top: number;
+            bottom: number;
+            blowout: number;
+            drop: number;
+        };
+    };
+    availableSensors: {
+        sensors: string[];
+        capacitive?: {
+            count: number;
+        };
+        environment?: {
+            count: number;
+        };
+        pressure?: {
+            count: number;
+        };
+    };
+    partialTipConfigurations: {
+        partialTipSupported: boolean;
+        availableConfigurations: number[] | null;
+    };
+    channels: PipetteChannels;
+    shaftDiameter: number;
+    shaftULperMM: number;
+    backCompatNames: string[];
+    backlashDistance: number;
+    quirks: string[];
+    plungerHomingConfigurations: {
+        current: number;
+        speed: number;
+    };
+}
+interface NozzleInfo {
+    key: string;
+    orderedNozzles: string[];
+}
+export interface PipetteV2GeometrySpecs {
+    nozzleOffset: number[];
+    pipetteBoundingBoxOffsets: {
+        backLeftCorner: number[];
+        frontRightCorner: number[];
+    };
+    pathTo3D: string;
+    orderedRows: Record<number, NozzleInfo>;
+    orderedColumns: Record<number, NozzleInfo>;
+    nozzleMap: Record<string, number[]>;
+}
+export interface SupportedTip {
+    aspirate: {
+        default: Record<string, number[][]>;
+    };
+    defaultAspirateFlowRate: {
+        default: number;
+        valuesByApiLevel: Record<string, number>;
+    };
+    defaultBlowOutFlowRate: {
+        default: number;
+        valuesByApiLevel: Record<string, number>;
+    };
+    defaultDispenseFlowRate: {
+        default: number;
+        valuesByApiLevel: Record<string, number>;
+    };
+    defaultPushOutVolume: number;
+    defaultTipLength: number;
+    dispense: {
+        default: Record<string, number[][]>;
+    };
+    defaultReturnTipHeight?: number;
+    defaultFlowAcceleration?: number;
+    uiMaxFlowRate?: number;
+}
+export interface SupportedTips {
+    [tipType: string]: SupportedTip;
+}
+export interface PipetteV2LiquidSpecs {
+    $otSharedSchema: string;
+    supportedTips: SupportedTips;
+    maxVolume: number;
+    minVolume: number;
+    defaultTipracks: string[];
+}
+export type GenericAndGeometrySpecs = PipetteV2GeneralSpecs & PipetteV2GeometrySpecs;
+export interface PipetteV2Specs extends GenericAndGeometrySpecs {
+    $otSharedSchema: string;
+    liquids: Record<string, PipetteV2LiquidSpecs>;
+}
+export interface PipetteNameSpecs {
+    name: string;
+    displayName: string;
+    displayCategory: PipetteDisplayCategory;
+    minVolume: number;
+    maxVolume: number;
+    channels: PipetteChannels;
+    defaultAspirateFlowRate: FlowRateSpec;
+    defaultDispenseFlowRate: FlowRateSpec;
+    defaultBlowOutFlowRate: FlowRateSpec;
+    defaultTipracks: string[];
+    smoothieConfigs?: {
+        stepsPerMM: number;
+        homePosition: number;
+        travelDistance: number;
+    };
+}
+export interface PipetteModelSpecs extends PipetteNameSpecs {
+    model: string;
+    backCompatNames?: string[];
+    tipLength: {
+        value: number;
+    };
+}
+export interface ProtocolMetadata {
+    protocolName?: string;
+    author?: string;
+    description?: string | null;
+    created?: number;
+    lastModified?: number | null;
+    category?: string | null;
+    subcategory?: string | null;
+    tags?: string[];
+    [key: string]: unknown;
+}
+export interface PendingProtocolAnalysis {
+    id: string;
+    status?: 'pending';
+}
+export interface ProtocolAnalysisSummary {
+    id: string;
+    status: 'pending' | 'completed';
+}
+export interface LoadedPipette {
+    id: string;
+    pipetteName: PipetteName;
+    mount: 'left' | 'right';
+}
+export interface LoadedLabware {
+    id: string;
+    loadName: string;
+    definitionUri: string;
+    location: LabwareLocation;
+    offsetId?: string;
+    displayName?: string;
+}
+export interface LoadedModule {
+    id: string;
+    model: ModuleModel;
+    location: {
+        slotName: string;
+    };
+    serialNumber: string;
+}
+export interface Liquid {
+    id: string;
+    displayName: string;
+    description: string;
+    displayColor?: string;
+}
+export interface AnalysisError {
+    id: string;
+    detail: string;
+    errorType: string;
+    createdAt: string;
+}
+export interface NumberParameter extends BaseRunTimeParameter {
+    type: NumberParameterType;
+    min: number;
+    max: number;
+    default: number;
+    value: number;
+}
+export interface NumberChoice {
+    displayName: string;
+    value: number;
+}
+export interface BooleanChoice {
+    displayName: string;
+    value: boolean;
+}
+export interface StringChoice {
+    displayName: string;
+    value: string;
+}
+export type Choice = NumberChoice | BooleanChoice | StringChoice;
+interface NumberChoiceParameter extends BaseRunTimeParameter {
+    type: NumberParameterType;
+    choices: NumberChoice[];
+    default: number;
+    value: number;
+}
+interface BooleanChoiceParameter extends BaseRunTimeParameter {
+    type: BooleanParameterType;
+    choices: BooleanChoice[];
+    default: boolean;
+    value: boolean;
+}
+interface StringChoiceParameter extends BaseRunTimeParameter {
+    type: StringParameterType;
+    choices: StringChoice[];
+    default: string;
+    value: string;
+}
+export type ChoiceParameter = NumberChoiceParameter | BooleanChoiceParameter | StringChoiceParameter;
+interface BooleanParameter extends BaseRunTimeParameter {
+    type: BooleanParameterType;
+    default: boolean;
+    value: boolean;
+}
+export interface CsvFileParameterFileData {
+    id?: string;
+    file?: File | null;
+    filePath?: string;
+    fileName?: string;
+    name?: string;
+}
+export interface CsvFileParameter extends BaseRunTimeParameter {
+    type: CsvFileParameterType;
+    file?: CsvFileParameterFileData | null;
+}
+type NumberParameterType = 'int' | 'float';
+type BooleanParameterType = 'bool';
+type StringParameterType = 'str';
+type CsvFileParameterType = 'csv_file';
+interface BaseRunTimeParameter {
+    displayName: string;
+    variableName: string;
+    description: string;
+    suffix?: string;
+}
+export type ValueRunTimeParameter = Exclude<RunTimeParameter, CsvFileParameter>;
+export type RunTimeParameter = BooleanParameter | ChoiceParameter | NumberParameter | CsvFileParameter;
+export interface CompletedProtocolAnalysis {
+    id: string;
+    status?: 'completed';
+    result: 'ok' | 'not-ok' | 'error' | 'parameter-value-required';
+    pipettes: LoadedPipette[];
+    labware: LoadedLabware[];
+    modules: LoadedModule[];
+    liquids: Liquid[];
+    commands: RunTimeCommand[];
+    errors: AnalysisError[];
+    robotType?: RobotType | null;
+    runTimeParameters?: RunTimeParameter[];
+}
+export interface ResourceFile {
+    name: string;
+    role: string;
+}
+export interface ProtocolResource {
+    id: string;
+    createdAt: string;
+    protocolType: 'json' | 'python';
+    protocolKind: 'standard' | 'quick-transfer';
+    robotType: RobotType;
+    metadata: ProtocolMetadata;
+    analysisSummaries: ProtocolAnalysisSummary[];
+    files: ResourceFile[];
+    key?: string;
+}
+export interface ProtocolAnalysesResource {
+    analyses: Array<PendingProtocolAnalysis | CompletedProtocolAnalysis>;
+}
+export type MotorAxis = 'x' | 'y' | 'leftZ' | 'rightZ' | 'leftPlunger' | 'rightPlunger' | 'extensionZ' | 'extensionJaw';
+export type MotorAxes = MotorAxis[];
+export type ThermalAdapterName = 'PCR Adapter' | 'Deep Well Adapter' | '96 Flat Bottom Adapter' | 'Universal Flat Adapter';
+export interface GripperDefinition {
+    $otSharedSchema: string;
+    model: GripperModel;
+    schemaVersion: number;
+    displayName: string;
+    zMotorConfigurations: {
+        idle: number;
+        run: number;
+    };
+    jawMotorConfigurations: {
+        vref: number;
+    };
+    gripForceProfile: {
+        polynomial: [[number, number], [number, number]];
+        defaultGripForce: number;
+        defaultHomeForce: number;
+        defaultIdleForce: number;
+        min: number;
+        max: number;
+    };
+    geometry: {
+        baseOffsetFromMount: [number, number, number];
+        jawCenterOffsetFromBase: [number, number, number];
+        pinOneOffsetFromBase: [number, number, number];
+        pinTwoOffsetFromBase: [number, number, number];
+        jawWidth: {
+            min: number;
+            max: number;
+        };
+        maxAllowedGripError: number;
+    };
+}
+export type StatusBarAnimation = 'idle' | 'confirm' | 'updating' | 'disco' | 'off';
+export type StatusBarAnimations = StatusBarAnimation[];
+export interface CutoutConfig {
+    cutoutId: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    opentronsModuleSerialNumber?: string;
+}
+export type DeckConfiguration = CutoutConfig[];
+export type NozzleLayoutConfig = 'single' | 'column' | 'row' | 'full' | 'subrect';
+export {};