join-images - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

.eslintrc.js

@@ -25,3 +25,4 @@ module.exports = {
     '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
   },
 };

package.json

 {
   "name": "join-images",
-  "version": "0.1.1",
-  "description": "TypeScript",
+  "version": "0.1.2",
+  "description": "Merge multiple images into a single image",
   "engines": {
@@ -12,7 +12,7 @@ "node": ">= 12.13 <13"
   },
-  "main": "./lib/index.js",
   "devDependencies": {
     "@types/jest": "^26.0.3",
-    "@types/jimp": "^0.2.28",
+    "@types/jest-image-snapshot": "^3.1.0",
     "@types/node": "^14.0.14",
+    "@types/sharp": "^0.25.0",
     "@typescript-eslint/eslint-plugin": "^3.5.0",
@@ -26,2 +26,3 @@ "@typescript-eslint/parser": "^3.5.0",
     "jest": "^26.1.0",
+    "jest-image-snapshot": "^4.0.2",
     "prettier": "^2.0.5",
@@ -40,10 +41,22 @@ "rimraf": "^3.0.2",
     "test:watch": "jest --watch",
-    "prepublish": "npm run build"
+    "prepublish": "npm run lint && npm run build"
   },
   "author": "m.doaie <[e-mail]>",
   "license": "MIT",
+  "keywords": [
+    "join image",
+    "merge image",
+    "sharp js",
+    "concat",
+    "convert",
+    "compose",
+    "image",
+    "manipulation",
+    "merge",
+    "multiple image"
+  ],
   "dependencies": {
     "is-plain-obj": "^2.1.0",
-    "jimp": "^0.14.0"
+    "sharp": "^0.25.4"
   }
 }

README.md

@@ -1,1 +0,55 @@
-# node-typescript-boilerplate
+# join-images
+
+> Merge multiple images into a single image
+
+`join-images` is modified version of [`merge-img`][merge-img] to make it work with [`sharp`][sharp] library.
+
+`join-images` merges given images into a single image in right order. This will be helpful in a situation when you have to generate a preview of multiple images into a single image. This module is based on [`sharp`][sharp] for image processing.
+
+![figure](https://rawgit.com/preco21/join-images/master/media/figure.png)
+Image credit: https://www.pexels.com/
+
+## Install
+
+```bash
+$ npm install join-images
+```
+
+```bash
+$ yarn add join-images
+```
+
+## Usage
+
+```javascript
+import joinImages from 'join-images';
+
+joinImages(['image-1.png', 'image-2.jpg']).then((img) => {
+  // Save image as file
+  img.toFile('out.png');
+});
+```
+
+## API
+
+### joinImages(images[, options])
+
+- `images` Array of (String | Object | Buffer) - List of images to concat. If `String` is passed, it will be considered to the file path. An `Object` entry can have following options:
+  - `src` _`String`_ or `Buffer` - A single image source to concat.
+  - `offsetX` Number (optional) - `x` offset to affect this image. Default is `0`.
+  - `offsetY` Number (optional) - `y` offset to affect this image. Default is `0`.
+- `options` Object (optional)
+  - `direction` String (`vertical|horizontal`) - Direction of the merged image.`.
+  - `color` (String | Object) - Default background color represented by RGBA hex value. Default is `{ alpha: 0.5, b: 0, g: 0, r: 0 }`.
+  - `align` String - Aligning of given images. If the images are not all the same size, images will be sorted to largest image. Possible values are `start`, `center` and `end`. Default is `start`.
+  - `offset` Number - Offset in pixels between each image. Default is `0`.
+  - `margin` (Number | String | Object) - Margin of the result image. If `Number` or `String` is passed, it will be considered as [standard css shorthand properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties) (e.g. '40 40 0 10'). An `Object` entry can have following options:
+    - `top` Number (optional) - Margin on top side of result image. Default is `0`.
+    - `right` Number (optional) - Margin on right side of result image. Default is `0`.
+    - `bottom` Number (optional) - Margin on bottom side of result image. Default is `0`.
+    - `left` Number (optional) - Margin on left side of result image. Default is `0`.
+
+Returns a `Promise` that contains `sharp` object.
+
+[sharp]: https://github.com/lovell/sharp
+[merge-img]: https://github.com/preco21/merge-img

src/index.ts

@@ -1,1 +0,1 @@
-export * from './mergeImg';
+export * from './main';

tsconfig.json

@@ -20,3 +20,5 @@ {
     "noImplicitThis": false,
-    "strictNullChecks": false
+    "strictNullChecks": false,
+    "esModuleInterop": true,
+    "declaration": true
   },
@@ -23,0 +25,0 @@ "include": ["src/**/*", "**/__tests__/*"],

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7447537

increased by924.12%

Number of package files

31

increased by40.91%

Number of lines in readme file

56

increased by2700%

Worsened metrics

Dev dependency count

18

increased by12.5%

Lines of code

377

decreased by-9.81%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedsharp@^0.25.4

• + Addedansi-regex@2.1.1(transitive)

• + Addedaproba@1.2.0(transitive)

• + Addedare-we-there-yet@1.1.7(transitive)

• + Addedbl@4.1.0(transitive)

• + Addedchownr@1.1.42.0.0(transitive)

• + Addedcode-point-at@1.1.0(transitive)

• + Addedcolor@3.2.1(transitive)

• + Addedcolor-convert@1.9.3(transitive)

• + Addedcolor-name@1.1.3(transitive)

• + Addedcolor-string@1.9.1(transitive)

• + Addedconsole-control-strings@1.1.0(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addeddecompress-response@4.2.16.0.0(transitive)

• + Addeddeep-extend@0.6.0(transitive)

• + Addeddelegates@1.0.0(transitive)

• + Addeddetect-libc@1.0.3(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedexpand-template@2.0.3(transitive)

• + Addedfs-constants@1.0.0(transitive)

• + Addedfs-minipass@2.1.0(transitive)

• + Addedgauge@2.7.4(transitive)

• + Addedgithub-from-package@0.0.0(transitive)

• + Addedhas-unicode@2.0.1(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedini@1.3.8(transitive)

• + Addedis-arrayish@0.3.2(transitive)

• + Addedis-fullwidth-code-point@1.0.0(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedmimic-response@2.1.03.1.0(transitive)

• + Addedminipass@3.3.65.0.0(transitive)

• + Addedminizlib@2.1.2(transitive)

• + Addedmkdirp@1.0.4(transitive)

• + Addedmkdirp-classic@0.5.3(transitive)

• + Addednapi-build-utils@1.0.2(transitive)

• + Addednode-abi@2.30.1(transitive)

• + Addednode-addon-api@3.2.1(transitive)

• + Addednoop-logger@0.1.1(transitive)

• + Addednpmlog@4.1.2(transitive)

• + Addednumber-is-nan@1.0.1(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedprebuild-install@5.3.6(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedpump@3.0.2(transitive)

• + Addedrc@1.2.8(transitive)

• + Addedreadable-stream@2.3.83.6.2(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedsemver@5.7.27.6.3(transitive)

• + Addedset-blocking@2.0.0(transitive)

• + Addedsharp@0.25.4(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedsimple-concat@1.0.1(transitive)

• + Addedsimple-get@3.1.14.0.1(transitive)

• + Addedsimple-swizzle@0.2.2(transitive)

• + Addedstring-width@1.0.2(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedstrip-ansi@3.0.1(transitive)

• + Addedstrip-json-comments@2.0.1(transitive)

• + Addedtar@6.2.1(transitive)

• + Addedtar-fs@2.1.1(transitive)

• + Addedtar-stream@2.2.0(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwhich-pm-runs@1.1.0(transitive)

• + Addedwide-align@1.1.5(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedyallist@4.0.0(transitive)

• - Removedjimp@^0.14.0

• - Removed@babel/runtime@7.26.0(transitive)

• - Removed@jimp/bmp@0.14.0(transitive)

• - Removed@jimp/core@0.14.0(transitive)

• - Removed@jimp/custom@0.14.0(transitive)

• - Removed@jimp/gif@0.14.0(transitive)

• - Removed@jimp/jpeg@0.14.0(transitive)

• - Removed@jimp/plugin-blit@0.14.0(transitive)

• - Removed@jimp/plugin-blur@0.14.0(transitive)

• - Removed@jimp/plugin-circle@0.14.0(transitive)

• - Removed@jimp/plugin-color@0.14.0(transitive)

• - Removed@jimp/plugin-contain@0.14.0(transitive)

• - Removed@jimp/plugin-cover@0.14.0(transitive)

• - Removed@jimp/plugin-crop@0.14.0(transitive)

• - Removed@jimp/plugin-displace@0.14.0(transitive)

• - Removed@jimp/plugin-dither@0.14.0(transitive)

• - Removed@jimp/plugin-fisheye@0.14.0(transitive)

• - Removed@jimp/plugin-flip@0.14.0(transitive)

• - Removed@jimp/plugin-gaussian@0.14.0(transitive)

• - Removed@jimp/plugin-invert@0.14.0(transitive)

• - Removed@jimp/plugin-mask@0.14.0(transitive)

• - Removed@jimp/plugin-normalize@0.14.0(transitive)

• - Removed@jimp/plugin-print@0.14.0(transitive)

• - Removed@jimp/plugin-resize@0.14.0(transitive)

• - Removed@jimp/plugin-rotate@0.14.0(transitive)

• - Removed@jimp/plugin-scale@0.14.0(transitive)

• - Removed@jimp/plugin-shadow@0.14.0(transitive)

• - Removed@jimp/plugin-threshold@0.14.0(transitive)

• - Removed@jimp/plugins@0.14.0(transitive)

• - Removed@jimp/png@0.14.0(transitive)

• - Removed@jimp/tiff@0.14.0(transitive)

• - Removed@jimp/types@0.14.0(transitive)

• - Removed@jimp/utils@0.14.0(transitive)

• - Removed@types/node@16.9.1(transitive)

• - Removedany-base@1.1.0(transitive)

• - Removedbmp-js@0.1.0(transitive)

• - Removedbuffer-equal@0.0.1(transitive)

• - Removedcentra@2.7.0(transitive)

• - Removeddom-walk@0.1.2(transitive)

• - Removedexif-parser@0.1.12(transitive)

• - Removedfile-type@9.0.0(transitive)

• - Removedfollow-redirects@1.15.9(transitive)

• - Removedgifwrap@0.9.4(transitive)

• - Removedglobal@4.4.0(transitive)

• - Removedimage-q@4.0.0(transitive)

• - Removedis-function@1.0.2(transitive)

• - Removedjimp@0.14.0(transitive)

• - Removedjpeg-js@0.4.4(transitive)

• - Removedload-bmfont@1.4.2(transitive)

• - Removedmime@1.6.0(transitive)

• - Removedmin-document@2.19.0(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removedomggif@1.0.10(transitive)

• - Removedpako@1.0.11(transitive)

• - Removedparse-bmfont-ascii@1.0.6(transitive)

• - Removedparse-bmfont-binary@1.0.6(transitive)

• - Removedparse-bmfont-xml@1.1.6(transitive)

• - Removedparse-headers@2.0.5(transitive)

• - Removedphin@2.9.33.7.1(transitive)

• - Removedpixelmatch@4.0.2(transitive)

• - Removedpngjs@3.4.0(transitive)

• - Removedprocess@0.11.10(transitive)

• - Removedregenerator-runtime@0.13.110.14.1(transitive)

• - Removedsax@1.4.1(transitive)

• - Removedtimm@1.7.1(transitive)

• - Removedtinycolor2@1.6.0(transitive)

• - Removedutif@2.0.1(transitive)

• - Removedxhr@2.6.0(transitive)

• - Removedxml-parse-from-string@1.0.1(transitive)

• - Removedxml2js@0.5.0(transitive)

• - Removedxmlbuilder@11.0.1(transitive)

• - Removedxtend@4.0.2(transitive)