@metools/web-image-converter 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -130,12 +130,17 @@ interface ImageConverterInput {
     resize?: ImpageResizeOptions;
     crop?: ImageCropOptions;
 }
-declare class ImageConverter {
+declare abstract class AbstractImageConverter {
     compression?: ImageCompressionOptions;
     resize?: ImpageResizeOptions;
     crop?: ImageCropOptions;
     constructor(payload: ImageConverterInput);
     get options(): Record<string, unknown>;
+    abstract convertImageBytes(bytes: Uint8Array): Promise<Uint8Array>;
+}
+
+declare class ImageConverter extends AbstractImageConverter {
+    constructor(payload: ImageConverterInput);
     convertImageFile(file: File): Promise<Uint8Array<ArrayBufferLike>>;
     convertImageBytes(bytes: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>;
 }

package/dist/index.js

@@ -400,8 +400,8 @@ async function __wbg_init(module_or_path) {
 }
 var image_converter_back_end_default = __wbg_init;
 
-// src/models/image_converter.ts
-var ImageConverter = class {
+// ../image_converter_js_common/models/image_converter.ts
+var AbstractImageConverter = class {
   constructor(payload) {
     this.compression = payload.compression;
     this.resize = payload.resize;
@@ -420,6 +420,13 @@ var ImageConverter = class {
     }
     return options;
   }
+};
+
+// src/models/image_converter.ts
+var ImageConverter = class extends AbstractImageConverter {
+  constructor(payload) {
+    super(payload);
+  }
   async convertImageFile(file) {
     const buf = await file.arrayBuffer();
     const uint8Arr = new Uint8Array(buf);
@@ -432,7 +439,7 @@ var ImageConverter = class {
   }
 };
 
-// src/models/compression_options.ts
+// ../image_converter_js_common/models/compression_options.ts
 var ImageCompressionOptions = class {
 };
 var JpegCompressionOptions = class extends ImageCompressionOptions {
@@ -486,7 +493,7 @@ var TiffCompressionOptions = class extends ImageCompressionOptions {
   }
 };
 
-// src/models/crop_options.ts
+// ../image_converter_js_common/models/crop_options.ts
 var ImageCropOptions = class {
 };
 var ImageCropDimensionOptions = class extends ImageCropOptions {
@@ -549,7 +556,7 @@ var ImageCropEachSideOptions = class extends ImageCropOptions {
   }
 };
 
-// src/models/resize_options.ts
+// ../image_converter_js_common/models/resize_options.ts
 var ImpageResizeOptions = class {
 };
 var ImageResizeDimensionOptions = class extends ImpageResizeOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metools/web-image-converter",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",

package/publish.sh

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

package/readme.md

@@ -1,6 +1,10 @@
-# @metools/web-image-converter
+# Image Converter Module for JavaScript Web & Node
 
-### An image-converter for use on the web, written in Rust.
+### An image-converter for JavaScript, written in Rust.
+
+### @metools/node-image-converter
+
+### @metools/web-image-converter
 
 Ever had a really large image that you wanted to compress quickly?
 
@@ -10,7 +14,7 @@ Do you want to cut down on file uploads and compute on your servers?
 
 This package is for you!
 
-@metools/web-image-converter is a web-compatible package for converting images. It has basic operations for resizing, cropping and compressing images. It can read from and convert to the following formats:
+This project is a Node & Web compatible package for converting images. It has basic operations for resizing, cropping and compressing images. It can read from and convert to the following formats:
 
 - Jpeg
 - Png
@@ -21,11 +25,42 @@ 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.
+
+For Web:
+
+`npm install @metools/web-image-converter`
+
+For Node:
+
+`npm install @metools/node-image-converter`
+
+Each package is specific to the environment at hand and cannot be used interchangeably. As such, pick the package for your use case.
+
+## 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.
 
-The ImageConverter class can be used with either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) object or a [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) representing the binary data of an image file.
+The ImageConverter class can be used with either a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) object (web only) or a [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) representing the binary data of an image file.
 
 Example usage:
 
@@ -45,7 +80,7 @@ function convertMyImage(file: File) {
 `ImageConverter` provides two different ways to convert images:
 
 - `convertImageFile(file: File): Promise<Uint8Array<ArrayBufferLike>>`
-  - This API accepts a JavaScript File object and runs it through the process
+  - This API accepts a JavaScript File object and runs it through the process (web-only)
 - `convertImageBytes(bytes: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>`
   - This API accepts a Uint8Array and does the same thing as `convertImageFile`.
 
@@ -55,7 +90,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,18 +121,20 @@ 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.
 
-As such, web workers may be a beneficial to put this operation into a web worker for the sake of leaving the main thread open to other operations:
+As such, for the web, web workers may be a good way to use this package without causing the project to hang:
 
 [MDN Using Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers)
 
+In Node, you may want to have the image conversion operation be a separate executable that can run on its own thread. You can probably use `exec` to execute a script.
+
 ## Examples
 
 Converting a file to Jpeg: