@opentrons/shared-data 0.3.23-alpha.0 → 0.3.25-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +1 -1
  2. package/lib/command/types/pipetting.d.ts +2 -0
  3. package/lib/js/opentronsAI/types.d.ts +49 -64
  4. package/lib/tsconfig-data.tsbuildinfo +1 -1
  5. package/lib/tsconfig.tsbuildinfo +1 -1
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Version
10
10
 
11
- `0.3.23-alpha.0`
11
+ `0.3.25-alpha.0`
12
12
 
13
13
  ## License
14
14
 
package/lib/command/types/pipetting.d.ts CHANGED
@@ -215,6 +215,7 @@ interface AddressableOffsetVector {
215
215
  }
216
216
  export interface DropTipInPlaceParams {
217
217
  pipetteId: string;
218
+ homeAfter?: boolean;
218
219
  }
219
220
  export interface MoveToAddressableAreaForDropTipParams {
220
221
  pipetteId: string;
@@ -224,6 +225,7 @@ export interface MoveToAddressableAreaForDropTipParams {
224
225
  speed?: number;
225
226
  minimumZHeight?: number;
226
227
  forceDirect?: boolean;
228
+ ignoreTipConfiguration?: boolean;
227
229
  }
228
230
  export interface BlowoutInPlaceParams {
229
231
  pipetteId: string;
package/lib/js/opentronsAI/types.d.ts CHANGED
@@ -18,68 +18,53 @@ export interface CommonArgs {
18
18
  type OpentronsAIBaseArgs<T extends LatestCommandSchemaCommandType> = CommonArgs & {
19
19
  commandCreatorFnName: T;
20
20
  } & ParamsForOpentronsAICommand<T>;
21
- export interface AirGapInPlaceArgs extends OpentronsAIBaseArgs<'airGapInPlace'> {
22
- }
21
+ /**
22
+ * Runtime parameters are passed as their names. Any arg that is not already a
23
+ * string can also be that name. `commandCreatorFnName` and CommonArgs stay put.
24
+ */
25
+ type RuntimeParameterValue<T> = T extends any ? string extends T ? T : T extends null | undefined ? T : T extends readonly [unknown, ...unknown[]] ? {
26
+ [K in keyof T]: RuntimeParameterValue<T[K]>;
27
+ } : T extends ReadonlyArray<infer U> ? Array<RuntimeParameterValue<U>> : T extends object ? {
28
+ [K in keyof T]: RuntimeParameterValue<T[K]>;
29
+ } : T | string : never;
30
+ export type WithRuntimeParameterStrings<T> = {
31
+ [K in keyof T]: K extends 'commandCreatorFnName' | 'stepNumber' | 'name' | 'description' ? T[K] : RuntimeParameterValue<T[K]>;
32
+ };
33
+ type RuntimeParameterArgs<T extends LatestCommandSchemaCommandType> = WithRuntimeParameterStrings<OpentronsAIBaseArgs<T>>;
34
+ export type AirGapInPlaceArgs = RuntimeParameterArgs<'airGapInPlace'>;
23
35
  export interface AspirateArgs extends OpentronsAIBaseArgs<'aspirate'> {
24
36
  }
25
- export interface AspirateInPlaceArgs extends OpentronsAIBaseArgs<'aspirateInPlace'> {
26
- }
27
- export interface AspirateWhileTrackingArgs extends OpentronsAIBaseArgs<'aspirateWhileTracking'> {
28
- }
29
- export interface BlowOutInPlaceArgs extends OpentronsAIBaseArgs<'blowOutInPlace'> {
30
- }
37
+ export type AspirateInPlaceArgs = RuntimeParameterArgs<'aspirateInPlace'>;
38
+ export type AspirateWhileTrackingArgs = RuntimeParameterArgs<'aspirateWhileTracking'>;
39
+ export type BlowOutInPlaceArgs = RuntimeParameterArgs<'blowOutInPlace'>;
31
40
  export interface BlowoutArgs extends OpentronsAIBaseArgs<'blowout'> {
32
41
  }
33
- export interface ConfigureForVolumeArgs extends OpentronsAIBaseArgs<'configureForVolume'> {
34
- }
35
- export interface ConfigureNozzleLayoutArgs extends OpentronsAIBaseArgs<'configureNozzleLayout'> {
36
- }
37
- export interface DispenseInPlaceArgs extends OpentronsAIBaseArgs<'dispenseInPlace'> {
38
- }
39
- export interface DispenseWhileTrackingArgs extends OpentronsAIBaseArgs<'dispenseWhileTracking'> {
40
- }
41
- export interface DropTipInPlaceArgs extends OpentronsAIBaseArgs<'dropTipInPlace'> {
42
- }
43
- export interface HomeArgs extends OpentronsAIBaseArgs<'home'> {
44
- }
45
- export interface MoveRelativeArgs extends OpentronsAIBaseArgs<'moveRelative'> {
46
- }
47
- export interface MoveToAddressableAreaForDropTipArgs extends OpentronsAIBaseArgs<'moveToAddressableAreaForDropTip'> {
48
- }
49
- export interface MoveToCoordinatesArgs extends OpentronsAIBaseArgs<'moveToCoordinates'> {
50
- }
51
- export interface MoveToWellArgs extends OpentronsAIBaseArgs<'moveToWell'> {
52
- }
53
- export interface PrepareToAspirateArgs extends OpentronsAIBaseArgs<'prepareToAspirate'> {
54
- }
55
- export interface TryLiquidProbeArgs extends OpentronsAIBaseArgs<'tryLiquidProbe'> {
56
- }
42
+ export type ConfigureForVolumeArgs = RuntimeParameterArgs<'configureForVolume'>;
43
+ export type ConfigureNozzleLayoutArgs = RuntimeParameterArgs<'configureNozzleLayout'>;
44
+ export type DispenseInPlaceArgs = RuntimeParameterArgs<'dispenseInPlace'>;
45
+ export type DispenseWhileTrackingArgs = RuntimeParameterArgs<'dispenseWhileTracking'>;
46
+ export type DropTipInPlaceArgs = RuntimeParameterArgs<'dropTipInPlace'>;
47
+ export type HomeArgs = RuntimeParameterArgs<'home'>;
48
+ export type MoveRelativeArgs = RuntimeParameterArgs<'moveRelative'>;
49
+ export type MoveToAddressableAreaForDropTipArgs = RuntimeParameterArgs<'moveToAddressableAreaForDropTip'>;
50
+ export type MoveToCoordinatesArgs = RuntimeParameterArgs<'moveToCoordinates'>;
51
+ export type MoveToWellArgs = RuntimeParameterArgs<'moveToWell'>;
52
+ export type PrepareToAspirateArgs = RuntimeParameterArgs<'prepareToAspirate'>;
53
+ export type TryLiquidProbeArgs = RuntimeParameterArgs<'tryLiquidProbe'>;
57
54
  export interface VerifyTipPresenceArgs extends OpentronsAIBaseArgs<'verifyTipPresence'> {
58
55
  }
59
- export interface HeaterShakerCloseLabwareLatchArgs extends OpentronsAIBaseArgs<'heaterShaker/closeLabwareLatch'> {
60
- }
61
- export interface HeaterShakerSetAndWaitForShakeSpeedArgs extends OpentronsAIBaseArgs<'heaterShaker/setAndWaitForShakeSpeed'> {
62
- }
63
- export interface HeaterShakerDeactiveHeaterArgs extends OpentronsAIBaseArgs<'heaterShaker/deactivateHeater'> {
64
- }
65
- export interface HeaterShakerOpenLabwareLatchArgs extends OpentronsAIBaseArgs<'heaterShaker/openLabwareLatch'> {
66
- }
67
- export interface HeaterShakerDeactivateShakerArgs extends OpentronsAIBaseArgs<'heaterShaker/deactivateShaker'> {
68
- }
69
- export interface TCSetTargetBlockTemperatureArgs extends OpentronsAIBaseArgs<'thermocycler/setTargetBlockTemperature'> {
70
- }
71
- export interface TCSetTargetLidTemperatureArgs extends OpentronsAIBaseArgs<'thermocycler/setTargetLidTemperature'> {
72
- }
73
- export interface TCOpenLidArgs extends OpentronsAIBaseArgs<'thermocycler/openLid'> {
74
- }
75
- export interface TCCloseLidArgs extends OpentronsAIBaseArgs<'thermocycler/closeLid'> {
76
- }
77
- export interface TCDeactivateBlockArgs extends OpentronsAIBaseArgs<'thermocycler/deactivateBlock'> {
78
- }
79
- export interface TCDeactivateLidArgs extends OpentronsAIBaseArgs<'thermocycler/deactivateLid'> {
80
- }
81
- export interface TCStartRunExtendedProfileArgs extends OpentronsAIBaseArgs<'thermocycler/startRunExtendedProfile'> {
82
- }
56
+ export type HeaterShakerCloseLabwareLatchArgs = RuntimeParameterArgs<'heaterShaker/closeLabwareLatch'>;
57
+ export type HeaterShakerSetAndWaitForShakeSpeedArgs = RuntimeParameterArgs<'heaterShaker/setAndWaitForShakeSpeed'>;
58
+ export type HeaterShakerDeactiveHeaterArgs = RuntimeParameterArgs<'heaterShaker/deactivateHeater'>;
59
+ export type HeaterShakerOpenLabwareLatchArgs = RuntimeParameterArgs<'heaterShaker/openLabwareLatch'>;
60
+ export type HeaterShakerDeactivateShakerArgs = RuntimeParameterArgs<'heaterShaker/deactivateShaker'>;
61
+ export type TCSetTargetBlockTemperatureArgs = RuntimeParameterArgs<'thermocycler/setTargetBlockTemperature'>;
62
+ export type TCSetTargetLidTemperatureArgs = RuntimeParameterArgs<'thermocycler/setTargetLidTemperature'>;
63
+ export type TCOpenLidArgs = RuntimeParameterArgs<'thermocycler/openLid'>;
64
+ export type TCCloseLidArgs = RuntimeParameterArgs<'thermocycler/closeLid'>;
65
+ export type TCDeactivateBlockArgs = RuntimeParameterArgs<'thermocycler/deactivateBlock'>;
66
+ export type TCDeactivateLidArgs = RuntimeParameterArgs<'thermocycler/deactivateLid'>;
67
+ export type TCStartRunExtendedProfileArgs = RuntimeParameterArgs<'thermocycler/startRunExtendedProfile'>;
83
68
  export interface DispenseArgs extends CommonArgs {
84
69
  commandCreatorFnName: 'dispense';
85
70
  pipetteId: string;
@@ -94,20 +79,20 @@ export interface DispenseArgs extends CommonArgs {
94
79
  wellLocation?: WellLocation;
95
80
  isAirGap?: boolean;
96
81
  }
97
- export interface DropTipArgs extends CommonArgs {
82
+ export type DropTipArgs = WithRuntimeParameterStrings<CommonArgs & {
98
83
  commandCreatorFnName: 'dropTip';
99
84
  pipette: string;
100
85
  dropTipLocation?: string;
101
86
  wellName?: string;
102
87
  isReturnTip?: boolean;
103
- }
104
- export interface MoveToAddressableAreaArgs extends CommonArgs {
88
+ }>;
89
+ export type MoveToAddressableAreaArgs = WithRuntimeParameterStrings<CommonArgs & {
105
90
  commandCreatorFnName: 'moveToAddressableArea';
106
91
  pipetteId: string;
107
92
  fixtureId: string;
108
93
  offset: AddressableOffsetVector;
109
- }
110
- export interface PickUpTipArgs extends CommonArgs {
94
+ }>;
95
+ export type PickUpTipArgs = WithRuntimeParameterStrings<CommonArgs & {
111
96
  commandCreatorFnName: 'pickUpTip';
112
97
  pipetteId: string;
113
98
  labwareId: string;
@@ -115,8 +100,8 @@ export interface PickUpTipArgs extends CommonArgs {
115
100
  primaryNozzle: PrimaryNozzleConfigurationStyle;
116
101
  nozzles: NozzleConfigurationStyle;
117
102
  tipTrackingOption?: 'automatic' | 'manual';
118
- }
119
- export interface TouchTipArgs extends CommonArgs {
103
+ }>;
104
+ export type TouchTipArgs = WithRuntimeParameterStrings<CommonArgs & {
120
105
  commandCreatorFnName: 'touchTip';
121
106
  pipetteId: string;
122
107
  labwareId: string;
@@ -124,6 +109,6 @@ export interface TouchTipArgs extends CommonArgs {
124
109
  zOffsetFromTop: number;
125
110
  speed?: number;
126
111
  mmFromEdge?: number;
127
- }
112
+ }>;
128
113
  export type OpentronsAIArgs = AirGapInPlaceArgs | AspirateArgs | AspirateInPlaceArgs | AspirateWhileTrackingArgs | BlowOutInPlaceArgs | BlowoutArgs | ConfigureForVolumeArgs | ConfigureNozzleLayoutArgs | DispenseArgs | DispenseInPlaceArgs | DispenseWhileTrackingArgs | DropTipArgs | DropTipInPlaceArgs | HomeArgs | MoveRelativeArgs | MoveToAddressableAreaArgs | MoveToAddressableAreaForDropTipArgs | MoveToCoordinatesArgs | MoveToWellArgs | PickUpTipArgs | PrepareToAspirateArgs | TouchTipArgs | TryLiquidProbeArgs | HeaterShakerCloseLabwareLatchArgs | HeaterShakerSetAndWaitForShakeSpeedArgs | HeaterShakerOpenLabwareLatchArgs | HeaterShakerDeactiveHeaterArgs | HeaterShakerDeactivateShakerArgs | TCSetTargetBlockTemperatureArgs | TCSetTargetLidTemperatureArgs | TCCloseLidArgs | TCDeactivateBlockArgs | TCDeactivateLidArgs | TCOpenLidArgs | TCStartRunExtendedProfileArgs;
129
114
  export {};