@metools/web-image-converter 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -0,0 +1,153 @@
+interface CompressionOptions {
+    format: string;
+    quality?: number;
+}
+declare abstract class ImageCompressionOptions {
+    abstract get optionExport(): CompressionOptions;
+}
+declare class JpegCompressionOptions extends ImageCompressionOptions {
+    quality: number;
+    constructor(quality: number);
+    get optionExport(): CompressionOptions;
+}
+declare class PngCompressionOptions extends ImageCompressionOptions {
+    quality: number;
+    constructor(quality: number);
+    get optionExport(): CompressionOptions;
+}
+declare class GifCompressionOptions extends ImageCompressionOptions {
+    get optionExport(): CompressionOptions;
+}
+declare class BmpCompressionOptions extends ImageCompressionOptions {
+    get optionExport(): CompressionOptions;
+}
+declare class TgaCompressionOptions extends ImageCompressionOptions {
+    get optionExport(): CompressionOptions;
+}
+declare class TiffCompressionOptions extends ImageCompressionOptions {
+    get optionExport(): CompressionOptions;
+}
+
+interface CropDimensionOptions {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface CropAspectRatioOptions {
+    ratio_width: number;
+    ratio_height: number;
+}
+interface CropEachSideOptions {
+    crop_left: number;
+    crop_right: number;
+    crop_top: number;
+    crop_bottom: number;
+}
+type CropOptions = CropDimensionOptions | CropAspectRatioOptions | CropEachSideOptions;
+declare abstract class ImageCropOptions {
+    abstract get optionExport(): CropOptions;
+}
+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;
+}
+declare class ImageCropAspectRatioOptions extends ImageCropOptions {
+    ratio_width: number;
+    ratio_height: number;
+    constructor(payload: {
+        ratio_width: number;
+        ratio_height: number;
+    });
+    get optionExport(): CropAspectRatioOptions;
+}
+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;
+}
+
+interface ResizeDimensionOptions {
+    width: number;
+    height: number;
+}
+interface ResizeAspectRatioOptions {
+    ratio_width: number;
+    ratio_height: number;
+}
+interface ResizeLongestSideOptions {
+    longest_side: number;
+}
+type ResizeOptions = ResizeDimensionOptions | ResizeAspectRatioOptions | ResizeLongestSideOptions;
+declare abstract class ImpageResizeOptions {
+    abstract get optionExport(): ResizeOptions;
+}
+declare class ImageResizeDimensionOptions extends ImpageResizeOptions {
+    width: number;
+    height: number;
+    constructor(payload: {
+        width: number;
+        height: number;
+    });
+    get optionExport(): ResizeDimensionOptions;
+}
+declare class ImageResizeAspectRatioOptions extends ImpageResizeOptions {
+    ratio_width: number;
+    ratio_height: number;
+    constructor(payload: {
+        ratio_width: number;
+        ratio_height: number;
+    });
+    get optionExport(): ResizeAspectRatioOptions;
+}
+declare class ImageResizeLongestSideOptions extends ImpageResizeOptions {
+    longest_side: number;
+    constructor(payload: {
+        longest_side: number;
+    });
+    get optionExport(): ResizeLongestSideOptions;
+}
+
+interface ImageConverterInput {
+    compression?: ImageCompressionOptions;
+    resize?: ImpageResizeOptions;
+    crop?: ImageCropOptions;
+}
+declare class ImageConverter {
+    compression?: ImageCompressionOptions;
+    resize?: ImpageResizeOptions;
+    crop?: ImageCropOptions;
+    constructor(payload: ImageConverterInput);
+    get options(): Record<string, unknown>;
+    convertImageFile(file: File): Promise<Uint8Array<ArrayBufferLike>>;
+    convertImageBytes(bytes: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>;
+}
+
+declare function getJpegConverter(payload?: {
+    quality?: number;
+    longest_side?: number;
+}): ImageConverter;
+
+declare function getPngConverter(payload?: {
+    compressionLevel?: number;
+    longest_side?: number;
+}): ImageConverter;
+
+export { BmpCompressionOptions, GifCompressionOptions, ImageConverter, ImageCropAspectRatioOptions, ImageCropDimensionOptions, ImageCropEachSideOptions, ImageResizeAspectRatioOptions, ImageResizeDimensionOptions, ImageResizeLongestSideOptions, JpegCompressionOptions, PngCompressionOptions, TgaCompressionOptions, TiffCompressionOptions, getJpegConverter, getPngConverter };

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@metools/web-image-converter",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist/image_converter_back_end_bg.wasm"
-  ],
   "type": "module",
   "sideEffects": false,
   "author": "Mathew E. Thompson",

package/publish.sh

@@ -0,0 +1 @@
+npm publish --access public

package/readme.md

@@ -21,6 +21,29 @@ This package is for you!
 
 The meat of the project is written in Rust and exported into a WebAssembly binary. The project also contains a TypeScript API for interacting with the WebAssembly back end.
 
+## Installation
+
+Just install the package with your package manager of choice:
+
+`npm install @metools/web-image-converter`
+
+## Bundler Caveats
+
+WebAssembly is still not a first class citizen among all bundlers and dev servers, so some bundlers and dev servers may have an issue serving Wasm files or adding them to the build directory. Below are lists of caveates and workarounds for bundlers:
+
+### Vite
+
+When bundling this app with Vite, you will need to prevent the package from being optimized using the `optimizeDeps.exclude` API:
+
+```ts
+import { defineConfig } from 'vite';
+export default defineConfig({
+  optimizeDeps: {
+    exclude: ['@metools/web-image-converter'],
+  },
+});
+```
+
 ## Usage
 
 The project uses a set of classes for a declarative approach to converting images. The project is based around the ImageConverter class and several option classes that can be used.
@@ -55,7 +78,7 @@ Both APIs return a `Uint8Array` object that can be used in any place where you m
 - [MDN createObjectURL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL_static)
 - [MDN Using object URLs to display images](https://developer.mozilla.org/en-US/docs/Web/API/File_API/Using_files_from_web_applications#example_using_object_urls_to_display_images)
 
-### Options
+## Options
 
 You can specify one of several `CompressionOptions` objects to represent output format and compression:
 
@@ -86,11 +109,11 @@ You can specify one of serveral `CropOptions` objects to represent cropping an i
 - `ImageCropEachSideOptions(payload: { crop_left: number; crop_right: number; crop_top: number; crop_bottom: number; })`
   - This operation allows you to describe cropping pixels on each of the four sides of the image.
 
-### Errors
+## Errors
 
 When the files and binary data provided conform to the file specs of the above supported image formats, the project should work fine. However, if the data provided is NOT an image, `convertImageFile` and `convertImageBytes` will each throw an error. The function should be wrapped in a try / catch block to catch errors.
 
-### Blocking Operation
+## Blocking Operation
 
 Running an operation via WebAssmebly is a blocking operation. This means that when the operation is called, it will block a wide variety of tasks in the application from continuing to run, such as UI operations, timers, etc. For instance, when compressing a large image from a DSLR camera, it may take several seconds for the operation to complete and during that time everything else freezes.