clean up

(cherry picked from commit a651044591ecfd20409e5e004aa71c6da0561386)

# Conflicts:
#	packages/core/src/index.ts

package.json

@@ -3,6 +3,9 @@
   "description": "The jimp monorepo.",
   "repository": "jimp-dev/jimp",
   "author": "Andrew Lisowski <lisowski54@gmail.com>",
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "build": "turbo run build",
     "dev": "turbo run dev",

packages/core/package.json

@@ -18,6 +18,7 @@
   "devDependencies": {
     "@jimp/config-eslint": "workspace:*",
     "@jimp/config-typescript": "workspace:*",
+    "@types/file-type": "^10.9.1",
     "eslint": "^8.57.0",
     "tshy": "^1.12.0",
     "typescript": "^5.4.2",

packages/core/src/index.ts

@@ -76,9 +76,18 @@ export class Jimp<
 > implements JimpClass
 {
   static plugins: JimpPlugin[] = [];
+  /**
+   * Plugins that add image formats
+   */
   static formatPlugins: JimpFormat[] = [];
+  /**
+   * Formats that can be used with Jimp
+   */
   static formats: Format[] = [];
 
+  /**
+   * The bitmap data of the image
+   */
   bitmap: Bitmap = emptyBitmap;
   methods: MethodMap = {} as MethodMap;
   formats: Format<SupportedMimeTypes>[] = [];

packages/jimp/src/index.ts

@@ -6,13 +6,16 @@ import blit from "@jimp/plugin-blit";
 import png from "@jimp/js-png";
 
 export const Jimp = JimpCustom
-  // .addFormat(png)
+  // Formats
+  .addFormat(png)
+  // Plugins
   .plugin(blit)
   .plugin(crop);
 
 const image = new Jimp();
 
 image
+  // doesn't work because blit is added first
   .blit({ src: image, x: 0, y: 0 })
   .crop(0, 0, image.bitmap.width, image.bitmap.height)
   .blit({ src: image, x: 0, y: 0 })
@@ -21,4 +24,6 @@ image
 image
   .crop(0, 0, image.bitmap.width, image.bitmap.height)
   .blit({ src: image, x: 0, y: 0 })
+  // doesn't work because becuase of type returned from crop?
+  // maybe its the same issue as above?
   .crop(0, 0, image.bitmap.width, image.bitmap.height);

plugins/plugin-blit/src/index.ts

@@ -1,6 +1,23 @@
 import { JimpClass } from "@jimp/types";
 import { limit255, scan } from "@jimp/utils";
 
+export interface BlitOptions<I extends JimpClass> {
+  /** This image to blit on to the current image */
+  src: I;
+  /** the x position to blit the image */
+  x: number;
+  /** the y position to blit the image */
+  y: number;
+  /** the x position from which to crop the source image */
+  srcX?: number;
+  /** the y position from which to crop the source image */
+  srcY?: number;
+  /** the width to which to crop the source image */
+  srcW?: number;
+  /** the height to which to crop the source image */
+  srcH?: number;
+}
+
 /**
  * Blits a source image on to this image
  */
@@ -14,22 +31,7 @@ function blit<I extends JimpClass>(
     srcY = 0,
     srcW = src.bitmap.width,
     srcH = src.bitmap.height,
-  }: {
-    /** This image to blit on to the current image */
-    src: I;
-    /** the x position to blit the image */
-    x: number;
-    /** the y position to blit the image */
-    y: number;
-    /** the x position from which to crop the source image */
-    srcX?: number;
-    /** the y position from which to crop the source image */
-    srcY?: number;
-    /** the width to which to crop the source image */
-    srcW?: number;
-    /** the height to which to crop the source image */
-    srcH?: number;
-  },
+  }: BlitOptions<I>,
 ) {
   if (!("bitmap" in src)) {
     throw new Error("The source must be a Jimp image");