@metools/web-image-converter 1.0.7 → 2.0.0-beta.0

package/dist/index.d.ts

@@ -35,53 +35,56 @@ interface CropDimensionOptions {
     height: number;
 }
 interface CropAspectRatioOptions {
+    ratioWidth: number;
+    ratioHeight: number;
+}
+interface CropEachSideOptions {
+    cropLeft: number;
+    cropRight: number;
+    cropTop: number;
+    cropBottom: number;
+}
+interface CropDimensionRustInput {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface CropAspectRatioRustInput {
     ratio_width: number;
     ratio_height: number;
 }
-interface CropEachSideOptions {
+interface CropEachSideRustInput {
     crop_left: number;
     crop_right: number;
     crop_top: number;
     crop_bottom: number;
 }
-type CropOptions = CropDimensionOptions | CropAspectRatioOptions | CropEachSideOptions;
+type CropRustInput = CropDimensionRustInput | CropAspectRatioRustInput | CropEachSideRustInput;
 declare abstract class ImageCropOptions {
-    abstract get optionExport(): CropOptions;
+    abstract get optionExport(): CropRustInput;
 }
 declare class ImageCropDimensionOptions extends ImageCropOptions {
     x: number;
     y: number;
     width: number;
     height: number;
-    constructor(payload: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    });
-    get optionExport(): CropDimensionOptions;
+    constructor(payload: CropDimensionOptions);
+    get optionExport(): CropDimensionRustInput;
 }
 declare class ImageCropAspectRatioOptions extends ImageCropOptions {
-    ratio_width: number;
-    ratio_height: number;
-    constructor(payload: {
-        ratio_width: number;
-        ratio_height: number;
-    });
-    get optionExport(): CropAspectRatioOptions;
+    ratioWidth: number;
+    ratioHeight: number;
+    constructor(payload: CropAspectRatioOptions);
+    get optionExport(): CropAspectRatioRustInput;
 }
 declare class ImageCropEachSideOptions extends ImageCropOptions {
-    crop_left: number;
-    crop_right: number;
-    crop_top: number;
-    crop_bottom: number;
-    constructor(payload: {
-        crop_left: number;
-        crop_right: number;
-        crop_top: number;
-        crop_bottom: number;
-    });
-    get optionExport(): CropEachSideOptions;
+    cropLeft: number;
+    cropRight: number;
+    cropTop: number;
+    cropBottom: number;
+    constructor(payload: CropEachSideOptions);
+    get optionExport(): CropEachSideRustInput;
 }
 
 interface ResizeDimensionOptions {
@@ -89,70 +92,89 @@ interface ResizeDimensionOptions {
     height: number;
 }
 interface ResizeAspectRatioOptions {
+    ratioWidth: number;
+    ratioHeight: number;
+}
+interface ResizeLongestSideOptions {
+    longestSide: number;
+}
+interface ResizeDimensionsRustInput {
+    width: number;
+    height: number;
+}
+interface ResizeAspectRatioRustInput {
     ratio_width: number;
     ratio_height: number;
 }
-interface ResizeLongestSideOptions {
+interface ResizeLongestSideRustInput {
     longest_side: number;
 }
-type ResizeOptions = ResizeDimensionOptions | ResizeAspectRatioOptions | ResizeLongestSideOptions;
+type ResizeRustOptions = ResizeDimensionsRustInput | ResizeAspectRatioRustInput | ResizeLongestSideRustInput;
 declare abstract class ImpageResizeOptions {
-    abstract get optionExport(): ResizeOptions;
+    abstract get optionExport(): ResizeRustOptions;
 }
 declare class ImageResizeDimensionOptions extends ImpageResizeOptions {
     width: number;
     height: number;
-    constructor(payload: {
-        width: number;
-        height: number;
-    });
-    get optionExport(): ResizeDimensionOptions;
+    constructor(payload: ResizeDimensionOptions);
+    get optionExport(): ResizeDimensionsRustInput;
 }
 declare class ImageResizeAspectRatioOptions extends ImpageResizeOptions {
-    ratio_width: number;
-    ratio_height: number;
-    constructor(payload: {
-        ratio_width: number;
-        ratio_height: number;
-    });
-    get optionExport(): ResizeAspectRatioOptions;
+    ratioWidth: number;
+    ratioHeight: number;
+    constructor(payload: ResizeAspectRatioOptions);
+    get optionExport(): ResizeAspectRatioRustInput;
 }
 declare class ImageResizeLongestSideOptions extends ImpageResizeOptions {
-    longest_side: number;
-    constructor(payload: {
-        longest_side: number;
-    });
-    get optionExport(): ResizeLongestSideOptions;
+    longestSide: number;
+    constructor(payload: ResizeLongestSideOptions);
+    get optionExport(): ResizeLongestSideRustInput;
 }
 
 interface ImageConverterInput {
     compression?: ImageCompressionOptions;
     resize?: ImpageResizeOptions;
     crop?: ImageCropOptions;
+    stripExif?: boolean;
+}
+interface ImageConversionInstanceOptions {
+    exifData?: Uint8Array;
 }
 declare abstract class AbstractImageConverter {
     compression?: ImageCompressionOptions;
     resize?: ImpageResizeOptions;
     crop?: ImageCropOptions;
+    stripExif?: boolean;
     constructor(payload: ImageConverterInput);
-    get options(): Record<string, unknown>;
-    abstract convertImageBytes(bytes: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Get the options to pass to the image processing function.
+     */
+    get options(): ImageConverterInput;
+    abstract convertImageBytes(bytes: Uint8Array, options?: ImageConversionInstanceOptions): Promise<Uint8Array>;
 }
 
 declare class ImageConverter extends AbstractImageConverter {
     constructor(payload: ImageConverterInput);
-    convertImageFile(file: File): Promise<Uint8Array<ArrayBufferLike>>;
-    convertImageBytes(bytes: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>;
+    convertImageFile(file: File, options?: ImageConversionInstanceOptions): Promise<Uint8Array<ArrayBufferLike>>;
+    convertImageBytes(bytes: Uint8Array, options?: ImageConversionInstanceOptions): Promise<Uint8Array<ArrayBufferLike>>;
 }
 
 declare function getJpegConverter(payload?: {
     quality?: number;
-    longest_side?: number;
+    longestSide?: number;
 }): ImageConverter;
 
 declare function getPngConverter(payload?: {
     compressionLevel?: number;
-    longest_side?: number;
+    longestSide?: number;
 }): ImageConverter;
 
-export { BmpCompressionOptions, GifCompressionOptions, ImageConverter, type ImageConverterInput, ImageCropAspectRatioOptions, ImageCropDimensionOptions, ImageCropEachSideOptions, ImageResizeAspectRatioOptions, ImageResizeDimensionOptions, ImageResizeLongestSideOptions, JpegCompressionOptions, PngCompressionOptions, TgaCompressionOptions, TiffCompressionOptions, getJpegConverter, getPngConverter };
+declare function extractExifData(bytes: Uint8Array): Uint8Array<ArrayBufferLike>;
+
+interface ImageDimensions {
+    width: number;
+    height: number;
+}
+declare function getImageDimensions(bytes: Uint8Array): ImageDimensions;
+
+export { BmpCompressionOptions, GifCompressionOptions, ImageCompressionOptions, ImageConverter, type ImageConverterInput, ImageCropAspectRatioOptions, ImageCropDimensionOptions, ImageCropEachSideOptions, ImageCropOptions, ImageResizeAspectRatioOptions, ImageResizeDimensionOptions, ImageResizeLongestSideOptions, ImpageResizeOptions, JpegCompressionOptions, PngCompressionOptions, TgaCompressionOptions, TiffCompressionOptions, extractExifData, getImageDimensions, getJpegConverter, getPngConverter };