@opentrons/components 0.1.6-alpha.9 → 0.1.7-alpha.0

package/lib/modals/ModalShell.d.ts

@@ -1,15 +1,15 @@
-import type * as React from 'react';
+import type { MouseEventHandler, ReactNode } from 'react';
 import type { StyleProps } from '../primitives';
 export type Position = 'center' | 'bottomRight';
 export interface ModalShellProps extends StyleProps {
     /** Modal content */
-    children: React.ReactNode;
+    children: ReactNode;
     /** Optional close on outside click **/
-    onOutsideClick?: React.MouseEventHandler;
+    onOutsideClick?: MouseEventHandler;
     /** Optional sticky header */
-    header?: React.ReactNode;
+    header?: ReactNode;
     /** Optional sticky footer */
-    footer?: React.ReactNode;
+    footer?: ReactNode;
     /** Optional full page takeover */
     fullPage?: boolean;
     /** Optional zIndex for the overlay */

package/lib/modals/Overlay.d.ts

@@ -1,8 +1,8 @@
-import type * as React from 'react';
 import { Flex } from '..';
-export interface OverlayProps extends React.ComponentProps<typeof Flex> {
+import type { ComponentProps, MouseEventHandler } from 'react';
+export interface OverlayProps extends ComponentProps<typeof Flex> {
     /** optional onClick handler */
-    onClick?: React.MouseEventHandler;
+    onClick?: MouseEventHandler;
     alertOverlay?: boolean | null;
     backgroundColor?: string;
 }

package/lib/modals/SpinnerModalPage.d.ts

@@ -1,7 +1,7 @@
-import type * as React from 'react';
 import { SpinnerModal } from './SpinnerModal';
+import type { ComponentProps } from 'react';
 import type { TitleBarProps } from '../structure';
-export interface SpinnerModalPageProps extends React.ComponentProps<typeof SpinnerModal> {
+export interface SpinnerModalPageProps extends ComponentProps<typeof SpinnerModal> {
     /** Props for title bar at top of modal page */
     titleBar: TitleBarProps;
 }

package/lib/molecules/Banner/index.d.ts

@@ -1,4 +1,4 @@
-import type * as React from 'react';
+import type { MouseEventHandler, ReactNode } from 'react';
 import type { StyleProps } from '../../primitives';
 import type { IconProps } from '../../icons';
 export type BannerType = 'success' | 'warning' | 'error' | 'updating' | 'informing';
@@ -6,15 +6,15 @@ export interface BannerProps extends StyleProps {
     /** name constant of the icon to display */
     type: BannerType;
     /** Banner contents */
-    children?: React.ReactNode;
+    children?: ReactNode;
     /** optional handler to show close button/clear alert  */
-    onCloseClick?: (() => void) | React.MouseEventHandler<HTMLButtonElement>;
+    onCloseClick?: (() => void) | MouseEventHandler<HTMLButtonElement>;
     /** Override the default Alert Icon */
     icon?: IconProps;
     /** some banner onCloseClicks fire events, this allows a spinner after click but before event finishes */
     isCloseActionLoading?: boolean;
     /** Override the Exit icon */
-    closeButton?: React.ReactNode;
+    closeButton?: ReactNode;
     /** Icon margin right for large banners */
     iconMarginRight?: string;
     /** Icon margin left for large banners */

package/lib/molecules/DeckInfoLabel/index.d.ts

@@ -1,14 +1,14 @@
-import type { ModuleIconName } from '../../icons';
+import type { IconName, ModuleIconName } from '../../icons';
 import type { StyleProps } from '../../primitives';
 interface DeckLabelProps extends StyleProps {
     /** deck label to display */
     deckLabel: string;
-    iconName?: undefined;
+    iconName?: IconName;
 }
 interface HardwareIconProps extends StyleProps {
     /** hardware icon name */
     iconName: ModuleIconName | 'stacked';
-    deckLabel?: undefined;
+    deckLabel?: string;
 }
 export type DeckInfoLabelProps = (DeckLabelProps | HardwareIconProps) & {
     highlight?: boolean;

package/lib/molecules/DeckLabel/index.d.ts

@@ -1,5 +1,6 @@
 import type { ModuleModel } from '@opentrons/shared-data';
 export interface DeckLabelProps {
+    isZoomed: boolean;
     text: string;
     isSelected: boolean;
     moduleModel?: ModuleModel;
@@ -7,4 +8,4 @@ export interface DeckLabelProps {
     labelBorderRadius?: string;
     isLast?: boolean;
 }
-export declare function DeckLabel({ text, isSelected, labelBorderRadius, moduleModel, maxWidth, isLast, }: DeckLabelProps): JSX.Element;
+export declare function DeckLabel({ text, isSelected, labelBorderRadius, moduleModel, maxWidth, isLast, isZoomed, }: DeckLabelProps): JSX.Element;

package/lib/molecules/DropdownMenu/index.d.ts

@@ -1,13 +1,23 @@
-import * as React from 'react';
+import type { FocusEventHandler } from 'react';
+import type { FlattenSimpleInterpolation } from 'styled-components';
 export interface DropdownOption {
+    /** dropdown option name */
     name: string;
+    /** dropdown option value */
     value: string;
     /** optional dropdown option for adding the liquid color icon */
     liquidColor?: string;
+    /** optional dropdown option for adding the deck label */
+    deckLabel?: string;
+    /** subtext below the name */
+    subtext?: string;
+    /** optional disabled */
     disabled?: boolean;
-    tooltipText?: string;
+    /** optional tooltip text */
+    tooltipText?: string | null;
 }
 export type DropdownBorder = 'rounded' | 'neutral';
+type MenuPlacement = 'auto' | 'top' | 'bottom';
 export interface DropdownMenuProps {
     /** dropdown options */
     filterOptions: DropdownOption[];
@@ -30,12 +40,18 @@ export interface DropdownMenuProps {
     /** optional error */
     error?: string | null;
     /** focus handler */
-    onFocus?: React.FocusEventHandler<HTMLButtonElement>;
+    onFocus?: FocusEventHandler<HTMLButtonElement>;
     /** blur handler */
-    onBlur?: React.FocusEventHandler<HTMLButtonElement>;
+    onBlur?: FocusEventHandler<HTMLButtonElement>;
     /** optional disabled */
     disabled?: boolean;
-    /** force direction for pd after release this will be fixed and remove */
-    forceDirection?: boolean;
+    /** optional placement of the menu */
+    menuPlacement?: MenuPlacement;
+    /** optional enter handler */
+    onEnter?: (id: string) => void;
+    /** optional exit handler */
+    onExit?: () => void;
 }
 export declare function DropdownMenu(props: DropdownMenuProps): JSX.Element;
+export declare const LINE_CLAMP_TEXT_STYLE: (lineClamp?: number, wordBreak?: boolean) => FlattenSimpleInterpolation;
+export {};

package/lib/molecules/InfoScreen/index.d.ts

@@ -1,6 +1,8 @@
 interface InfoScreenProps {
     content: string;
+    subContent?: string;
     backgroundColor?: string;
+    height?: string;
 }
-export declare function InfoScreen({ content, backgroundColor, }: InfoScreenProps): JSX.Element;
+export declare function InfoScreen({ content, subContent, backgroundColor, height, }: InfoScreenProps): JSX.Element;
 export {};

package/lib/molecules/ListAccordion/index.d.ts

@@ -0,0 +1,11 @@
+import type { ReactNode } from 'react';
+import type { ListTableProps } from '../../atoms/ListTable';
+export type ListAccordionAlertKind = 'default' | 'warning';
+export interface ListAccordionProps {
+    headerChild: ReactNode;
+    alertKind: ListAccordionAlertKind;
+    tableHeaders: ListTableProps['headers'];
+    children: ListTableProps['children'];
+    icon?: JSX.Element;
+}
+export declare function ListAccordion({ headerChild, alertKind, icon, children, tableHeaders, }: ListAccordionProps): JSX.Element;

package/lib/molecules/ReleaseNotes/index.d.ts

@@ -0,0 +1,5 @@
+export interface ReleaseNotesProps {
+    isOEMMode: boolean;
+    source?: string | null;
+}
+export declare function ReleaseNotes(props: ReleaseNotesProps): JSX.Element;

package/lib/molecules/Tabs/index.d.ts

@@ -3,6 +3,7 @@ export interface TabProps {
     onClick: () => void;
     isActive?: boolean;
     disabled?: boolean;
+    disabledReasonForTooltip?: string;
 }
 export interface TabsProps {
     tabs: TabProps[];

package/lib/molecules/TextListTableContent/__tests__/TextListTableContent.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/molecules/TextListTableContent/index.d.ts

@@ -0,0 +1,8 @@
+import type { ReactNode } from 'react';
+import type { ListTableProps } from '../../atoms/ListTable';
+export interface TextListTableContentProps {
+    header: ReactNode;
+    listTableHeaders?: ListTableProps['headers'];
+    children: ReactNode;
+}
+export declare function TextListTableContent({ header, listTableHeaders, children, }: TextListTableContentProps): JSX.Element;

package/lib/molecules/index.d.ts

@@ -5,4 +5,7 @@ export * from './DropdownMenu';
 export * from './InfoScreen';
 export * from './LiquidIcon';
 export * from './ParametersTable';
+export * from './ReleaseNotes';
 export * from './Tabs';
+export * from './TextListTableContent';
+export * from './ListAccordion';

package/lib/nav/SidePanel.d.ts

@@ -1,6 +1,6 @@
-import type * as React from 'react';
+import type { ReactNode } from 'react';
 export interface SidePanelProps {
     title?: string;
-    children?: React.ReactNode;
+    children?: ReactNode;
 }
 export declare function SidePanel(props: SidePanelProps): JSX.Element;

package/lib/organisms/CommandText/__tests__/CommandText.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/organisms/CommandText/fixtures/index.d.ts

@@ -0,0 +1,2 @@
+import type { CompletedProtocolAnalysis } from '@opentrons/shared-data';
+export declare const mockRobotSideAnalysis: CompletedProtocolAnalysis;

package/lib/organisms/CommandText/index.d.ts

@@ -0,0 +1,26 @@
+import { LegacyStyledText, StyledText } from '../../atoms';
+import type { ComponentProps } from 'react';
+import type { LabwareDefinition2, RobotType, RunTimeCommand } from '@opentrons/shared-data';
+import type { StyleProps } from '../../primitives';
+import type { CommandTextData } from '../ProtocolTimelineScrubber/types';
+export * from './useCommandTextString';
+interface LegacySTProps {
+    as?: ComponentProps<typeof LegacyStyledText>['as'];
+    modernStyledTextDefaults?: false;
+}
+interface ModernSTProps {
+    desktopStyle?: ComponentProps<typeof StyledText>['desktopStyle'];
+    oddStyle?: ComponentProps<typeof StyledText>['oddStyle'];
+    modernStyledTextDefaults: true;
+}
+type STProps = LegacySTProps | ModernSTProps;
+interface BaseProps extends StyleProps {
+    command: RunTimeCommand;
+    allRunDefs: LabwareDefinition2[];
+    commandTextData: CommandTextData;
+    robotType: RobotType;
+    isOnDevice?: boolean;
+    propagateCenter?: boolean;
+    propagateTextLimit?: boolean;
+}
+export declare function CommandText(props: BaseProps & STProps): JSX.Element | null;

package/lib/organisms/CommandText/useCommandTextString/index.d.ts

@@ -0,0 +1,30 @@
+import type { TFunction } from 'i18next';
+import type { RunTimeCommand, RobotType, LabwareDefinition2 } from '@opentrons/shared-data';
+import type { CommandTextData } from '../../ProtocolTimelineScrubber/types';
+import type { TCProfileStepText, TCProfileCycleText } from './utils';
+export * from './utils';
+export interface UseCommandTextStringParams {
+    command: RunTimeCommand | null;
+    allRunDefs: LabwareDefinition2[];
+    commandTextData: CommandTextData | null;
+    robotType: RobotType;
+}
+export type GetCommandText = UseCommandTextStringParams & {
+    t: TFunction;
+};
+export interface GetGenericCommandTextResult {
+    kind: 'generic';
+    commandText: string;
+}
+export interface GetTCRunProfileCommandTextResult {
+    kind: 'thermocycler/runProfile';
+    commandText: string;
+    stepTexts: string[];
+}
+export interface GetTCRunExtendedProfileCommandTextResult {
+    kind: 'thermocycler/runExtendedProfile';
+    commandText: string;
+    profileElementTexts: Array<TCProfileStepText | TCProfileCycleText>;
+}
+export type GetCommandTextResult = GetGenericCommandTextResult | GetTCRunProfileCommandTextResult | GetTCRunExtendedProfileCommandTextResult;
+export declare function useCommandTextString(params: UseCommandTextStringParams): GetCommandTextResult;

package/lib/organisms/CommandText/useCommandTextString/utils/__tests__/formatDuration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/__tests__/getFinalLabwareLocation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/__tests__/getLabwareDisplayLocation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/__tests__/getPipettingCommandText.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getAbsorbanceReaderCommandText.d.ts

@@ -0,0 +1,12 @@
+import type { AbsorbanceReaderOpenLidRunTimeCommand, AbsorbanceReaderCloseLidRunTimeCommand, AbsorbanceReaderInitializeRunTimeCommand, AbsorbanceReaderReadRunTimeCommand, RunTimeCommand } from '@opentrons/shared-data';
+import type { HandlesCommands } from '../types';
+export type AbsorbanceCreateCommand = AbsorbanceReaderOpenLidRunTimeCommand | AbsorbanceReaderCloseLidRunTimeCommand | AbsorbanceReaderInitializeRunTimeCommand | AbsorbanceReaderReadRunTimeCommand;
+declare const KEYS_BY_COMMAND_TYPE: {
+    [commandType in AbsorbanceCreateCommand['commandType']]: string;
+};
+type HandledCommands = Extract<RunTimeCommand, {
+    commandType: keyof typeof KEYS_BY_COMMAND_TYPE;
+}>;
+type GetAbsorbanceReaderCommandText = HandlesCommands<HandledCommands>;
+export declare const getAbsorbanceReaderCommandText: ({ command, t, }: GetAbsorbanceReaderCommandText) => string;
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getCommentCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { CommentRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getCommentCommandText({ command, }: HandlesCommands<CommentRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getConfigureForVolumeCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigureForVolumeRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getConfigureForVolumeCommandText({ command, commandTextData, t, }: HandlesCommands<ConfigureForVolumeRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getConfigureNozzleLayoutCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigureNozzleLayoutRunTimeCommand } from '@opentrons/shared-data';
+import type { HandlesCommands } from '../types';
+export declare function getConfigureNozzleLayoutCommandText({ command, commandTextData, t, }: HandlesCommands<ConfigureNozzleLayoutRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getCustomCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { CustomRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getCustomCommandText({ command, }: HandlesCommands<CustomRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getDelayCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { DeprecatedDelayRunTimeCommand } from '@opentrons/shared-data';
+import type { HandlesCommands } from '../types';
+export declare function getDelayCommandText({ command, t, }: HandlesCommands<DeprecatedDelayRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getDirectTranslationCommandText.d.ts

@@ -0,0 +1,11 @@
+import type { RunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+declare const SIMPLE_TRANSLATION_KEY_BY_COMMAND_TYPE: {
+    [commandType in RunTimeCommand['commandType']]?: string;
+};
+type HandledCommands = Extract<RunTimeCommand, {
+    commandType: keyof typeof SIMPLE_TRANSLATION_KEY_BY_COMMAND_TYPE;
+}>;
+export type GetDirectTranslationCommandText = HandlesCommands<HandledCommands>;
+export declare function getDirectTranslationCommandText({ command, t, }: GetDirectTranslationCommandText): string;
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getFlexStackerCommandText.d.ts

@@ -0,0 +1,9 @@
+import type { FlexStackerSetStoredLabwareRunTimeCommand, FlexStackerStoreRunTimeCommand, FlexStackerRetrieveRunTimeCommand, FlexStackerFillRunTimeCommand, FlexStackerEmptyRunTimeCommand, RunTimeCommand } from '@opentrons/shared-data';
+import type { HandlesCommands } from '../types';
+export type FlexStackerCommand = FlexStackerSetStoredLabwareRunTimeCommand | FlexStackerStoreRunTimeCommand | FlexStackerRetrieveRunTimeCommand | FlexStackerFillRunTimeCommand | FlexStackerEmptyRunTimeCommand;
+type HandledCommands = Extract<RunTimeCommand, {
+    commandType: FlexStackerCommand;
+}>;
+type GetFlexStackerCommandText = HandlesCommands<HandledCommands>;
+export declare const getFlexStackerCommandText: ({ command, t, }: GetFlexStackerCommandText) => string;
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getHSShakeSpeedCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getHSShakeSpeedCommandText({ command, t, }: HandlesCommands<HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getLiquidProbeCommandText.d.ts

@@ -0,0 +1,5 @@
+import type { LiquidProbeRunTimeCommand, TryLiquidProbeRunTimeCommand } from '@opentrons/shared-data';
+import type { HandlesCommands } from '../types';
+type LiquidProbeRunTimeCommands = LiquidProbeRunTimeCommand | TryLiquidProbeRunTimeCommand;
+export declare function getLiquidProbeCommandText({ command, allRunDefs, commandTextData, t, robotType, }: HandlesCommands<LiquidProbeRunTimeCommands>): string;
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getLoadCommandText.d.ts

@@ -0,0 +1,2 @@
+import type { GetCommandText } from '../..';
+export declare const getLoadCommandText: ({ command, commandTextData, robotType, t, allRunDefs, }: GetCommandText) => string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getMoveLabwareCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { MoveLabwareRunTimeCommand } from '@opentrons/shared-data';
+import type { HandlesCommands } from '../types';
+export declare function getMoveLabwareCommandText({ command, allRunDefs, t, commandTextData, robotType, }: HandlesCommands<MoveLabwareRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getMoveRelativeCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { MoveRelativeRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getMoveRelativeCommandText({ command, t, }: HandlesCommands<MoveRelativeRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToAddressableAreaCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { MoveToAddressableAreaRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getMoveToAddressableAreaCommandText({ command, commandTextData, t, }: HandlesCommands<MoveToAddressableAreaRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToAddressableAreaForDropTipCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { MoveToAddressableAreaForDropTipRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getMoveToAddressableAreaForDropTipCommandText({ command, commandTextData, t, }: HandlesCommands<MoveToAddressableAreaForDropTipRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToCoordinatesCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { MoveToCoordinatesRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getMoveToCoordinatesCommandText({ command, t, }: HandlesCommands<MoveToCoordinatesRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToSlotCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { MoveToSlotRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getMoveToSlotCommandText({ command, t, }: HandlesCommands<MoveToSlotRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToWellCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { MoveToWellRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getMoveToWellCommandText({ command, allRunDefs, t, commandTextData, robotType, }: HandlesCommands<MoveToWellRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getPipettingCommandText.d.ts

@@ -0,0 +1,2 @@
+import type { GetCommandText } from '../..';
+export declare const getPipettingCommandText: ({ command, allRunDefs, commandTextData, robotType, t, }: GetCommandText) => string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getPrepareToAspirateCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { PrepareToAspirateRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getPrepareToAspirateCommandText({ command, commandTextData, t, }: HandlesCommands<PrepareToAspirateRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getRailLightsCommandText.d.ts

@@ -0,0 +1,8 @@
+import type { RunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+type HandledCommands = Extract<RunTimeCommand, {
+    commandType: 'setRailLights';
+}>;
+export type GetRailLightsCommandText = HandlesCommands<HandledCommands>;
+export declare function getRailLightsCommandText({ command, t, }: GetRailLightsCommandText): string;
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getTCRunExtendedProfileCommandText.d.ts

@@ -0,0 +1,13 @@
+import type { TCRunExtendedProfileRunTimeCommand } from '@opentrons/shared-data/command';
+import type { GetTCRunExtendedProfileCommandTextResult } from '../..';
+import type { HandlesCommands } from '../types';
+export interface TCProfileStepText {
+    kind: 'step';
+    stepText: string;
+}
+export interface TCProfileCycleText {
+    kind: 'cycle';
+    cycleText: string;
+    stepTexts: TCProfileStepText[];
+}
+export declare function getTCRunExtendedProfileCommandText({ command, t, }: HandlesCommands<TCRunExtendedProfileRunTimeCommand>): GetTCRunExtendedProfileCommandTextResult;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getTCRunProfileCommandText.d.ts

@@ -0,0 +1,4 @@
+import type { TCRunProfileRunTimeCommand } from '@opentrons/shared-data/command';
+import type { GetTCRunProfileCommandTextResult } from '../..';
+import type { HandlesCommands } from '../types';
+export declare function getTCRunProfileCommandText({ command, t, }: HandlesCommands<TCRunProfileRunTimeCommand>): GetTCRunProfileCommandTextResult;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getTemperatureCommandText.d.ts

@@ -0,0 +1,12 @@
+import type { TemperatureModuleAwaitTemperatureCreateCommand, TemperatureModuleSetTargetTemperatureCreateCommand, TCSetTargetBlockTemperatureCreateCommand, TCSetTargetLidTemperatureCreateCommand, HeaterShakerSetTargetTemperatureCreateCommand, RunTimeCommand } from '@opentrons/shared-data';
+import type { HandlesCommands } from '../types';
+export type TemperatureCreateCommand = TemperatureModuleSetTargetTemperatureCreateCommand | TemperatureModuleAwaitTemperatureCreateCommand | TCSetTargetBlockTemperatureCreateCommand | TCSetTargetLidTemperatureCreateCommand | HeaterShakerSetTargetTemperatureCreateCommand;
+declare const T_KEYS_BY_COMMAND_TYPE: {
+    [commandType in TemperatureCreateCommand['commandType']]: string;
+};
+type HandledCommands = Extract<RunTimeCommand, {
+    commandType: keyof typeof T_KEYS_BY_COMMAND_TYPE;
+}>;
+type GetTemperatureCommandText = HandlesCommands<HandledCommands>;
+export declare const getTemperatureCommandText: ({ command, t, }: GetTemperatureCommandText) => string;
+export {};

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getUnknownCommandText.d.ts

@@ -0,0 +1,2 @@
+import type { GetCommandText } from '../..';
+export declare function getUnknownCommandText({ command }: GetCommandText): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getWaitForDurationCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { WaitForDurationRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getWaitForDurationCommandText({ command, t, }: HandlesCommands<WaitForDurationRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/getWaitForResumeCommandText.d.ts

@@ -0,0 +1,3 @@
+import type { WaitForResumeRunTimeCommand } from '@opentrons/shared-data/command';
+import type { HandlesCommands } from '../types';
+export declare function getWaitForResumeCommandText({ command, t, }: HandlesCommands<WaitForResumeRunTimeCommand>): string;

package/lib/organisms/CommandText/useCommandTextString/utils/commandText/index.d.ts

@@ -0,0 +1,26 @@
+export * from './getLoadCommandText';
+export * from './getTemperatureCommandText';
+export * from './getTCRunProfileCommandText';
+export * from './getTCRunExtendedProfileCommandText';
+export * from './getHSShakeSpeedCommandText';
+export * from './getMoveToSlotCommandText';
+export * from './getMoveRelativeCommandText';
+export * from './getMoveToCoordinatesCommandText';
+export * from './getMoveToWellCommandText';
+export * from './getMoveLabwareCommandText';
+export * from './getConfigureForVolumeCommandText';
+export * from './getConfigureNozzleLayoutCommandText';
+export * from './getPrepareToAspirateCommandText';
+export * from './getMoveToAddressableAreaCommandText';
+export * from './getMoveToAddressableAreaForDropTipCommandText';
+export * from './getDirectTranslationCommandText';
+export * from './getWaitForDurationCommandText';
+export * from './getWaitForResumeCommandText';
+export * from './getDelayCommandText';
+export * from './getCommentCommandText';
+export * from './getCustomCommandText';
+export * from './getUnknownCommandText';
+export * from './getPipettingCommandText';
+export * from './getLiquidProbeCommandText';
+export * from './getRailLightsCommandText';
+export * from './getAbsorbanceReaderCommandText';

package/lib/organisms/CommandText/useCommandTextString/utils/formatDuration.d.ts

@@ -0,0 +1,8 @@
+import type { Duration } from 'date-fns';
+/**
+ * utility to format a date-fns duration object to hh:mm:ss
+ * @param duration date-fns duration object
+ * @returns string in format hh:mm:ss, e.g. 03:15:45
+ */
+export declare function formatDuration(duration: Duration): string;
+export declare function formatDurationLabeled(duration: Duration): string;

package/lib/organisms/CommandText/useCommandTextString/utils/getAddressableAreaDisplayName.d.ts

@@ -0,0 +1,3 @@
+import type { RunTimeCommand } from '@opentrons/shared-data';
+import type { TFunction } from 'i18next';
+export declare function getAddressableAreaDisplayName(commands: RunTimeCommand[] | undefined, commandId: string, t: TFunction): string;

package/lib/organisms/CommandText/useCommandTextString/utils/getFinalAddressableAreaCmd.d.ts

@@ -0,0 +1,8 @@
+import type { RunTimeCommand } from '@opentrons/shared-data';
+/**
+ * given a list of commands and a labwareId, calculate the resulting location
+ * of the corresponding labware after all given commands are executed
+ * @param commands list of commands to search within
+ * @returns The last command related to addressable areas.
+ */
+export declare function getFinalMoveToAddressableAreaCmd(commands: RunTimeCommand[]): RunTimeCommand | null;

package/lib/organisms/CommandText/useCommandTextString/utils/getFinalLabwareLocation.d.ts

@@ -0,0 +1,12 @@
+import type { LabwareLocation, RunTimeCommand, LabwareLocationSequence } from '@opentrons/shared-data';
+/**
+ * given a list of commands and a labwareId, calculate the resulting location
+ * of the corresponding labware after all given commands are executed
+ * @param labwareId target labware
+ * @param commands list of commands to search within
+ * @returns LabwareLocation object of the resulting location of the target labware after all commands execute
+ */
+export declare function getFinalLabwareLocation(labwareId: string, commands: RunTimeCommand[]): {
+    location?: LabwareLocation;
+    locationSequence?: LabwareLocationSequence;
+};

package/lib/organisms/CommandText/useCommandTextString/utils/getLabwareDefinitionsFromCommands.d.ts

@@ -0,0 +1,2 @@
+import type { LabwareDefinition2, RunTimeCommand } from '@opentrons/shared-data';
+export declare function getLabwareDefinitionsFromCommands(commands: RunTimeCommand[]): LabwareDefinition2[];

package/lib/organisms/CommandText/useCommandTextString/utils/getLabwareDisplayLocation.d.ts

@@ -0,0 +1,15 @@
+import type { TFunction } from 'i18next';
+import type { LocationFullParams, LocationSlotOnlyParams } from './getLabwareLocation';
+import type { LabwareLocation, LabwareLocationSequence } from '@opentrons/shared-data';
+export interface DisplayLocationSlotOnlyParams extends Omit<LocationSlotOnlyParams, 'location'> {
+    t: TFunction;
+    isOnDevice?: boolean;
+    location?: LabwareLocation | LabwareLocationSequence | null;
+}
+export interface DisplayLocationFullParams extends Omit<LocationFullParams, 'location'> {
+    t: TFunction;
+    isOnDevice?: boolean;
+    location?: LabwareLocation | LabwareLocationSequence | null;
+}
+export type DisplayLocationParams = DisplayLocationSlotOnlyParams | DisplayLocationFullParams;
+export declare function getLabwareDisplayLocation(params: DisplayLocationParams): string;