/*
 * 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 { RectType } from '@instructure/ui-dom-utils'
import { UIElement } from '@instructure/shared-types'

const placementPropValues = [
  'top',
  'bottom',
  'start',
  'end',
  'top start',
  'top center',
  'top end',
  'top stretch',
  'bottom start',
  'bottom center',
  'bottom end',
  'bottom stretch',
  'start top',
  'start center',
  'start bottom',
  'start stretch',
  'end top',
  'end center',
  'end bottom',
  'end stretch',
  'center start',
  'center end',
  'offscreen'
]

/**
 * The placement of the content in relation to the trigger
 */
export type PlacementPropValues =
  | 'top'
  | 'bottom'
  | 'start'
  | 'end'
  | 'top start'
  | 'top center'
  | 'top end'
  | 'top stretch'
  | 'bottom start'
  | 'bottom center'
  | 'bottom end'
  | 'bottom stretch'
  | 'start top'
  | 'start center'
  | 'start bottom'
  | 'start stretch'
  | 'end top'
  | 'end center'
  | 'end bottom'
  | 'end stretch'
  | 'center start'
  | 'center end'
  | 'offscreen'
// TODO: merge with PropTypes once react-docgen can parse `typeof array[number]`

/**
 * An element or a function returning an element to use as the mount node
 */
export type PositionMountNode = Element | (() => Element | null) | null

/**
 * The parent in which to constrain a placement
 */
export type PositionConstraint =
  | PositionMountNode
  | 'window'
  | 'scroll-parent'
  | 'parent'
  | 'none'
// TODO: merge with PropTypes once react-docgen can parse `typeof array[number]`

export type PlacementValues =
  | 'top'
  | 'start'
  | 'end'
  | 'bottom'
  | 'center'
  | 'stretch'
  | 'offscreen'

const mirrorMap: Record<PlacementValues, PlacementValues> = {
  center: 'center',
  start: 'end',
  end: 'start',
  top: 'bottom',
  bottom: 'top',
  stretch: 'stretch',
  offscreen: 'offscreen'
}

export type PlacementValueArray = [PlacementValues, PlacementValues]

export type PlacementStringValues =
  | PlacementValues
  | `${PlacementValues} ${PlacementValues}`

export type ElementPosition = {
  placement?: PlacementPropValues
  style: {
    top?: 0
    left?: '-9999em' | 0
    overflow?: 'hidden'
    position?: 'absolute'
    display?: 'none' | null
    minWidth?: number | null
    minHeight?: number | null
    transform?: string
  }
}

export type PositionElement = UIElement

export type Offset<Type extends number | string | undefined = number> = {
  top: Type
  left: Type
}

export type Size = Pick<RectType, 'width' | 'height'>
export type Overflow = Pick<RectType, 'top' | 'bottom' | 'left' | 'right'>

export { placementPropValues, mirrorMap }