import {RemoteRoot, RemoteComponentType} from '@remote-ui/core';

/**
 * A type of extension point that can render UI into Checkout
 * natively. This type of extension point receives an object to manipulate
 * the UI as its first argument, and additional data and methods as a second
 * argument. The object that can manipulate the UI is called a `RemoteRoot`,
 * and is provided by the [remote-ui library](https://github.com/Shopify/remote-ui/tree/main/packages/core)
 * on which the UI Extension rendering capabilities are built.
 */
export interface RenderExtension<
  Input,
  AllowedComponents extends RemoteComponentType<string, any, any>,
> {
  /**
   * An extension callback that receives a root and an API object.
   */
  (
    root: RemoteRoot<AllowedComponents, true>,
    input: Input,
  ): void | Promise<void>;
}