@opentrons/step-generation 0.3.0-alpha.0

package/lib/utils/traversals.d.ts

@@ -0,0 +1,127 @@
+import type { AddressableAreaName, DeckConfiguration, DeckDefinition, LoadedLabwareLocation } from '@opentrons/shared-data';
+import type { LabwareEntities, ModuleEntities, RobotState } from '../types';
+type LabwareLocationCache = Map<LoadedLabwareLocation, LoadedLabwareLocation[]>;
+/**
+ * Recursively computes the full stack of labware nodes from the given node upwards
+ * (top-down), collecting each node until a non-labware node is reached.
+ *
+ * @param args.node The labware or location node to get the full stack for.
+ * @param args.robotState The current robot state containing all labware.
+ * @param args.stack (Optional) The stack collected so far, used in recursion.
+ * @param args.memo (Optional) A memoization map to cache computed stacks for nodes.
+ * @returns An object containing the complete stack and an updated memo map.
+ */
+export declare const getFullStackFromNodeTopDownRecursive: (args: {
+    node: LoadedLabwareLocation;
+    robotState: RobotState;
+    stack?: LoadedLabwareLocation[];
+    memo?: LabwareLocationCache;
+}) => {
+    stack: LoadedLabwareLocation[];
+    memo: LabwareLocationCache;
+};
+/**
+ * Finds the ID of the module associated with the provided node's stack, if any.
+ *
+ * @param args.node The labware/location node whose stack will be searched for a parent module.
+ * @param args.robotState The current robot state including modules.
+ * @param args.deckDef The deck definition, needed for cutout fixtures.
+ * @param args.deckConfiguration The configuration of the deck, including cutout mappings.
+ * @returns The string module id if found, or null otherwise.
+ */
+export declare const getNodeParentModuleId: (args: {
+    node: LoadedLabwareLocation;
+    robotState: RobotState;
+    deckDef: DeckDefinition;
+    deckConfiguration: DeckConfiguration;
+}) => string | null;
+/**
+ * Finds the largest stack (with deepest nesting) that contains the specified labware.
+ *
+ * @param args.labwareId The id of the labware to search for within stacks.
+ * @param args.robotState The current robot state to extract stacks from.
+ * @returns The largest LoadedLabwareLocation[] stack that contains the target labware.
+ */
+export declare const getLargestStackContainingLabware: (args: {
+    labwareId: string;
+    robotState: RobotState;
+}) => LoadedLabwareLocation[];
+/**
+ * Gets all unique, largest stacks of labware present in the current robot state.
+ *
+ * @param robotState The current robot state.
+ * @returns An array of LoadedLabwareLocation[]—one for each largest stack (per root).
+ */
+export declare const getAllLargestStacks: (robotState: RobotState) => LoadedLabwareLocation[][];
+export declare const getAddressableAreaFromModule: (args: {
+    moduleId: string;
+    robotState: RobotState;
+    moduleEntities: ModuleEntities;
+    deckDef: DeckDefinition;
+}) => AddressableAreaName | null;
+/**
+ * Gets the addressable area name for a given labware location.
+ *
+ * @param args.location The labware location to get the addressable area name for.
+ * @param args.robotState The current robot state.
+ * @param args.moduleEntities The module entities.
+ * @param args.deckDef The deck definition.
+ * @returns The addressable area name, or null if no addressable area name is found.
+ */
+export declare const getAddressableAreaNameFromLabwareLocation: (args: {
+    location: LoadedLabwareLocation;
+    robotState: RobotState;
+    moduleEntities: ModuleEntities;
+    deckDef: DeckDefinition;
+}) => AddressableAreaName | null;
+/**
+ * Gets all provided addressable areas in the deck configuration.
+ * The returned addressable areas should be the uppermost provided areas.
+ * For example, if a magnetic block is configured in slot C1, addressable
+ * area C1 should not be returned, but rather magneticBlockV1C1 should be.
+ *
+ * @param args.deckConfiguration The deck configuration.
+ * @param args.deckDefinition The deck definition.
+ * @returns An array of AddressableAreaName.
+ */
+export declare const getAllProvidedAddressableAreasFromDeckConfig: (args: {
+    deckConfiguration: DeckConfiguration;
+    deckDefinition: DeckDefinition;
+}) => Set<AddressableAreaName>;
+export declare const getProvidedAddressableAreasExposed: (args: {
+    robotState: RobotState;
+    deckConfiguration: DeckConfiguration;
+    deckDefinition: DeckDefinition;
+    moduleEntities: ModuleEntities;
+}) => Set<AddressableAreaName>;
+/**
+ * Protocol Designer stack strings (top → bottom) map to PE `LoadedLabwareLocation`
+ * for the immediate parent of `subjectLabwareId`.
+ */
+export declare const getStackedOnNodeFromPdStack: (args: {
+    stack: string[];
+    subjectLabwareId: string;
+    moduleEntities: ModuleEntities;
+    labwareEntityIds: ReadonlySet<string>;
+    modules: RobotState['modules'];
+}) => LoadedLabwareLocation | undefined;
+/**
+ * When exactly two labware share the same object `stackedOnNode` (non-hopper), and one labware
+ * footprint strictly exceeds the other in both X and Y, set `contains` on the **larger** labware
+ * to the id of the smaller-footprint labware. Groups of size other than 2, ties, or missing defs are skipped.
+ */
+export declare const assignContainsAmongSiblings: (labware: RobotState['labware'], labwareEntities: LabwareEntities) => RobotState['labware'];
+/**
+ * Ensures each labware row has `stackedOnNode` for stack-graph traversals.
+ * Fills from Protocol Designer-style `stack` via {@link getStackedOnNodeFromPdStack} when missing.
+ *
+ * When `labwareEntities` is passed, pairs of labware that share the same eligible parent
+ * `stackedOnNode` may set `contains` on the larger footprint to the smaller labware id.
+ *
+ * **Protocol Designer:** call once when composing initial robot state (see PD
+ * {@link getInitialEnrichedRobotState}). After that, timeline `robotState` frames should keep this metadata
+ * current via command-specific updaters (`forMoveLabware`, stacker handlers, etc.), not by
+ * re-running this helper on every active step.
+ */
+export declare const enrichRobotStateForStackGraphTraversals: (robotState: RobotState, moduleEntities: ModuleEntities, labwareEntities: LabwareEntities) => RobotState;
+export {};

package/lib/warningCreators.d.ts

@@ -0,0 +1,7 @@
+import type { CommandCreatorWarning } from './types';
+export declare function aspirateMoreThanWellContents(): CommandCreatorWarning;
+export declare function aspirateFromPristineWell(): CommandCreatorWarning;
+export declare function labwareInWasteChuteHasLiquid(): CommandCreatorWarning;
+export declare function tiprackInWasteChuteHasTips(): CommandCreatorWarning;
+export declare function potentiallyUnreachableTemp(): CommandCreatorWarning;
+export declare function waitingForNonexistentTask(): CommandCreatorWarning;

package/package.json

@@ -0,0 +1,45 @@
+{
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Opentrons/opentrons.git"
+  },
+  "author": {
+    "name": "Opentrons Labworks",
+    "email": "engineering@opentrons.com"
+  },
+  "name": "@opentrons/step-generation",
+  "productName": "Opentrons Step Generation",
+  "version": "0.3.0-alpha.0",
+  "description": "Step generation",
+  "main": "lib/index.cjs",
+  "types": "lib/index.d.ts",
+  "module": "lib/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib/",
+    "README.md",
+    "LICENSE"
+  ],
+  "bugs": {
+    "url": "https://github.com/Opentrons/opentrons/issues"
+  },
+  "homepage": "https://github.com/Opentrons/opentrons",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@opentrons/shared-data": "0.3.0-alpha.0",
+    "core-js": "3.2.1",
+    "immer": "^10.1.3",
+    "lodash": "4.18.1",
+    "uuid": "3.3.2"
+  },
+  "devDependencies": {
+    "@types/lodash": "4.17.24"
+  }
+}