/*
 * 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 { findDOMNode } from './findDOMNode'
import { getBoundingClientRect } from './getBoundingClientRect'
import {
  requestAnimationFrame,
  RequestAnimationFrameType
} from './requestAnimationFrame'
import { UIElement } from '@instructure/shared-types'

type PositionChangeListenerType = { remove: () => void }

/**
 * ---
 * category: utilities/DOM
 * ---
 * Adds a listener to an element and calls a specified handler
 * function whenever the position changes
 * @module
 * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node
 * @param {function} handler - function to run if the position has changed
 * @returns {function} remove - cancel the listener and no longer execute the handler function
 */
function addPositionChangeListener(
  el?: UIElement,
  handler?: (...args: any[]) => any
): PositionChangeListenerType {
  const node = findDOMNode(el)
  const raf: RequestAnimationFrameType[] = []

  let coords = getBoundingClientRect(node) || {}
  let cancelled = false

  function checkPosition() {
    if (!cancelled) {
      const newCoords = getBoundingClientRect(node) || {}
      const positionChanged =
        newCoords.top !== coords.top ||
        newCoords.left !== coords.left ||
        newCoords.right !== coords.right ||
        newCoords.bottom !== coords.bottom ||
        newCoords.width !== coords.width ||
        newCoords.height !== coords.height

      if (positionChanged && typeof handler === 'function') {
        handler(newCoords)
      }

      coords = newCoords

      raf.push(requestAnimationFrame(checkPosition))
    }
  }

  checkPosition()

  return {
    remove() {
      cancelled = true
      raf.forEach((req) => req.cancel())
    }
  }
}

export default addPositionChangeListener
export { addPositionChangeListener }
export type { PositionChangeListenerType }