/*
 * 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 { ComponentClass } from 'react'

/**
 * ---
 * category: utilities/utils
 * ---
 * DEPRECATED This is an old TypeScript style decorator and will be removed
 * in the future.
 *
 * Wraps (decorates) a React component to add additional functionality
 *
 * @module decorator
 * @param {Function} decorate a function that returns a decorated component
 * @returns {Class} A decorated component class
 */
function decorator(
  decorate: (toDecorate: ComponentClass<any>, ...args: any[]) => any
) {
  return (...args: unknown[]) => {
    // parameters when the decorator is used
    return (ComposedComponent: ComponentClass<any>) => {
      if (typeof decorate === 'function') {
        const displayName =
          ComposedComponent.displayName || ComposedComponent.name
        const DecoratedComponent = decorate(ComposedComponent, ...args)
        DecoratedComponent.displayName = displayName
        return DecoratedComponent
      } else {
        return ComposedComponent
      }
    }
  }
}
export default decorator
export { decorator }