/*
 * 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 type { Spacing } from '@instructure/emotion'
import type { UIElement } from '@instructure/shared-types'

import type { PagesContextType } from '../PagesContext'

type PagesPageOwnProps = {
  /**
   * The children to be rendered
   */
  children?:
    | React.ReactNode
    | ((
        history: PagesContextType['history'],
        navigateToPreviousPage: PagesContextType['navigateToPreviousPage']
      ) => React.ReactNode)

  /**
   * An element or a function returning an element to focus by default
   */
  defaultFocusElement?: UIElement | (() => UIElement)

  /**
   * Set the padding using familiar CSS shorthand
   */
  padding?: Spacing

  textAlign?: 'start' | 'center' | 'end'
}
type PropKeys = keyof PagesPageOwnProps

type AllowedPropKeys = Readonly<Array<PropKeys>>

type PagesPageProps = PagesPageOwnProps
const allowedProps: AllowedPropKeys = [
  'children',
  'defaultFocusElement',
  'padding',
  'textAlign'
]

export type { PagesPageProps }
export { allowedProps }