/*
 * 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 type {
  FormFieldMessagesTheme,
  OtherHTMLAttributes
} from '@instructure/shared-types'
import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
import type { FormMessage } from '../../utils/v1/FormPropTypes'

type FormFieldMessagesOwnProps = {
  /**
   * Array of objects with shape: `{
   *   text: React.ReactNode,
   *   type: One of: ['newError', 'error', 'hint', 'success', 'screenreader-only']
   * }`
   */
  messages?: FormMessage[]
  /**
   * Specifies the size and location if inside a CSS grid, see
   * https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area
   */
  gridArea?: string
}

type PropKeys = keyof FormFieldMessagesOwnProps

type AllowedPropKeys = Readonly<Array<PropKeys>>

type FormFieldMessagesProps = FormFieldMessagesOwnProps &
  WithStyleProps<FormFieldMessagesTheme, FormFieldMessagesStyle> &
  OtherHTMLAttributes<FormFieldMessagesOwnProps>

type FormFieldMessagesStyle = ComponentStyle<'formFieldMessages' | 'message'>
const allowedProps: AllowedPropKeys = ['messages', 'gridArea']

export type { FormFieldMessagesProps, FormFieldMessagesStyle }
export { allowedProps }