/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
 * Modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import React, { FunctionComponent, HTMLAttributes } from 'react';
import { CommonProps } from '../common';
import classNames from 'classnames';

import { OuiStepProps, OuiStep } from './step';

export type OuiContainedStepProps = Omit<OuiStepProps, 'step'>;

export interface OuiStepsProps
  extends CommonProps,
    HTMLAttributes<HTMLDivElement> {
  /**
   * An array of `OuiStep` objects excluding the `step` prop
   */
  steps: OuiContainedStepProps[];
  /**
   * The number the steps should begin from
   */
  firstStepNumber?: number;
  /**
   * The HTML tag used for the title
   */
  headingElement?: string;
  /**
   * Title sizing equivalent to OuiTitle, but only `m`, `s` and `xs`. Defaults to `s`
   */
  titleSize?: OuiStepProps['titleSize'];
}

function renderSteps(
  steps: OuiContainedStepProps[],
  firstStepNumber: number,
  headingElement: string,
  titleSize?: OuiStepProps['titleSize']
) {
  return steps.map((step, index) => {
    const { className, children, title, status, ...rest } = step;

    return (
      <OuiStep
        className={className}
        key={index}
        headingElement={headingElement}
        step={firstStepNumber + index}
        title={title}
        titleSize={titleSize}
        status={status}
        {...rest}>
        {children}
      </OuiStep>
    );
  });
}

export const OuiSteps: FunctionComponent<OuiStepsProps> = ({
  className,
  firstStepNumber = 1,
  headingElement = 'p',
  titleSize,
  steps,
  ...rest
}) => {
  const classes = classNames('ouiSteps', className);

  return (
    <div className={classes} {...rest}>
      {renderSteps(steps, firstStepNumber, headingElement, titleSize)}
    </div>
  );
};