FarmBot/Farmbot-Web-App

import {
  SequenceBodyItem,
  LegalArgString,
  SyncStatus,
  ALLOWED_CHANNEL_NAMES,
  Xyz,
  FarmwareConfig,
  ALLOWED_MESSAGE_TYPES,
  Vector3,
  TaggedSequence,
  Color,
} from "farmbot";
import { ResourceIndex, UUID } from "../resources/interfaces";
import { GetWebAppConfigValue } from "../config_storage/actions";
import { Folders } from "../folders/component";
import { DeviceSetting } from "../constants";
import { BooleanConfigKey } from "farmbot/dist/resources/configs/web_app";
import { SequencesPanelState } from "../interfaces";

export interface HardwareFlags {
  findHomeEnabled: Record<Xyz, boolean>;
  stopAtHome: Record<Xyz, boolean>;
  stopAtMax: Record<Xyz, boolean>;
  negativeOnly: Record<Xyz, boolean>;
  axisLength: Record<Xyz, number>;
}

export interface CheckConflictCaseProps {
  axis: Xyz;
  target: number;
  hardwareFlags: HardwareFlags;
}

export interface MoveAbsoluteWarningProps {
  coordinate: Vector3;
  hardwareFlags: HardwareFlags | undefined;
}

interface SequencePropsBase {
  dispatch: Function;
  syncStatus: SyncStatus;
  resources: ResourceIndex;
  sequencesState: SequenceReducerState;
  getWebAppConfigValue: GetWebAppConfigValue;
  visualized?: boolean;
}

export interface SequencesProps extends SequencePropsBase {
  sequences: TaggedSequence[];
  sequence: TaggedSequence | undefined;
  hardwareFlags: HardwareFlags;
  farmwareData: FarmwareData;
  folderData: Folders["props"];
  hoveredStep?: string | undefined;
  sequencesPanelState: SequencesPanelState;
}

export interface SequenceEditorMiddleProps extends SequencePropsBase {
  sequence: TaggedSequence | undefined;
  sequences: TaggedSequence[];
  hardwareFlags: HardwareFlags;
  farmwareData: FarmwareData;
  hoveredStep?: string | undefined;
}

export interface ActiveMiddleProps extends SequenceEditorMiddleProps {
  sequence: TaggedSequence;
  sequences: TaggedSequence[];
  showName: boolean;
}

export interface ActiveMiddleState {
  variablesCollapsed: boolean;
  descriptionCollapsed: boolean;
  stepsCollapsed: boolean;
  licenseCollapsed: boolean;
  viewSequenceCeleryScript: boolean;
  sequencePreview: TaggedSequence | undefined;
  error: boolean;
  view: "local" | "public";
  addVariableMenuOpen: boolean;
}

export interface SequenceHeaderProps extends SequencePropsBase {
  sequence: TaggedSequence;
  toggleViewSequenceCeleryScript: () => void;
  viewCeleryScript: boolean;
  showName: boolean;
}

export interface SequenceBtnGroupProps extends SequencePropsBase {
  sequence: TaggedSequence;
  toggleViewSequenceCeleryScript(): void;
  viewCeleryScript: boolean;
}

export interface SequenceSettingsMenuProps {
  dispatch: Function;
  getWebAppConfigValue: GetWebAppConfigValue;
}

export interface SequenceShareMenuProps {
  sequence: TaggedSequence;
}

export interface SequenceSettingProps {
  label: DeviceSetting;
  description: string;
  dispatch: Function;
  setting: BooleanConfigKey;
  getWebAppConfigValue: GetWebAppConfigValue;
  confirmation?: string;
  defaultOn?: boolean;
}

export type ChannelName = ALLOWED_CHANNEL_NAMES;

const INT_NUMERIC_FIELDS = ["milliseconds", "pin_mode", "pin_number",
  "pin_value", "rhs", "sequence_id", "speed"];

export const FLOAT_NUMERIC_FIELDS = ["x", "y", "z"];

export const NUMERIC_FIELDS = INT_NUMERIC_FIELDS.concat(FLOAT_NUMERIC_FIELDS);

export enum MessageType {
  success = "success",
  busy = "busy",
  warn = "warn",
  error = "error",
  info = "info",
  fun = "fun",
  debug = "debug",
  assertion = "assertion",
}

export const MESSAGE_TYPES = Object.keys(MessageType);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const isMessageType = (x: any): x is ALLOWED_MESSAGE_TYPES =>
  MESSAGE_TYPES.includes(x as string);

export interface RunButtonMenuOpen {
  component: "list" | "editor" | "pinned" | undefined;
  uuid: UUID | undefined;
}

export interface SequenceReducerState {
  current: string | undefined;
  menuOpen: RunButtonMenuOpen;
  stepIndex: number | undefined;
}

export interface MoveAbsState {
  more: boolean;
  viewRaw?: boolean;
}

export interface StepButtonParams {
  current: TaggedSequence | undefined;
  step: SequenceBodyItem;
  dispatch: Function;
  label: string;
  color: Color | "brown";
  index?: number | undefined;
}

export interface MoveParams {
  step: SequenceBodyItem;
  to: number;
  from: number;
  sequence: TaggedSequence
}

export interface SpliceParams {
  index: number;
  sequence: TaggedSequence;
  step: SequenceBodyItem;
}

export interface RemoveParams {
  index: number;
  dispatch: Function;
  sequence: TaggedSequence;
  confirmStepDeletion: boolean;
}

export interface StepInputProps {
  step: SequenceBodyItem;
  sequence: TaggedSequence;
  field: LegalArgString;
  dispatch: Function;
  type_?: "text" | "hidden" | undefined;
  index: number;
  fieldOverride?: boolean;
  keyCallback?: (key: string, buffer: string) => void;
}

export interface StepTitleBarProps {
  step: SequenceBodyItem;
  index: number;
  dispatch: Function;
  readOnly: boolean;
  sequence: TaggedSequence;
  pinnedSequenceName: string | undefined;
  toggleDraggable(action: "enter" | "leave"): () => void;
}

export interface SelectSequence {
  type: "SELECT_SEQUENCE";
  payload: string;
}

export type FarmwareConfigs = { [x: string]: FarmwareConfig[] };

export interface FarmwareData {
  farmwareNames: string[];
  firstPartyFarmwareNames: string[];
  showFirstPartyFarmware: boolean;
  farmwareConfigs: FarmwareConfigs;
  cameraDisabled: boolean;
  cameraCalibrated: boolean;
}

export interface StepParams<T = SequenceBodyItem> {
  currentSequence: TaggedSequence;
  currentStep: T;
  dispatch: Function;
  readOnly: boolean;
  index: number;
  resources: ResourceIndex;
  hardwareFlags?: HardwareFlags;
  farmwareData?: FarmwareData;
  showPins?: boolean;
  expandStepOptions?: boolean;
  sequencesState: SequenceReducerState;
}

export interface StepState {
  viewRaw?: boolean;
  updateKey?: string;
}