/*
 * 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 React from 'react'
import PropTypes from 'prop-types'

import type {
  OtherHTMLAttributes,
  PickPropsWithExceptions,
  PropValidators
} from '@instructure/shared-types'
import type { BaseButtonProps } from '@instructure/ui-buttons'

type PaginationPageOwnProps = {
  /**
   * Content to render as page selection
   */
  children: React.ReactNode
  /**
   * Whether the page is currently displayed
   */
  current?: boolean
  /**
   * Callback fired when the `Pagination.Page` is clicked.
   */
  onClick?: (
    event:
      | React.KeyboardEvent<HTMLInputElement>
      | React.MouseEvent<HTMLButtonElement>
      | React.FocusEvent<HTMLInputElement>
  ) => void
  /**
   * The text screenreaders should say when this button is in focus (sets the
   * `aria-label` attribute).
   * If left undefined (default) SRs will announce text in the child node(s).
   */
  screenReaderLabel?: string
}

type PropKeys = keyof PaginationPageOwnProps

type AllowedPropKeys = Readonly<Array<PropKeys>>

type PaginationPageProps =
  // We pass almost all props to BaseButton
  PickPropsWithExceptions<BaseButtonProps, 'aria-current' | 'elementRef'> &
    PaginationPageOwnProps &
    OtherHTMLAttributes<PaginationPageOwnProps>

const propTypes: PropValidators<PropKeys> = {
  children: PropTypes.node.isRequired,
  current: PropTypes.bool,
  onClick: PropTypes.func,
  screenReaderLabel: PropTypes.string
}

const allowedProps: AllowedPropKeys = [
  'children',
  'current',
  'screenReaderLabel'
  // we don't want to pass onClick
  // 'onClick'
]

export type { PaginationPageProps }
export { propTypes, allowedProps }