feat: Add HEIC to ImageFormats

Author: mrousavy

README.md

@@ -112,12 +112,22 @@ const image = useImage(require('./image.png'))
 
 #### `ArrayBuffer`
 
-The `Image` type can be converted to- and from- an `ArrayBuffer`, which gives you access to the raw pixel data in ARGB format:
+The `Image` type can be converted to- and from- an `ArrayBuffer`, which gives you access to the raw pixel data in an RGB format:
 
 ```ts
 const image           = // ...
-const arrayBuffer     = await image.toArrayBufferAsync()
-const sameImageCopied = await Images.loadFromArrayBufferAsync(arrayBuffer)
+const pixelData       = await image.toRawPixelData()
+const sameImageCopied = await Images.loadFromRawPixelData(pixelData)
+```
+
+#### `EncodedImageData`
+
+The `Image` type can be encoded to- and decoded from- an `ArrayBuffer` using a container format like `jpg`, `png` or `heic`:
+
+```ts
+const image           = // ...
+const imageData       = await image.toEncodedImageData('jpg', 90)
+const sameImageCopied = await Images.loadFromEncodedImageData(imageData)
 ```
 
 #### Resizing
@@ -143,8 +153,18 @@ const smaller  = await webImage.cropAsync(100, 100, 50, 50)
 An in-memory `Image` object can also be written/saved to a file:
 
 ```ts
-const smaller  = ...
-const path     = await smaller.saveToTemporaryFileAsync('jpg', 90)
+const image  = ...
+const path   = await image.saveToTemporaryFileAsync('jpg', 90)
+```
+
+#### Compressing
+
+Images can be compressed using the `jpg` container format - either in-memory or when writing to a file:
+
+```ts
+const image      = ...
+const path       = await image.saveToTemporaryFileAsync('jpg', 50) // 50% compression
+const compressed = await image.toEncodedImageData('jpg', 50)       // 50% compression
 ```
 
 ### Hooks

packages/react-native-nitro-image/ios/HybridImageFactory.swift

@@ -7,8 +7,19 @@
 
 import Foundation
 import NitroModules
+import UniformTypeIdentifiers
 
 class HybridImageFactory: HybridImageFactorySpec {
+  var supportsHEIC: Bool {
+    if #unavailable(iOS 17.0) {
+      // HEIC .heicData() is only available on iOS 17
+      return false
+    }
+    // Check if the type is supported by the OS
+    let types = CGImageDestinationCopyTypeIdentifiers() as! [String]
+    return types.contains(UTType.heic.identifier)
+  }
+  
   /**
    * Load Image from file path
    */

packages/react-native-nitro-image/ios/ImageFormat+toUTType.swift

@@ -15,6 +15,8 @@ extension ImageFormat {
       return .jpeg
     case .png:
       return .png
+    case .heic:
+      return .heic
     }
   }
 }

packages/react-native-nitro-image/ios/NativeImage.swift

@@ -95,9 +95,7 @@ public extension NativeImage {
   }
 
   private func saveImage(to path: String, format: ImageFormat, quality: Double) throws {
-    guard let data = uiImage.getData(in: format, quality: quality) else {
-      throw RuntimeError.error(withMessage: "Failed to get Image data in format \(format.stringValue) with quality \(quality)!")
-    }
+    let data = try uiImage.getData(in: format, quality: quality)
     guard let url = URL(string: path) else {
       throw RuntimeError.error(withMessage: "The given path \"\(path)\" is not a valid URL!")
     }

packages/react-native-nitro-image/ios/UIImage+getData.swift

@@ -6,14 +6,30 @@
 //
 
 import UIKit
+import NitroModules
 
 extension UIImage {
-  func getData(in format: ImageFormat, quality: CGFloat) -> Data? {
+  func getData(in format: ImageFormat, quality: CGFloat) throws -> Data {
     switch format {
     case .jpg:
-      return self.jpegData(compressionQuality: quality)
+      guard let data = self.jpegData(compressionQuality: quality) else {
+        throw RuntimeError.error(withMessage: "Failed to compress \(size.width)x\(size.height) Image to JPEG! (Quality: \(quality))")
+      }
+      return data
     case .png:
-      return self.pngData()
+      guard let data = self.pngData() else {
+        throw RuntimeError.error(withMessage: "Failed to convert \(size.width)x\(size.height) Image to PNG!")
+      }
+      return data
+    case .heic:
+      guard #available(iOS 17.0, *) else {
+        throw RuntimeError.error(withMessage: "HEIC is only available on iOS 17.0 or higher! " +
+                                 "Check ImageFactory.supportsHEIC before calling this method.")
+      }
+      guard let data = self.heicData() else {
+        throw RuntimeError.error(withMessage: "Failed to convert \(size.width)x\(size.height) Image to HEIC!")
+      }
+      return data
     }
   }
 }

packages/react-native-nitro-image/ios/UIImage+toEncodedImageData.swift

@@ -10,26 +10,11 @@ import CoreGraphics
 import NitroModules
 
 extension UIImage {
-  private func toData(format: ImageFormat, quality: Double = 1.0) throws -> Data {
-    switch format {
-    case .jpg:
-      guard let data = self.jpegData(compressionQuality: quality) else {
-        throw RuntimeError.error(withMessage: "Failed to compress Image into JPEG data!")
-      }
-      return data
-    case .png:
-      guard let data = self.pngData() else {
-        throw RuntimeError.error(withMessage: "Failed to convert Image to PNG data!")
-      }
-      return data
-    }
-  }
-  
   /**
    * Returns encoded Image data of this Image (JPG, PNG, ...)
    */
   func toEncodedImageData(format: ImageFormat, quality: Double = 1.0) throws -> EncodedImageData {
-    let data = try toData(format: format, quality: quality)
+    let data = try getData(in: format, quality: quality)
     let arrayBuffer = try ArrayBuffer.copy(data: data)
     return EncodedImageData(buffer: arrayBuffer,
                             width: self.size.width,