/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 - present Instructure, Inc.
 *
 * 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 PropTypes from 'prop-types'

import type {
  AsElementType,
  OtherHTMLAttributes,
  PropValidators
} from '@instructure/shared-types'

type AccessibleContentOwnProps = {
  /**
   * The text that screenreaders will read. Will not be visible.
   */
  alt?: string

  /**
   * the element type to render the screen reader content as
   */
  as: AsElementType
  /**
   * Content that will be hidden from screenreaders (via `aria-hidden` set to `true`)
   */
  children?: React.ReactNode
}

type PropKeys = keyof AccessibleContentOwnProps

type AllowedPropKeys = Readonly<Array<PropKeys>>

type AccessibleContentProps = AccessibleContentOwnProps &
  OtherHTMLAttributes<AccessibleContentOwnProps>

const propTypes: PropValidators<PropKeys> = {
  alt: PropTypes.string,
  as: PropTypes.elementType,
  children: PropTypes.node
}

const allowedProps: AllowedPropKeys = ['alt', 'as', 'children']

export type { AccessibleContentProps }
export { propTypes, allowedProps }