types.ts

export type Handler = (() => Promise<void>) | (() => void) | null;

export type WizardProps = {
  /** Optional header that is shown above the active step */
  header?: React.ReactNode;
  /** Optional sidebar that is shown before the active step */
  sidebar?: React.ReactNode;
  /** Optional footer that is shown below the active step */
  footer?: React.ReactNode;
  /** Optional start index @default 0 */
  startIndex?: number;
  /**
   * Optional wrapper that is exclusively wrapped around the active step component. It is not wrapped around the `header`, `sidebar` and `footer`
   * @example With `framer-motion` - `<AnimatePresence />`
   * ```jsx
   * <Wizard wrapper={<AnimatePresence exitBeforeEnter />}>
   * ...
   * </Wizard>
   * ```
   */
  wrapper?: React.ReactElement;
  /**
   * Optional wrapper that is exclusively wrapped around the sidebar and active step component. It is not wrapped around the `header` and `footer`
   * @example With `framer-motion` - `<AnimatePresence />`
   * ```jsx
   * <Wizard wrapper={<AnimatePresence exitBeforeEnter />}>
   * ...
   * </Wizard>
   * ```
   */
  sidebarAndStepWrapper?: React.ReactElement;
  /** Callback that will be invoked with the new step index when the wizard changes steps */
  onStepChange?: (stepIndex: number) => void;
};

export interface BaseWizardStep {
  /** The step number */
  number?: number;
  /** The step name */
  name?: string;
}

export type WizardValues = {
  /**
   * Go to the next step
   */
  nextStep: () => Promise<void>;
  /**
   * Go to the previous step
   */
  previousStep: () => void;
  /**
   * Go to the given step index
   * @param stepIndex The step index, starts at 0
   */
  goToStep: (stepIndex: number) => void;
  /**
   * Attach a callback that will be called when calling `nextStep()`
   * @param handler Can be either sync or async
   */
  handleStep: (handler: Handler) => void;
  /**
   * Indicate the current state of the handler
   *
   * Will reflect the handler promise state: will be `true` if the handler promise is pending and
   * `false` when the handler is either fulfilled or rejected
   */
  isLoading: boolean;
  /** The current active step of the wizard */
  activeStep: number;
  /** The total number of steps of the wizard */
  stepCount: number;
  /** Indicate if the current step is the first step (aka no previous step) */
  isFirstStep: boolean;
  /** Indicate if the current step is the last step (aka no next step) */
  isLastStep: boolean;
  /** The labels of each step */
  steps: BaseWizardStep[];
};

/** Console log levels */
export type LogLevel = 'info' | 'error' | 'warn';