/*

 MIT License

 Copyright (c) 2022 Looker Data Sciences, 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.

 */

// Much of the following is pulled from https://github.com/reach/reach-ui
// because their work is fantastic (but is not in TypeScript)

import { useRef, useEffect } from 'react'
import type {
  ComboboxCallback,
  MaybeComboboxOptionObject,
  ComboboxOptionType,
} from '../types'
import { ComboboxState } from '../utils/state'

const visibleStates = [
  ComboboxState.SUGGESTING,
  ComboboxState.NAVIGATING,
  ComboboxState.INTERACTING,
]
export const getIsVisible = (state: ComboboxState) =>
  visibleStates.includes(state)

// Detect when to call onOpen and onClose
export function useComboboxToggle<
  TOption extends ComboboxOptionType = MaybeComboboxOptionObject
>(
  state: ComboboxState,
  option: TOption,
  onOpen?: ComboboxCallback<TOption>,
  onClose?: ComboboxCallback<TOption>
) {
  const isVisible = getIsVisible(state)
  const isVisibleRef = useRef(isVisible)

  useEffect(() => {
    if (isVisible && !isVisibleRef.current) {
      onOpen && onOpen(option)
      isVisibleRef.current = true
    } else if (!isVisible && isVisibleRef.current) {
      onClose && onClose(option)
      isVisibleRef.current = false
    }
  }, [isVisible, isVisibleRef, onOpen, onClose, option])

  return isVisible
}
