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

package/lib/protocol/fixtures/index.d.ts

@@ -0,0 +1,13 @@
+import heater_shaker_commands from './6/heaterShakerCommands.json';
+import heater_shaker_commands_with_results_key from './6/heaterShakerCommandsWithResultsKey.json';
+import multiple_temp_modules from './6/multipleTempModules.json';
+import multiple_tipracks from './6/multipleTipracks.json';
+import multiple_tipacks_with_tc from './6/multipleTipracksWithTC.json';
+import one_tiprack from './6/oneTiprack.json';
+import simple_v6 from './6/simpleV6.json';
+import temp_and_mag_module_commands from './6/tempAndMagModuleCommands.json';
+import transfer_settings from './6/transferSettings.json';
+import simple_v4 from './4/simpleV4.json';
+import test_modules_protocol from './4/testModulesProtocol.json';
+export { heater_shaker_commands, heater_shaker_commands_with_results_key, multiple_temp_modules, multiple_tipracks, multiple_tipacks_with_tc, one_tiprack, simple_v6, temp_and_mag_module_commands, transfer_settings, };
+export { simple_v4, test_modules_protocol };

package/lib/protocol/index.d.ts

@@ -5,6 +5,15 @@ import type { ProtocolFile as ProtocolFileV5 } from './types/schemaV5';
 import type { ProtocolFile as ProtocolFileV6 } from './types/schemaV6';
 import type { ProtocolFile as ProtocolFileV7 } from './types/schemaV7';
 import type { ProtocolFile as ProtocolFileV8, ProtocolStructure as ProtocolStructureV8 } from './types/schemaV8';
+import protocolSchemaV1 from './schemas/1.json';
+import protocolSchemaV2 from './schemas/2.json';
+import protocolSchemaV3 from './schemas/3.json';
+import protocolSchemaV4 from './schemas/4.json';
+import protocolSchemaV5 from './schemas/5.json';
+import protocolSchemaV6 from './schemas/6.json';
+import protocolSchemaV7 from './schemas/7.json';
+import protocolSchemaV8 from './schemas/8.json';
 export type { ProtocolFileV1, ProtocolFileV3, ProtocolFileV4, ProtocolFileV5, ProtocolFileV6, ProtocolFileV7, ProtocolFileV8, ProtocolStructureV8, };
 export type JsonProtocolFile = Readonly<ProtocolFileV1<{}>> | Readonly<ProtocolFileV3<{}>> | Readonly<ProtocolFileV4<{}>> | Readonly<ProtocolFileV5<{}>> | Readonly<ProtocolFileV6<{}>> | Readonly<ProtocolFileV7<{}>> | Readonly<ProtocolFileV8<{}>>;
 export * from './types/schemaV8';
+export { protocolSchemaV1, protocolSchemaV2, protocolSchemaV3, protocolSchemaV4, protocolSchemaV5, protocolSchemaV6, protocolSchemaV7, protocolSchemaV8, };

package/lib/protocol/types/schemaV3.d.ts

@@ -1,4 +1,4 @@
-import { PipetteName } from '../../js';
+import type { PipetteName } from '../../js';
 import type { DeckSlotId, LabwareDefinition2, PipetteMount as Mount } from '../../js/types';
 export interface FilePipette {
     mount: Mount;

package/lib/protocol/types/schemaV6/command/index.d.ts

@@ -3,6 +3,7 @@ import type { GantryRunTimeCommand, GantryCreateCommand } from './gantry';
 import type { ModuleRunTimeCommand, ModuleCreateCommand } from './module';
 import type { SetupRunTimeCommand, SetupCreateCommand } from './setup';
 import type { TimingRunTimeCommand, TimingCreateCommand } from './timing';
+import type { CommandIntent } from '../../../../command';
 export * from './pipetting';
 export * from './gantry';
 export * from './module';
@@ -17,7 +18,7 @@ export interface CommonCommandRunTimeInfo {
     createdAt: string;
     startedAt: string | null;
     completedAt: string | null;
-    intent?: 'protocol' | 'setup';
+    intent?: CommandIntent;
 }
 export interface CommonCommandCreateInfo {
     key?: string;

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

@@ -1,4 +1,4 @@
-import { LoadedPipette, LoadedLabware, LoadedModule, Liquid, PipetteName } from '../../../js';
+import type { LoadedPipette, LoadedLabware, LoadedModule, Liquid, PipetteName } from '../../../js';
 import type { CreateCommand, RunTimeCommand } from './command';
 import type { LabwareDefinition2, ModuleModel, RobotType } from '../../../js/types';
 export * from './command';

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

@@ -1,4 +1,4 @@
-import { LoadedPipette, LoadedLabware, LoadedModule, Liquid } from '../../../js';
+import type { LoadedPipette, LoadedLabware, LoadedModule, Liquid } from '../../../js';
 import type { CreateCommand, RunTimeCommand } from './command';
 import type { LabwareDefinition2, RobotType } from '../../../js/types';
 export * from './command';

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

@@ -1,5 +1,5 @@
 import type { CreateCommand } from '../../../command/types';
-import type { LoadedPipette, LoadedLabware, LoadedModule, Liquid } from '../../../js';
+import type { LoadedPipette, LoadedLabware, LoadedModule, Liquid, RunTimeParameter } from '../../../js';
 import type { CommandAnnotation } from '../../../commandAnnotation/types';
 import type { LabwareDefinition2, RobotType } from '../../../js/types';
 import type { RunTimeCommand } from '../schemaV8';
@@ -12,6 +12,10 @@ export interface CommandV8Mixin {
     commandSchemaId: 'opentronsCommandSchemaV8';
     commands: CreateCommand[];
 }
+export interface CommandV9Mixin {
+    commandSchemaId: 'opentronsCommandSchemaV9';
+    commands: CreateCommand[];
+}
 export interface CommandAnnotationsStructure {
     commandAnnotationSchemaId: string;
     commandAnnotations: any[];
@@ -83,7 +87,7 @@ export interface ProtocolBase<DesignerApplicationData> {
         data?: DesignerApplicationData;
     };
 }
-export type ProtocolFile<DesignerApplicationData = {}> = ProtocolBase<DesignerApplicationData> & (OT2RobotMixin | OT3RobotMixin) & LabwareV2Mixin & LiquidV1Mixin & CommandV8Mixin & CommandAnnotationV1Mixin;
+export type ProtocolFile<DesignerApplicationData = {}> = ProtocolBase<DesignerApplicationData> & (OT2RobotMixin | OT3RobotMixin) & LabwareV2Mixin & LiquidV1Mixin & (CommandV8Mixin | CommandV9Mixin) & CommandAnnotationV1Mixin;
 export type ProtocolStructure = ProtocolBase<{}> & RobotStructure & LabwareStructure & LiquidStructure & CommandsStructure & CommandAnnotationsStructure;
 /**
  * This type interface is represents the output of the opentrons analyze cli tool
@@ -104,7 +108,9 @@ export interface ProtocolAnalysisOutput {
     modules: LoadedModule[];
     liquids: Liquid[];
     errors: AnalysisError[];
+    runTimeParameters: RunTimeParameter[];
     robotType?: RobotType;
+    result: 'ok' | 'not-ok' | 'error' | 'parameter-value-required';
 }
 interface AnalysisSourceFile {
     name: string;

package/lib/vite.config.d.mts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/liquid-class/fixtures/fixture_glycerol50.json

@@ -0,0 +1,240 @@
+{
+  "liquidClassName": "fixture_glycerol50",
+  "displayName": "Glycerol 50%",
+  "schemaVersion": 1,
+  "namespace": "opentrons",
+  "byPipette": [
+    {
+      "pipetteModel": "p20_single_gen2",
+      "byTipType": [
+        {
+          "tiprack": "opentrons_96_tiprack_20ul",
+          "aspirate": {
+            "submerge": {
+              "positionReference": "liquid-meniscus",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": -5
+              },
+              "speed": 100,
+              "delay": {
+                "enable": true,
+                "params": {
+                  "duration": 1.5
+                }
+              }
+            },
+            "retract": {
+              "positionReference": "well-top",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": 5
+              },
+              "speed": 100,
+              "airGapByVolume": {
+                "default": 2,
+                "5": 3,
+                "10": 4
+              },
+              "touchTip": {
+                "enable": true,
+                "params": {
+                  "zOffset": 2,
+                  "mmToEdge": 1,
+                  "speed": 50
+                }
+              },
+              "delay": {
+                "enable": true,
+                "params": {
+                  "duration": 1
+                }
+              }
+            },
+            "positionReference": "well-bottom",
+            "offset": {
+              "x": 0,
+              "y": 0,
+              "z": -5
+            },
+            "flowRateByVolume": {
+              "default": 50,
+              "10": 40,
+              "20": 30
+            },
+            "preWet": true,
+            "mix": {
+              "enable": true,
+              "params": {
+                "repetitions": 3,
+                "volume": 15
+              }
+            },
+            "delay": {
+              "enable": true,
+              "params": {
+                "duration": 2
+              }
+            }
+          },
+          "singleDispense": {
+            "submerge": {
+              "positionReference": "liquid-meniscus",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": -5
+              },
+              "speed": 100,
+              "delay": {
+                "enable": true,
+                "params": {
+                  "duration": 1.5
+                }
+              }
+            },
+            "retract": {
+              "positionReference": "well-top",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": 5
+              },
+              "speed": 100,
+              "airGapByVolume": {
+                "default": 2,
+                "5": 3,
+                "10": 4
+              },
+              "blowout": {
+                "enable": true,
+                "params": {
+                  "location": "trash",
+                  "flowRate": 100
+                }
+              },
+              "touchTip": {
+                "enable": true,
+                "params": {
+                  "zOffset": 2,
+                  "mmToEdge": 1,
+                  "speed": 50
+                }
+              },
+              "delay": {
+                "enable": true,
+                "params": {
+                  "duration": 1
+                }
+              }
+            },
+            "positionReference": "well-bottom",
+            "offset": {
+              "x": 0,
+              "y": 0,
+              "z": -5
+            },
+            "flowRateByVolume": {
+              "default": 50,
+              "10": 40,
+              "20": 30
+            },
+            "mix": {
+              "enable": true,
+              "params": {
+                "repetitions": 3,
+                "volume": 15
+              }
+            },
+            "pushOutByVolume": {
+              "default": 5,
+              "10": 7,
+              "20": 10
+            },
+            "delay": {
+              "enable": true,
+              "params": {
+                "duration": 2.5
+              }
+            }
+          },
+          "multiDispense": {
+            "submerge": {
+              "positionReference": "liquid-meniscus",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": -5
+              },
+              "speed": 100,
+              "delay": {
+                "enable": true,
+                "params": {
+                  "duration": 1.5
+                }
+              }
+            },
+            "retract": {
+              "positionReference": "well-top",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": 5
+              },
+              "speed": 100,
+              "airGapByVolume": {
+                "default": 2,
+                "5": 3,
+                "10": 4
+              },
+              "touchTip": {
+                "enable": true,
+                "params": {
+                  "zOffset": 2,
+                  "mmToEdge": 1,
+                  "speed": 50
+                }
+              },
+              "delay": {
+                "enable": true,
+                "params": {
+                  "duration": 1
+                }
+              },
+              "blowout": {
+                "enable": false
+              }
+            },
+            "positionReference": "well-bottom",
+            "offset": {
+              "x": 0,
+              "y": 0,
+              "z": -5
+            },
+            "flowRateByVolume": {
+              "default": 50,
+              "10": 40,
+              "20": 30
+            },
+            "conditioningByVolume": {
+              "default": 10,
+              "5": 5
+            },
+            "disposalByVolume": {
+              "default": 2,
+              "5": 3
+            },
+            "delay": {
+              "enable": true,
+              "params": {
+                "duration": 1
+              }
+            }
+          }
+        }
+      ]
+    }
+  ]
+}