@napi-rs/image 1.1.1 → 1.3.0

package/README.md

@@ -19,8 +19,8 @@ This library support encode/decode these formats:
 | BMP       | ✅                                        | Rgb8, Rgba8, Gray8, GrayA8              |
 | ICO       | ✅                                        | ✅                                      |
 | TIFF      | Baseline(no fax support) + LZW + PackBits | Rgb8, Rgba8, Gray8                      |
-| WebP      | No                                        | ✅                                      |
-| AVIF      | No                                        | ✅                                      |
+| WebP      | ✅                                        | ✅                                      |
+| AVIF      | ✅                                        | ✅                                      |
 | PNM       | PBM, PGM, PPM, standard PAM               | ✅                                      |
 | DDS       | DXT1, DXT3, DXT5                          | No                                      |
 | TGA       | ✅                                        | Rgb8, Rgba8, Bgr8, Bgra8, Gray8, GrayA8 |
@@ -495,7 +495,7 @@ blur(sigma: number): this
 
 #### `unsharpen`
 
-> Performs an unsharpen mask on this image. <br/> > `sigma` is the amount to blur the image by. <br/> > `threshold` is a control of how much to sharpen.
+> Performs an unsharpen mask on this image. <br/> `sigma` is the amount to blur the image by. <br/> `threshold` is a control of how much to sharpen.
 >
 > See <https://en.wikipedia.org/wiki/Unsharp_masking#Digital_unsharp_masking>
 
@@ -513,7 +513,7 @@ filter3x3(kernel: Array<number>): this
 
 #### `adjustContrast`
 
-> Adjust the contrast of this image.<br/> > `contrast` is the amount to adjust the contrast by.<br/>
+> Adjust the contrast of this image.<br/> `contrast` is the amount to adjust the contrast by.<br/>
 > Negative values decrease the contrast and positive values increase the contrast.
 
 ```ts
@@ -522,7 +522,7 @@ adjustContrast(contrast: number): this
 
 #### `brighten`
 
-> Brighten the pixels of this image.<br/> > `value` is the amount to brighten each pixel by. <br/>
+> Brighten the pixels of this image.<br/> `value` is the amount to brighten each pixel by. <br/>
 > Negative values decrease the brightness and positive values increase it.
 
 ```ts
@@ -531,7 +531,7 @@ brighten(brightness: number): this
 
 #### `huerotate`
 
-> Hue rotate the supplied image.<br/> > `value` is the degrees to rotate each pixel by.
+> Hue rotate the supplied image.<br/> `value` is the degrees to rotate each pixel by.
 > 0 and 360 do nothing, the rest rotates by the given degree value.
 > just like the css webkit filter hue-rotate(180)
 

package/index.d.ts

@@ -5,15 +5,15 @@
 
 export interface AvifConfig {
   /** 0-100 scale, 100 is lossless */
-  quality?: number | undefined | null
+  quality?: number
   /** 0-100 scale */
-  alphaQuality?: number | undefined | null
+  alphaQuality?: number
   /** rav1e preset 1 (slow) 10 (fast but crappy), default is 4 */
-  speed?: number | undefined | null
+  speed?: number
   /** How many threads should be used (0 = match core count) */
-  threads?: number | undefined | null
+  threads?: number
   /** set to '4:2:0' to use chroma subsampling, default '4:4:4' */
-  chromaSubsampling?: ChromaSubsampling | undefined | null
+  chromaSubsampling?: ChromaSubsampling
 }
 /**
  * https://en.wikipedia.org/wiki/Chroma_subsampling#Types_of_sampling_and_subsampling
@@ -55,23 +55,19 @@ export const enum ChromaSubsampling {
    * What if the chroma subsampling model is 4:0:0?
    * That says to use every pixel of luma data, but that each row has 0 chroma samples applied to it. The resulting image, then, is comprised solely of the luminance data—a greyscale image.
    */
-  Yuv400 = 3,
+  Yuv400 = 3
 }
 export interface JpegCompressOptions {
   /** Output quality, default is 100 (lossless) */
-  quality?: number | undefined | null
+  quality?: number
   /**
    * If true, it will use MozJPEG’s scan optimization. Makes progressive image files smaller.
    * Default is `true`
    */
-  optimizeScans?: boolean | undefined | null
+  optimizeScans?: boolean
 }
 export function compressJpegSync(input: Buffer, options?: JpegCompressOptions | undefined | null): Buffer
-export function compressJpeg(
-  input: Buffer,
-  options?: JpegCompressOptions | undefined | null,
-  signal?: AbortSignal | undefined | null,
-): Promise<Buffer>
+export function compressJpeg(input: Buffer, options?: JpegCompressOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<Buffer>
 export const enum CompressionType {
   /** Default compression level */
   Default = 0,
@@ -82,7 +78,7 @@ export const enum CompressionType {
   /** Huffman coding compression */
   Huffman = 3,
   /** Run-length encoding compression */
-  Rle = 4,
+  Rle = 4
 }
 export const enum FilterType {
   /**
@@ -102,87 +98,79 @@ export const enum FilterType {
    * Uses a heuristic to select one of the preceding filters for each
    * scanline rather than one filter for the entire image
    */
-  Adaptive = 5,
+  Adaptive = 5
 }
 export interface PngEncodeOptions {
   /** Default is `CompressionType::Default` */
-  compressionType?: CompressionType | undefined | null
+  compressionType?: CompressionType
   /** Default is `FilterType::NoFilter` */
-  filterType?: FilterType | undefined | null
+  filterType?: FilterType
 }
 export interface PNGLosslessOptions {
   /**
    * Attempt to fix errors when decoding the input file rather than returning an Err.
    * Default: `false`
    */
-  fixErrors?: boolean | undefined | null
+  fixErrors?: boolean
   /**
    * Write to output even if there was no improvement in compression.
    * Default: `false`
    */
-  force?: boolean | undefined | null
+  force?: boolean
   /** Which filters to try on the file (0-5) */
-  filter?: Array<number> | undefined | null
+  filter?: Array<number>
   /**
    * Whether to attempt bit depth reduction
    * Default: `true`
    */
-  bitDepthReduction?: boolean | undefined | null
+  bitDepthReduction?: boolean
   /**
    * Whether to attempt color type reduction
    * Default: `true`
    */
-  colorTypeReduction?: boolean | undefined | null
+  colorTypeReduction?: boolean
   /**
    * Whether to attempt palette reduction
    * Default: `true`
    */
-  paletteReduction?: boolean | undefined | null
+  paletteReduction?: boolean
   /**
    * Whether to attempt grayscale reduction
    * Default: `true`
    */
-  grayscaleReduction?: boolean | undefined | null
+  grayscaleReduction?: boolean
   /**
    * Whether to perform IDAT recoding
    * If any type of reduction is performed, IDAT recoding will be performed regardless of this setting
    * Default: `true`
    */
-  idatRecoding?: boolean | undefined | null
+  idatRecoding?: boolean
   /** Whether to remove ***All non-critical headers*** on PNG */
-  strip?: boolean | undefined | null
+  strip?: boolean
   /** Whether to use heuristics to pick the best filter and compression */
-  useHeuristics?: boolean | undefined | null
+  useHeuristics?: boolean
 }
 export function losslessCompressPngSync(input: Buffer, options?: PNGLosslessOptions | undefined | null): Buffer
-export function losslessCompressPng(
-  input: Buffer,
-  options?: PNGLosslessOptions | undefined | null,
-  signal?: AbortSignal | undefined | null,
-): Promise<Buffer>
+export function losslessCompressPng(input: Buffer, options?: PNGLosslessOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<Buffer>
 export interface PngQuantOptions {
   /** default is 70 */
-  minQuality?: number | undefined | null
+  minQuality?: number
   /** default is 99 */
-  maxQuality?: number | undefined | null
+  maxQuality?: number
   /**
    * 1- 10
    * Faster speeds generate images of lower quality, but may be useful for real-time generation of images.
    * default: 5
    */
-  speed?: number | undefined | null
+  speed?: number
   /**
    * Number of least significant bits to ignore.
    * Useful for generating palettes for VGA, 15-bit textures, or other retro platforms.
    */
-  posterization?: number | undefined | null
+  posterization?: number
 }
 export function pngQuantizeSync(input: Buffer, options?: PngQuantOptions | undefined | null): Buffer
-export function pngQuantize(
-  input: Buffer,
-  options?: PngQuantOptions | undefined | null,
-  signal?: AbortSignal | undefined | null,
-): Promise<Buffer>
+export function pngQuantize(input: Buffer, options?: PngQuantOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<Buffer>
 export const enum Orientation {
   /** Normal */
   Horizontal = 1,
@@ -192,7 +180,7 @@ export const enum Orientation {
   MirrorHorizontalAndRotate270Cw = 5,
   Rotate90Cw = 6,
   MirrorHorizontalAndRotate90Cw = 7,
-  Rotate270Cw = 8,
+  Rotate270Cw = 8
 }
 /**
  * Available Sampling Filters.
@@ -272,7 +260,7 @@ export const enum ResizeFilterType {
   /** Gaussian Filter */
   Gaussian = 3,
   /** Lanczos with window 3 */
-  Lanczos3 = 4,
+  Lanczos3 = 4
 }
 export const enum JsColorType {
   /** Pixel is 8-bit luminance */
@@ -294,13 +282,13 @@ export const enum JsColorType {
   /** Pixel is 32-bit float RGB */
   Rgb32F = 8,
   /** Pixel is 32-bit float RGBA */
-  Rgba32F = 9,
+  Rgba32F = 9
 }
 export interface Metadata {
   width: number
   height: number
-  exif?: Record<string, string> | undefined | null
-  orientation?: number | undefined | null
+  exif?: Record<string, string>
+  orientation?: number
   format: string
   colorType: JsColorType
 }
@@ -362,6 +350,12 @@ export class Transformer {
    * just like the css webkit filter hue-rotate(180)
    */
   huerotate(hue: number): this
+  /** Crop a cut-out of this image delimited by the bounding rectangle. */
+  crop(x: number, y: number, width: number, height: number): this
+  /** Return this image's pixels as a native endian byte slice. */
+  rawPixels(signal?: AbortSignal | undefined | null): Promise<Buffer>
+  /** Return this image's pixels as a native endian byte slice. */
+  rawPixelsSync(): Buffer
   /**
    * The quality factor `quality_factor` ranges from 0 to 100 and controls the loss and quality during compression.
    * The value 0 corresponds to low quality and small output sizes, whereas 100 is the highest quality and largest output size.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/image",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "main": "index.js",
   "types": "index.d.ts",
   "description": "Image processing library",
@@ -60,19 +60,22 @@
     "version": "napi version"
   },
   "repository": "git@github.com:Brooooooklyn/Image.git",
-  "gitHead": "e61083611a6e16e07b38eaefee8d2537c93efe2c",
+  "devDependencies": {
+    "@napi-rs/cli": "^2.9.0"
+  },
+  "gitHead": "e2e01fdd67e087b1468a933bbe5ea15d40a41315",
   "optionalDependencies": {
-    "@napi-rs/image-win32-x64-msvc": "1.1.1",
-    "@napi-rs/image-darwin-x64": "1.1.1",
-    "@napi-rs/image-linux-x64-gnu": "1.1.1",
-    "@napi-rs/image-darwin-arm64": "1.1.1",
-    "@napi-rs/image-android-arm64": "1.1.1",
-    "@napi-rs/image-linux-arm64-gnu": "1.1.1",
-    "@napi-rs/image-linux-arm64-musl": "1.1.1",
-    "@napi-rs/image-linux-arm-gnueabihf": "1.1.1",
-    "@napi-rs/image-linux-x64-musl": "1.1.1",
-    "@napi-rs/image-freebsd-x64": "1.1.1",
-    "@napi-rs/image-win32-ia32-msvc": "1.1.1",
-    "@napi-rs/image-android-arm-eabi": "1.1.1"
+    "@napi-rs/image-win32-x64-msvc": "1.3.0",
+    "@napi-rs/image-darwin-x64": "1.3.0",
+    "@napi-rs/image-linux-x64-gnu": "1.3.0",
+    "@napi-rs/image-darwin-arm64": "1.3.0",
+    "@napi-rs/image-android-arm64": "1.3.0",
+    "@napi-rs/image-linux-arm64-gnu": "1.3.0",
+    "@napi-rs/image-linux-arm64-musl": "1.3.0",
+    "@napi-rs/image-linux-arm-gnueabihf": "1.3.0",
+    "@napi-rs/image-linux-x64-musl": "1.3.0",
+    "@napi-rs/image-freebsd-x64": "1.3.0",
+    "@napi-rs/image-win32-ia32-msvc": "1.3.0",
+    "@napi-rs/image-android-arm-eabi": "1.3.0"
   }
 }