import type { HybridObject } from 'react-native-nitro-modules'
import type { EncodedImageData, Image, RawPixelData } from './Image.nitro'

/**
 * Represents a Color in an {@linkcode Image}.
 * - {@linkcode r}: The Red channel, ranging from 0.0 to 1.0.
 * - {@linkcode g}: The Green channel, ranging from 0.0 to 1.0.
 * - {@linkcode b}: The Blue channel, ranging from 0.0 to 1.0.
 * - {@linkcode a}: The Alpha channel, ranging from 0.0 to 1.0.
 * If the {@linkcode Image} has no alpha channel, this value is ignored.
 */
export interface Color {
  r: number
  g: number
  b: number
  a?: number
}

export interface ImageFactory
  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
  /**
   * Synchronously creates a new blank {@linkcode Image} of the given size.
   * @param width The width of the new Image
   * @param height The height of the new Image
   * @param enableAlpha Whether to add an alpha channel for transparency
   * @param fill If set, fill the whole image with the given color
   */
  createBlankImage(
    width: number,
    height: number,
    enableAlpha: boolean,
    fill?: Color,
  ): Image
  /**
   * Asynchronously creates a new blank {@linkcode Image} of the given size.
   * @param width The width of the new Image
   * @param height The height of the new Image
   * @param enableAlpha Whether to add an alpha channel for transparency
   * @param fill If set, fill the whole image with the given color
   */
  createBlankImageAsync(
    width: number,
    height: number,
    enableAlpha: boolean,
    fill?: Color,
  ): Promise<Image>

  /**
   * Synchronously loads an {@linkcode Image} from the given {@linkcode filePath}.
   * @param filePath The filesystem path of the {@linkcode Image}, including its file extension. This is not a URL, so don't pass a `file://` prefix.
   * @throws If the {@linkcode filePath} is invalid.
   * @throws If the data at the given {@linkcode filePath} cannot be parsed as an {@linkcode Image}.
   */
  loadFromFile(filePath: string): Image
  /**
   * Asynchronously loads an {@linkcode Image} from the given {@linkcode filePath}.
   * @param filePath The filesystem path of the {@linkcode Image}, including its file extension. This is not a URL, so don't pass a `file://` prefix.
   * @throws If the {@linkcode filePath} is invalid.
   * @throws If the data at the given {@linkcode filePath} cannot be parsed as an {@linkcode Image}.
   */
  loadFromFileAsync(filePath: string): Promise<Image>

  /**
   * Synchronously loads an {@linkcode Image} from the given resource-/system-name.
   * @param name The resource-/system-name of the image to load.
   * @throws If no {@linkcode Image} exists under the given {@linkcode name}.
   * @throws If the file under the given {@linkcode name} cannot be parsed as an {@linkcode Image}.
   */
  loadFromResources(name: string): Image
  /**
   * Asynchronously loads an {@linkcode Image} from the given resource-/system-name.
   * @param name The resource-/system-name of the image to load.
   * @throws If no {@linkcode Image} exists under the given {@linkcode name}.
   * @throws If the file under the given {@linkcode name} cannot be parsed as an {@linkcode Image}.
   */
  loadFromResourcesAsync(name: string): Promise<Image>

  /**
   * Synchronously loads an {@linkcode Image} from the given symbol name.
   * This is iOS only!
   * @param symbolName The symbol name of the image to load. On iOS, this is the SF Symbols Name.
   * @throws If no {@linkcode Image} symbol exists under the given {@linkcode symbolName}.
   * @platform iOS 13
   */
  loadFromSymbol(symbolName: string): Image

  /**
   * Synchronously loads an {@linkcode Image} from the given {@linkcode RawPixelData}'s {@linkcode ArrayBuffer}.
   * @param data The {@linkcode RawPixelData} object carrying the **raw** RGB image data and describing it's format.
   * @param allowGpu If `allowGpu` is set to `true` and the given {@linkcode data} is a GPU-buffer, the {@linkcode Image}
   * might be wrapping the given GPU-buffer without performing a copy. By default, `allowGpu` is `false`
   * @throws If the given {@linkcode RawPixelData} is not a valid RGB buffer representing an {@linkcode Image}.
   * @note The given pixel data has to have pre-multiplied alpha, and be some kind of RGB format with 4-bytes-per-pixel.
   */
  loadFromRawPixelData(data: RawPixelData, allowGpu?: boolean): Image
  /**
   * Asynchronously loads an {@linkcode Image} from the given {@linkcode RawPixelData}'s {@linkcode ArrayBuffer}.
   * @param data The {@linkcode RawPixelData} object carrying the **raw** RGB image data and describing it's format.
   * @param allowGpu If `allowGpu` is set to `true` and the given {@linkcode data} is a GPU-buffer, the {@linkcode Image}
   * might be wrapping the given GPU-buffer without performing a copy. By default, `allowGpu` is `false`
   * @throws If the given {@linkcode RawPixelData} is not a valid RGB buffer representing an {@linkcode Image}.
   * @note The given pixel data has to have pre-multiplied alpha, and be some kind of RGB format with 4-bytes-per-pixel.
   */
  loadFromRawPixelDataAsync(
    data: RawPixelData,
    allowGpu?: boolean,
  ): Promise<Image>

  /**
   * Synchronously loads an {@linkcode Image} from the given {@linkcode EncodedImageData}'s {@linkcode ArrayBuffer}.
   * @param buffer The ArrayBuffer carrying the encoded Image data in any supported image format (JPG, PNG, ...)
   * @throws If the given {@linkcode EncodedImageData} is not a valid representation of an {@linkcode Image}.
   */
  loadFromEncodedImageData(data: EncodedImageData): Image
  /**
   * Asynchronously loads an {@linkcode Image} from the given {@linkcode EncodedImageData}'s {@linkcode ArrayBuffer}.
   * @param buffer The ArrayBuffer carrying the encoded Image data in any supported image format (JPG, PNG, ...)
   * @throws If the given {@linkcode EncodedImageData} is not a valid representation of an {@linkcode Image}.
   */
  loadFromEncodedImageDataAsync(data: EncodedImageData): Promise<Image>

  /**
   * Synchronously decodes the given {@linkcode thumbhash} (and {@linkcode ArrayBuffer})
   * into an {@linkcode Image}.
   * @param buffer The ArrayBuffer carrying the ThumbHash's data
   * @throws If the given {@linkcode thumbhash} is not a valid ThumbHash.
   */
  loadFromThumbHash(thumbhash: ArrayBuffer): Image
  loadFromThumbHashAsync(thumbhash: ArrayBuffer): Promise<Image>
}