/**
 * MIT License
 *
 * Copyright (c) 2020-present, Elastic NV
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

import { Location, StatusValue, VoidCallback } from '../common_types';

export class Step {
  readonly name: string;
  readonly index: number;
  readonly location?: Location;
  #cb: VoidCallback;
  skip = false;
  soft = false;
  only = false;
  _startTime = 0;
  duration = -1;
  status: StatusValue = 'pending';
  error?: Error;
  url?: string;

  constructor(
    name: string,
    index: number,
    cb: VoidCallback,
    location: Location
  ) {
    this.name = name;
    this.index = index;
    this.#cb = cb;
    this.location = location;
  }

  get cb() {
    return this.#cb;
  }

  /**
   * @deprecated Since version 1.17.0. Please do not rely on the internal methods.
   * Alias cb for backwards compatibility
   */
  get callback() {
    return this.#cb;
  }
}

type StepType = (name: string, callback: VoidCallback) => Step;

export type StepWithAnnotations = StepType & {
  /**
   * Skip this step on the journey
   */
  skip: StepType;
  /**
   * Failure of soft step will not skip rest of the steps in the journey
   */
  soft: StepType;
  /**
   * Run only this step and skip rest of the steps in the journey
   */
  only: StepType;
};