/*
 * 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 { WithStyleProps } from '@instructure/emotion'
import type { OtherHTMLAttributes } from '@instructure/shared-types'
import type { NewComponentTypes } from '@instructure/ui-themes'

import type { ActionItemsChild } from '../TopNavBarActionItems/props'
import type { BrandChild } from '../TopNavBarBrand/props'
import type { MenuItemsChild } from '../TopNavBarMenuItems/props'
import type { UserChild } from '../TopNavBarUser/props'
import type { BreadcrumbChild } from '../TopNavBarBreadcrumb/props'

import { TopNavBarLayout } from './index'
import type { DesktopLayoutOwnProps } from './DesktopLayout/props'
import type { SmallViewportLayoutOwnProps } from './SmallViewportLayout/props'

type LayoutChild = React.ComponentElement<TopNavBarLayoutProps, TopNavBarLayout>

type CommonTopNavBarLayoutProps = {
  /**
   * Displays the app/product/brand/company/etc. name and/or logo.
   *
   * Accepts a `<TopNavBar.Brand>` component.
   */
  renderBrand?: BrandChild

  /**
   * Displays the main navbar items.
   *
   * In __desktop__ mode the items are listed on the navbar,
   * in __smallViewport__ mode the items are accessible under the main "hamburger" menu.
   *
   * Accepts a `<TopNavBar.MenuItems>` component.
   */
  renderMenuItems?: MenuItemsChild

  /**
   * Displays the action items, icons, buttons, etc.
   *
   * Renders in the top right corner of the navbar in both __desktop__ and __smallViewport__ mode.
   *
   * Accepts a `<TopNavBar.ActionItems>` component.
   */
  renderActionItems?: ActionItemsChild

  /**
   * Displays the user menu.
   *
   * In __desktop__ mode it renders in the top right corner of the navbar,
   * in __smallViewport__ mode it is rendered under the main "hamburger" menu, above the menu items.
   *
   * Accepts a `<TopNavBar.User>` component.
   */
  renderUser?: UserChild

  /**
   * Displays a hamburger icon with a breadcrumb.
   *
   * In __desktop__ mode it renders in the top left corner of the navbar.
   * In __smallViewport__ mode it renders a link of the last but one crumb with a chevron icon.
   *
   * Accepts a `<TopNavBar.Breadcrumb>` component.
   */
  renderBreadcrumb?: BreadcrumbChild

  /**
   * The 'aria-label' for the underlying `<nav>` element
   */
  navLabel?: string

  /**
   * A function that returns a reference to root HTML element
   */
  elementRef?: (el: HTMLElement | null) => void
}

type TopNavBarLayoutOwnProps = CommonTopNavBarLayoutProps & {
  /**
   * Config object for the "small viewport" mode:
   */
  smallViewportConfig: SmallViewportLayoutOwnProps
}

type CommonPropKeys = keyof CommonTopNavBarLayoutProps
type PropKeys = keyof TopNavBarLayoutOwnProps
type DesktopPropKeys = keyof DesktopLayoutOwnProps
type SmallViewportPropKeys = keyof SmallViewportLayoutOwnProps

type CommonAllowedPropKeys = Readonly<Array<CommonPropKeys>>
type DesktopAllowedPropKeys = Readonly<Array<DesktopPropKeys>>
type SmallViewportAllowedPropKeys = Readonly<Array<SmallViewportPropKeys>>
type AllowedPropKeys = Readonly<Array<PropKeys>>

type TopNavBarLayoutProps = TopNavBarLayoutOwnProps &
  WithStyleProps<ReturnType<NewComponentTypes['TopNavBarLayout']>, null> &
  OtherHTMLAttributes<TopNavBarLayoutOwnProps>

const commonAllowedProps: CommonAllowedPropKeys = [
  'renderBrand',
  'renderMenuItems',
  'renderActionItems',
  'renderUser',
  'renderBreadcrumb',
  'navLabel',
  'elementRef'
]

const desktopAllowedProps: DesktopAllowedPropKeys = []

const smallViewportAllowedProps: SmallViewportAllowedPropKeys = [
  'dropdownMenuToggleButtonLabel',
  'dropdownMenuToggleButtonTooltip',
  'dropdownMenuLabel',
  'alternativeTitle',
  'renderInPlaceDialogConfig',
  'trayMountNode',
  'onDropdownMenuToggle',
  'onDropdownMenuSelect'
]

const allowedProps: AllowedPropKeys = [
  ...commonAllowedProps,
  'smallViewportConfig'
]

export type { LayoutChild, CommonTopNavBarLayoutProps, TopNavBarLayoutProps }
export {
  allowedProps,
  commonAllowedProps,
  desktopAllowedProps,
  smallViewportAllowedProps
}