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

package/protocol/fixtures/index.ts

@@ -0,0 +1,26 @@
+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/protocol/index.ts

@@ -8,6 +8,14 @@ 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,
@@ -30,3 +38,14 @@ export type JsonProtocolFile =
   | Readonly<ProtocolFileV8<{}>>
 
 export * from './types/schemaV8'
+
+export {
+  protocolSchemaV1,
+  protocolSchemaV2,
+  protocolSchemaV3,
+  protocolSchemaV4,
+  protocolSchemaV5,
+  protocolSchemaV6,
+  protocolSchemaV7,
+  protocolSchemaV8,
+}

package/protocol/types/schemaV3.ts

@@ -1,4 +1,4 @@
-import { PipetteName } from '../../js'
+import type { PipetteName } from '../../js'
 import type {
   DeckSlotId,
   LabwareDefinition2,

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

@@ -6,6 +6,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'
@@ -26,7 +27,7 @@ export interface CommonCommandRunTimeInfo {
   createdAt: string
   startedAt: string | null
   completedAt: string | null
-  intent?: 'protocol' | 'setup'
+  intent?: CommandIntent
 }
 export interface CommonCommandCreateInfo {
   key?: string

package/protocol/types/schemaV6/index.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   LoadedPipette,
   LoadedLabware,
   LoadedModule,

package/protocol/types/schemaV7/index.ts

@@ -1,4 +1,9 @@
-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'
 

package/protocol/types/schemaV8/index.ts

@@ -4,6 +4,7 @@ import type {
   LoadedLabware,
   LoadedModule,
   Liquid,
+  RunTimeParameter,
 } from '../../../js'
 import type { CommandAnnotation } from '../../../commandAnnotation/types'
 import type { LabwareDefinition2, RobotType } from '../../../js/types'
@@ -21,6 +22,11 @@ export interface CommandV8Mixin {
   commands: CreateCommand[]
 }
 
+export interface CommandV9Mixin {
+  commandSchemaId: 'opentronsCommandSchemaV9'
+  commands: CreateCommand[]
+}
+
 export interface CommandAnnotationsStructure {
   commandAnnotationSchemaId: string
   commandAnnotations: any[]
@@ -109,7 +115,7 @@ export type ProtocolFile<
   (OT2RobotMixin | OT3RobotMixin) &
   LabwareV2Mixin &
   LiquidV1Mixin &
-  CommandV8Mixin &
+  (CommandV8Mixin | CommandV9Mixin) &
   CommandAnnotationV1Mixin
 
 export type ProtocolStructure = ProtocolBase<{}> &
@@ -136,7 +142,9 @@ export interface ProtocolAnalysisOutput {
   modules: LoadedModule[]
   liquids: Liquid[]
   errors: AnalysisError[]
+  runTimeParameters: RunTimeParameter[]
   robotType?: RobotType
+  result: 'ok' | 'not-ok' | 'error' | 'parameter-value-required'
 }
 
 interface AnalysisSourceFile {

package/robot/definitions/1/ot2.json

@@ -1,5 +1,16 @@
 {
   "displayName": "OT-2",
   "robotType": "OT-2 Standard",
-  "models": ["OT-2 Standard", "OT-2 Refresh"]
+  "models": ["OT-2 Standard", "OT-2 Refresh"],
+  "extents": [446.75, 347.5, 0.0],
+  "paddingOffsets": {
+    "rear": -35.91,
+    "front": 31.89,
+    "leftSide": 0,
+    "rightSide": 0
+  },
+  "mountOffsets": {
+    "left": [-34.0, 0.0, 0.0],
+    "right": [0.0, 0.0, 0.0]
+  }
 }

package/robot/definitions/1/ot3.json

@@ -1,5 +1,17 @@
 {
   "displayName": "OT-3",
   "robotType": "OT-3 Standard",
-  "models": ["OT-3 Standard"]
+  "models": ["OT-3 Standard"],
+  "extents": [477.2, 493.8, 0.0],
+  "paddingOffsets": {
+    "rear": -177.42,
+    "front": 51.8,
+    "leftSide": 31.88,
+    "rightSide": -80.32
+  },
+  "mountOffsets": {
+    "left": [-13.5, -60.5, 255.675],
+    "right": [40.5, -60.5, 255.675],
+    "gripper": [84.55, -12.75, 93.85]
+  }
 }

package/robot/schemas/1.json

@@ -5,11 +5,18 @@
     "robotType": {
       "type": "string",
       "enum": ["OT-2 Standard", "OT-3 Standard"]
+    },
+    "xyzArray": {
+      "type": "array",
+      "description": "Array of 3 numbers, [x, y, z]",
+      "items": { "type": "number" },
+      "minItems": 3,
+      "maxItems": 3
     }
   },
   "description": "Describes an Opentrons liquid handling robot.",
   "type": "object",
-  "required": ["displayName", "robotType", "models"],
+  "required": ["displayName", "robotType", "models", "extents", "mountOffsets"],
   "properties": {
     "displayName": {
       "description": "A user-facing friendly name for the machine.",
@@ -25,6 +32,52 @@
       "items": {
         "type": "string"
       }
+    },
+    "extents": {
+      "description": "The maximum addressable coordinates of the deck without instruments.",
+      "$ref": "#/definitions/xyzArray"
+    },
+    "paddingOffsets": {
+      "description": "The distance from a given edge of a deck extent by which the maximum amount of travel is limited.",
+      "type": "object",
+      "required": ["rear", "front", "leftSide", "rightSide"],
+      "properties": {
+        "rear": {
+          "description": "The padding distance from the rear edge of the deck extents which the front nozzles of a pipette must not exceed.",
+          "type": "number"
+        },
+        "front": {
+          "description": "The padding distance from the front edge of the deck extents which the rear nozzles of a pipette must not exceed.",
+          "type": "number"
+        },
+        "leftSide": {
+          "description": "The padding distance from the left edge of the deck extents which the right-most nozzles of a pipette must not exceed.",
+          "type": "number"
+        },
+        "rightSide": {
+          "description": "The padding distance from the right edge of the deck extents which the left-most nozzles of a pipette must not exceed.",
+          "type": "number"
+        }
+      }
+    },
+    "mountOffsets": {
+      "description": "The physical mount offsets from the center of the instrument carriage.",
+      "type": "object",
+      "required": ["left", "right"],
+      "properties": {
+        "left": {
+          "description": "The left mount offset from the center of the carriage to the center of the left mount",
+          "$ref": "#/definitions/xyzArray"
+        },
+        "right": {
+          "description": "The right mount offset from the center of the carriage to the center of the right mount",
+          "$ref": "#/definitions/xyzArray"
+        },
+        "gripper": {
+          "description": "The gripper mount offset from the center of the carriage to the center of the gripper, only on OT-3 Standard definitions",
+          "$ref": "#/definitions/xyzArray"
+        }
+      }
     }
   }
 }

package/tsconfig-data.json

@@ -7,6 +7,7 @@
     "rootDir": ".",
     "outDir": "lib"
   },
+  "module": "ESNext",
   "include": [
     "deck/**/*.json",
     "labware/**/*.json",

package/tsconfig.json

@@ -4,14 +4,21 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": ".",
-    "outDir": "lib"
+    "outDir": "lib",
+    "moduleResolution": "node"
   },
+  "module": "ESNext",
   "include": [
     "js",
+    "js/**/*.json",
     "protocol",
+    "pipette",
+    "labware",
     "deck",
-    "command/types",
+    "command",
+    "errors",
     "liquid/types",
-    "commandAnnotation/types"
+    "commandAnnotation/types",
+    "vite.config.mts"
   ]
 }

package/vite.config.mts

@@ -0,0 +1,25 @@
+/* eslint-disable */
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  build: {
+    // Relative to the root
+    ssr: 'js/index.ts',
+    outDir: 'lib',
+    // do not delete the outdir, typescript types might live there and we dont want to delete them
+    emptyOutDir: false,
+    commonjsOptions: {
+      transformMixedEsModules: true,
+      esmExternals: true,
+    },
+  },
+  optimizeDeps: {
+    esbuildOptions: {
+      target: 'es2020',
+    },
+  },
+  define: {
+    'process.env': process.env,
+    global: 'globalThis',
+  },
+})