heic-to 1.2.2 → 1.3.0

package/README.md

@@ -8,6 +8,7 @@ Currently, heic-to is using [libheif 1.20.2](https://github.com/strukturag/libhe
 
 | Release  | libheif  |
 | -------- | -------- |
+| 1.3.0    | 1.20.2   | 
 | 1.2.2    | 1.20.2   | 
 | 1.2.1    | 1.20.1   | 
 | 1.2.0    | 1.20.0   | 
@@ -47,7 +48,7 @@ const file = field.files[0]
 await isHeic(file)
 ```
 
-#### Convert HEIC to JPEG/PNG
+#### Convert HEIC to JPEG/PNG/Bitmap
 
 
 ```js
@@ -66,6 +67,14 @@ const png = await heicTo({
   type: "image/png",
   quality: 0.5
 })
+
+const bitmap = await heicTo({
+  blob: file,
+  type: "bitmap",
+  options: {
+    imageOrientation: "flipY"
+  }
+})
 ```
 
 #### Cotent Security Policy
@@ -88,7 +97,7 @@ Fix it by using `csp/heic-to`
 If you would like to access heic-to with pure JavaScript without package builder like with CDN.
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/heic-to@1.2.2/dist/iife/heic-to.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/heic-to@1.3.0/dist/iife/heic-to.js"></script>
 <script>
   /*...*/
   if (await HeicTo.isHeic(file)) {

package/dist/csp/heic-to.d.ts

@@ -5,29 +5,44 @@
  */
 export declare function isHeic(file: File): Promise<boolean>;
 
+type ImageMime = `${"image"}/${string}`; // e.g. "image/jpeg", "image/png", "image/webp"
+type HeicTarget = "bitmap" | ImageMime;
+
 /**
- * Options for converting HEIC images.
+ * Converts a HEIC image to another format.
+ * @param args - The conversion options.
+ * @returns A promise that resolves to the converted image bitmap.
  */
-export interface HeicToOptions {
+export function heicTo(args: {
   /**
    * The HEIC image blob to convert.
    */
   blob: Blob;
-
+  type: "bitmap";
   /**
-   * The desired output image MIME type (e.g., 'image/jpeg', 'image/png').
+   * Options for creating the ImageBitmap.
    */
-  type: string;
-
-  /**
-   * The quality of the output image, between 0 and 1.
-   */
-  quality?: number;
-}
+  options?: ImageBitmapOptions;
+  quality?: never;
+}): Promise<ImageBitmap>;
 
 /**
  * Converts a HEIC image to another format.
- * @param options - The conversion options.
+ * @param args - The conversion options.
  * @returns A promise that resolves to the converted image blob.
  */
-export declare function heicTo(options: HeicToOptions): Promise<Blob>;
+export function heicTo<M extends Exclude<HeicTarget, "bitmap">>(args: {
+  /**
+   * The HEIC image blob to convert.
+   */
+  blob: Blob;
+  /**
+   * The desired output image MIME type (e.g., 'image/jpeg', 'image/png').
+   */
+  type: M;
+  /**
+   * The quality of the output image, between 0 and 1.
+   */
+  quality?: number;        // 0..1 for JPEG/WEBP, ignored by PNG
+  options?: never;
+}): Promise<Blob>;