├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── bower.json ├── demo ├── index.html └── test-server.js ├── index.js ├── package.json └── tests └── full.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | bower_components 3 | *.jpg 4 | *.png -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language : node_js 2 | node_js : 3 | - "0.10" 4 | before_install : 5 | - "npm install -g mocha" 6 | - "npm install -g node-gyp" -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sharper [![Build Status](https://img.shields.io/travis/thatisuday/sharper.svg?style=flat-square)](https://travis-ci.org/thatisuday/sharper) [![npm downloads](https://img.shields.io/npm/dt/sharper.svg?style=flat-square)](https://www.npmjs.com/package/sharper) [![npm version](https://img.shields.io/npm/v/sharper.svg?style=flat-square)](https://www.npmjs.com/package/sharper) [![npm dependencies](https://img.shields.io/david/thatisuday/sharper.svg?style=flat-square)](https://www.npmjs.com/package/sharper) 2 | 3 | 4 | Automatic image processor built on top of sharp and multer for express. 5 | 6 | *** 7 | 8 | ## How does it work? 9 | When you are working on a website which needs to create multiple size copies of a single image uploaded by user, resize | crop | process and finally upload in a dynamic directory based on current date or time, then this module will save your entire lifetime. 10 | 11 | Basically, this module provide an express middleware that do all above things at once. If something goes wrong, you can catch it in error middleware. You need to provide few options that will tell sharper about `location of upload`, `dynamic date format for upload folder to be created`, `accepted image types`, `upload size limits`, `output format`, and `output sizes with prefixes` etc. 12 | 13 | This module is based on **[sharp](https://github.com/lovell/sharp)** node-js module for image processing. It's the fastest module there is and based on `libvips` library. 14 | 15 | *** 16 | 17 | ## Install 18 | ``` 19 | npm install --save sharper 20 | ``` 21 | 22 | *** 23 | 24 | ## Configure 25 | 26 | #### set options 27 | ``` 28 | const sharper = require('sharper'); 29 | var Sharper = sharper({ 30 | field : 'file', 31 | location : '/var/www/uploads/', 32 | dirFormat : 'yyyy/mmm/d', 33 | maxFileSize: '20mb', 34 | fileNameLen : 50, 35 | accept : ['jpeg', 'jpg', 'png'], 36 | output : 'jpg', 37 | sizes : [ 38 | {suffix : 'xlg', width : 1200, height : 1200}, 39 | {suffix : 'lg', width : 800, height : 800}, 40 | {suffix : 'md', width : 500, height : 500}, 41 | {suffix : 'sm', width : 300, height : 300}, 42 | {suffix : 'xs', width : 100, height : 100}, 43 | ] 44 | }); 45 | ``` 46 | 47 | #### add middleware 48 | ``` 49 | app.post('/upload', Sharper, function(err, req, res, next){ 50 | console.log(err); 51 | res.status(500).send('upload failed...'); 52 | }, function(req, res){ 53 | console.log(res.sharper); 54 | res.send('upload successful...'); 55 | }); 56 | ``` 57 | 58 | *** 59 | 60 | # Options 61 | ``` 62 | var Sharper = sharper(options); 63 | ``` 64 | 65 | #### sharper options 66 | | option | default | role | 67 | | ------ | ------- | ---- | 68 | | field | 'file' | input file field in multipart form data. ex. `` | 69 | | location | '/var/www/html/' | upload directory. | 70 | | dirFormat | 'yyyy/mmm/d' | date pattern to follow for folder creation for image storage. Explore formats at `[node-format module](https://github.com/felixge/node-dateformat#mask-options)` | 71 | | fileNameLen | 50 | length of the output image filename. | 72 | | maxFileSize | '10mb' | maximum size of input/upload file to accept. | 73 | | accept | ['png','jpeg','jpg'] | array of file types/extensions to accept. | 74 | | output | 'jpg' | type of output file to produce. valid options : `jpg`, `png`, `gif`, `webp`, `tiff`, `bmp` | 75 | | sizes | `[{suffix : 'lg', width : 500, height:500}, ...]` | Array of size specification object for output images (with filename suffix to produce `output-name.lg.jpg` format). | 76 | 77 | #### sharp options 78 | Please visit this sharp **[sharp](https://github.com/lovell/sharp)** for detailed overview of specific option. 79 | 80 | | option | default | role | 81 | | ------ | ------- | ---- | 82 | | resize | true | resize images as per their sizes mentioned in `options.sizes` | 83 | | crop | false | crop images as per their sizes mentioned in `options.sizes` | 84 | | background | {r: 200 , g:200, b:200, a:1} | set the background for the embed, flatten and extend operations. | 85 | | embed | false | embed on canvas | 86 | | max | false | set maximum output dimension | 87 | | min | false | set minimum output dimension | 88 | | withoutEnlargement | false | do not enlarge small images | 89 | | ignoreAspectRatio | false | ignore aspect ration while resizing images | 90 | | extract | false | extract specific part of image | 91 | | trim | false | Trim **boring** pixels from all edges | 92 | | flatten | false | Merge alpha transparency channel, if any, with background. | 93 | | extend | false | Extends/pads the edges of the image with background. | 94 | | negate | false | Produces the **negative** of the image. | 95 | | rotate | false | Rotate the output image by either an explicit angle | 96 | | flip | false | Flip the image about the vertical Y axis. | 97 | | flop | false | Flop the image about the horizontal X axis. | 98 | | blur | false | Mild blur of the output image | 99 | | sharpen | false | Mild sharpen of the output image | 100 | | gamma | false | Apply a gamma correction. | 101 | | grayscale *or* greyscale | false | Convert to 8-bit greyscale; 256 shades of grey. | 102 | | normalize *or* normalise | false | Enhance output image contrast by stretching its luminance to cover the full dynamic range. | 103 | | progressive | false | Use progressive (interlace) scan for JPEG and PNG output. | 104 | | quality | false | The output quality to use for lossy JPEG, WebP and TIFF output formats. The default quality is 80. | 105 | 106 | *** 107 | 108 | # Errors 109 | You can catch errors in error middleware as shown previously. `err` object includes (but not limited to) following error codes (key ` code`). 110 | 111 | | code | role | 112 | | ------ | ------- | 113 | | FILE_TYPE_UNSUPPORTED | Input file type is not acceptable to process. check `accept` option. | 114 | | LIMIT_FILE_SIZE | Input file size is too large. Check `maxFileSize` option. | 115 | 116 | *** 117 | 118 | # Success 119 | Upon successful upload, sharper will add `sharper` object in `res` response object. It will have following properties. 120 | 121 | | key | role | 122 | | --- | ---- | 123 | | dir | `dir` that was created for storing process image. | 124 | | destination | absolute path of storage destination. | 125 | | filename | name of the image files created using sharper. | 126 | 127 | *** 128 | 129 | # Test 130 | - `npm install` 131 | - `npm install -g mocha` 132 | - `npm test` 133 | 134 | #### in practice 135 | - `npm install -g bower` 136 | - `bower install` 137 | - Open terminal and run `node test-server.js` in demo folder of this module. 138 | - Open your browser and go to `http://localhost:8800`. 139 | - Upload a photo by clicking on dropzone. 140 | - If upload sucessfully completes, check upload directory `/var/www/html`. 141 | - If error occurs, check your terminal. 142 | 143 | *** 144 | 145 | If you are facing node-gyp related error, go to `node_modules/sharper/node_modules/sharp` and use cmd command `node-gyp rebuild`. Make sure you have `node-gyp` installed or use `npm install -g node-gyp` 146 | -------------------------------------------------------------------------------- /bower.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sharper", 3 | "description": "Automatic image processor built on top of sharp and multer for express.", 4 | "main": "index.js", 5 | "authors": [ 6 | "Uday Hiwarale (https://github.com/thatisuday)" 7 | ], 8 | "license": "ISC", 9 | "homepage": "https://github.com/thatisuday/sharper", 10 | "ignore": [ 11 | "**/.*", 12 | "node_modules", 13 | "bower_components", 14 | "test", 15 | "tests" 16 | ], 17 | "devDependencies": { 18 | "ng-dropzone": "ngdropzone#^1.0.5" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /demo/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Sharper test 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 36 | 37 | -------------------------------------------------------------------------------- /demo/test-server.js: -------------------------------------------------------------------------------- 1 | const express = require('express'); 2 | const sharper = require('../index'); 3 | 4 | var app = express(); 5 | 6 | var Sharper = sharper(); 7 | 8 | // Upload route 9 | app.post('/upload', Sharper, function(err, req, res, next){ 10 | console.log(err); 11 | res.status(500).send('upload failed...'); 12 | }, function(req, res){ 13 | console.log(res.sharper); 14 | res.send('done...'); 15 | }); 16 | 17 | // Static route 18 | app.use('/bower', express.static(__dirname + '/../bower_components')); 19 | 20 | // Test page 21 | app.get('/', function(req, res){ 22 | res.sendFile(__dirname + '/index.html'); 23 | }); 24 | 25 | app.listen(8800, function(){ 26 | console.log('test server is listening...'); 27 | }); -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @module sharper 3 | * @desc

Automatic image processor built on top of 4 | * sharp and multer

5 | * @author Uday Hiwarale 6 | * @version v1.0.0 7 | * 8 | * @requires graceful-fs 9 | * @requires multer 10 | * @requires sharp 11 | * @requires lodash 12 | * @requires async 13 | * @requires randomstring 14 | * @requires bytes 15 | * @requires mime-types 16 | **/ 17 | 18 | const 19 | fs = require('graceful-fs'), 20 | multer = require('multer'), 21 | sharp = require('sharp'), 22 | _ = require('lodash'), 23 | async = require('async'), 24 | dateformat = require('dateformat') 25 | randomstring = require('randomstring'), 26 | bytes = require('bytes'), 27 | mime = require('mime-types') 28 | ; 29 | 30 | 31 | /** 32 | * @function 33 | * @desc Custom error object to throw error with custom fields 34 | * @param {String} [message] Message to be attached to the error 35 | * @param {String} [code] Error code 36 | * @param {String} [field] Extra information field 37 | **/ 38 | function sError(message, code, field) { 39 | this.name = 'Error'; 40 | this.message = message || 'error occurred.'; 41 | this.code = code || null; 42 | this.field = field || null; 43 | } 44 | sError.prototype = Object.create(Error.prototype); 45 | sError.prototype.constructor = sError; 46 | 47 | 48 | /** 49 | * @function sharper 50 | * @desc sharper function containing all ingredients 51 | * 52 | * @param {Object} options sharper configurations 53 | * @returns {Function} 54 | **/ 55 | var sharper = function(options){ 56 | 57 | /** 58 | * @var 59 | * @desc Default sharper configuration options 60 | **/ 61 | var defaultOptions = { 62 | 63 | /** 64 | * @member {string} 65 | * @desc name of the image file field in multipart for data 66 | **/ 67 | field : 'file', 68 | 69 | /** 70 | * @member {string} 71 | * @desc location of file upload 72 | **/ 73 | location : '/var/www/uploads/', 74 | 75 | /** 76 | * @member {string} 77 | * @desc date-format to create upload directory 78 | **/ 79 | dirFormat : 'yyyy/mmm/d', 80 | 81 | /** 82 | * @member {Number} 83 | * @desc length of the filename to be created 84 | **/ 85 | fileNameLen : 50, 86 | 87 | /** 88 | * @member {string} 89 | * @desc maximum size of the file to be uploaded 90 | **/ 91 | maxFileSize : '10mb', 92 | 93 | /** 94 | * @member {Array} 95 | * @desc type of files to be accepted (file extensions) 96 | **/ 97 | accept : ['png','jpeg','jpg'], 98 | 99 | /** 100 | * @member {string} 101 | * @desc output extension of the image file 102 | **/ 103 | output : 'jpg', 104 | 105 | /** 106 | * @member {Array} 107 | * @desc output images sizes and name suffix 108 | **/ 109 | sizes : [ 110 | {suffix : 'lg', width : 500, height:500}, 111 | ], 112 | 113 | /* 114 | * sharp-libvips options 115 | * to process an image 116 | **/ 117 | resize : true, 118 | crop : false, 119 | background : {r:200, g:200, b:200, a:1}, 120 | embed : false, 121 | max : false, 122 | min : false, 123 | withoutEnlargement : false, 124 | ignoreAspectRatio : false, 125 | extract : false, 126 | trim : false, 127 | flatten : false, 128 | extend : false, 129 | negate : false, 130 | rotate : false, 131 | flip : false, 132 | flop : false, 133 | blur : false, 134 | sharpen : false, 135 | gamma : false, 136 | grayscale : false, 137 | greyscale : false, 138 | normalize : false, 139 | normalise : false, 140 | progressive : false, 141 | quality : false, 142 | }; 143 | 144 | 145 | /** 146 | * @var 147 | * @desc Transformed options to be applied to sharper 148 | **/ 149 | var options = _.assign(defaultOptions, options); 150 | 151 | 152 | /********************************************************************/ 153 | 154 | 155 | /** 156 | * @function middleware 157 | * @desc Express middleware function to be returned by sharper 158 | **/ 159 | return function(req, res, next){ 160 | 161 | /** 162 | * @name waterfall 163 | * @desc using async waterfall function, 164 | * run multiple tasks in series 165 | **/ 166 | async.waterfall( 167 | [ 168 | /** 169 | * @function masterUpload 170 | * @desc Upload master image file using multer 171 | * @param {Function} callback async callback function 172 | **/ 173 | function(callback){ 174 | // Create config variables 175 | var dir = dateformat(new Date(), options.dirFormat); 176 | var destination = options.location + dir; 177 | var filename = randomstring.generate( 178 | options.fileNameLen 179 | ); 180 | 181 | // Create master upload function 182 | var masterUploader = multer({ 183 | storage : multer.diskStorage({ 184 | destination: destination, 185 | filename: function(req, file, cb){ 186 | cb(null, filename); 187 | } 188 | }), 189 | limits : { 190 | // this will return error object 191 | fileSize : bytes(options.maxFileSize), 192 | files : 1 193 | }, 194 | fileFilter : function(req, file, cb){ 195 | var fileExt = mime.extension(file.mimetype); 196 | if(!_.includes(options.accept, fileExt)){ 197 | cb(new sError('file not acceptable', 'FILE_TYPE_UNSUPPORTED', fileExt)); 198 | } 199 | else{ 200 | cb(null, true); 201 | } 202 | } 203 | }).single(options.field); 204 | 205 | // Run master uploader 206 | masterUploader(req, res, function(err){ 207 | if(err) return callback(err); 208 | 209 | callback(null, { 210 | dir : dir, 211 | destination : destination, 212 | filename : filename 213 | }); 214 | }); 215 | }, 216 | 217 | 218 | /** 219 | * @function processImages 220 | * @desc Process all images in sharp 221 | * @param {Object} state upload state object received from 222 | * masterUpload callback function 223 | * @param {Function} callback async callback function 224 | **/ 225 | function(state, callback){ 226 | // Get instance of sharp with master image file 227 | var master = sharp(state.destination + '/' + state.filename); 228 | 229 | // Process images with sizes [in config options] 230 | async.each( 231 | options.sizes, 232 | function(size, _cb){ 233 | // resize by default 234 | var $query = master.background(options.background); 235 | 236 | // check resize 237 | if(options.resize == true){ 238 | $query = $query.resize(size.width, size.height); 239 | } 240 | 241 | // check crop (on valid crop option) 242 | if(options.crop != false && _.has(sharp.gravity, options.crop)){ 243 | $query = $query.crop(sharp.gravity[options.crop]); 244 | } 245 | 246 | // check embed 247 | if(options.embed == true){ 248 | $query = $query.embed(); 249 | } 250 | 251 | // check max 252 | if(options.max == true){ 253 | $query = $query.max(); 254 | } 255 | 256 | // check min 257 | if(options.min == true){ 258 | $query = $query.min(); 259 | } 260 | 261 | // check withoutEnlargement 262 | if(options.withoutEnlargement == true){ 263 | $query = $query.withoutEnlargement(); 264 | } 265 | 266 | // check ignoreAspectRatio 267 | if(options.ignoreAspectRatio == true){ 268 | $query = $query.ignoreAspectRatio(); 269 | } 270 | 271 | // check extract 272 | if(options.extract != false){ 273 | $query = $query.extract(options.extract); 274 | } 275 | 276 | // check trim 277 | if(options.trim != false){ 278 | $query = $query.trim(_.toInteger(options.trim)); 279 | } 280 | 281 | // check flatten 282 | if(options.flatten == true){ 283 | $query = $query.flatten(); 284 | } 285 | 286 | // check extend 287 | if(options.extend != false){ 288 | $query = $query.extend(options.extend); 289 | } 290 | 291 | // check negate 292 | if(options.negate == true){ 293 | $query = $query.negate(); 294 | } 295 | 296 | // check rotate 297 | if(_.includes([0,90,180,270], options.rotate)){ 298 | $query = $query.rotate(options.rotate); 299 | } 300 | 301 | // check flip 302 | if(options.flip == true){ 303 | $query = $query.flip(); 304 | } 305 | 306 | // check flop 307 | if(options.flop == true){ 308 | $query = $query.flop(); 309 | } 310 | 311 | // check blur 312 | if(options.blur != false){ 313 | if(options.blur == true) $query = $query.blur(); 314 | else $query = $query.blur(_.toNumber(options.blur)); 315 | } 316 | 317 | // check sharpen 318 | if(options.sharpen == true){ 319 | $query = $query.sharpen(); 320 | } 321 | 322 | // check gamma 323 | if(options.gamma != false){ 324 | if(options.gamma == true) $query = $query.gamma(); 325 | else $query = $query.gamma(_.toNumber(options.gamma)); 326 | } 327 | 328 | // check grayscale 329 | if(options.grayscale == true || options.greyscale == true){ 330 | $query = $query.grayscale(); 331 | } 332 | 333 | // check normalize 334 | if(options.normalize == true || options.normalise == true){ 335 | $query = $query.normalize(); 336 | } 337 | 338 | // check quality 339 | if(options.quality != false){ 340 | $query = $query.quality(_.toInteger(options.quality)); 341 | } 342 | 343 | // check progressive 344 | if(options.progressive == true){ 345 | $query = $query.progressive(); 346 | } 347 | 348 | 349 | // run query 350 | $query.toFile( 351 | state.destination + '/' + state.filename + '.' + 352 | size.suffix + '.' + options.output, 353 | function(err){ 354 | if(err) return _cb(err) 355 | _cb(null); 356 | } 357 | ); 358 | }, 359 | 360 | // each callback 361 | function(err){ 362 | if(err) return callback(err); 363 | callback(null, state); 364 | } 365 | ); 366 | }, 367 | 368 | 369 | /** 370 | * @function deleteMaster 371 | * @desc Delete master image file from file system 372 | * @param {Object} state upload state object received from 373 | * masterUpload callback function 374 | * @param {Function} callback async callback function 375 | **/ 376 | function(state, callback){ 377 | // Unlock master image 378 | sharp.cache(false); 379 | 380 | // Unlink file 381 | fs.unlink(state.destination + '/' + state.filename, function(err){ 382 | if(err) return callback(err); 383 | callback(null, state); 384 | }); 385 | } 386 | ], 387 | 388 | 389 | /** 390 | * @function waterfallCallback 391 | * @desc callback function for async watefall 392 | * @param {Error} err Error received from waterfall functions 393 | * @param {Function} state upload state object received from 394 | * deleteMaster callback function 395 | **/ 396 | function(err, state){ 397 | // Call next error middleware 398 | if(err) return next(err); 399 | 400 | // Add state to express response object 401 | res.sharper = state; 402 | 403 | // Call next middleware 404 | next(); 405 | } 406 | ); 407 | } 408 | } 409 | 410 | 411 | /**********************************************************************/ 412 | 413 | 414 | /** 415 | * Export sharper function 416 | **/ 417 | module.exports = exports = sharper; -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sharper", 3 | "version": "1.0.2", 4 | "description": "Automatic image processor built on top of sharp and multer for express.", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "mocha tests/full.js --timeout=10000" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/thatisuday/sharper.git" 12 | }, 13 | "author": "Uday Hiwarale (https://github.com/thatisuday)", 14 | "license": "ISC", 15 | "bugs": { 16 | "url": "https://github.com/thatisuday/sharper/issues" 17 | }, 18 | "homepage": "https://github.com/thatisuday/sharper#readme", 19 | "dependencies": { 20 | "async": "^2.0.0", 21 | "bytes": "^2.4.0", 22 | "dateformat": "^1.0.12", 23 | "graceful-fs": "^4.1.4", 24 | "lodash": "^4.13.1", 25 | "mime-types": "^2.1.11", 26 | "multer": "^1.1.0", 27 | "randomstring": "^1.1.5", 28 | "sharp": "^0.15.1" 29 | }, 30 | "devDependencies": { 31 | "chai": "^3.5.0", 32 | "chai-files": "^1.4.0", 33 | "express": "^4.14.0", 34 | "image-size": "^0.5.0", 35 | "rimraf": "^2.5.3", 36 | "supertest": "^1.2.0" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /tests/full.js: -------------------------------------------------------------------------------- 1 | const http = require('http'); 2 | const fs = require('fs'); 3 | const supertest = require('supertest'); 4 | const chai = require('chai'); 5 | const chaiFiles = require('chai-files'); 6 | const express = require('express'); 7 | const sharper = require('../index'); 8 | const sizeOf = require('image-size'); 9 | const rimraf = require('rimraf') 10 | 11 | chai.use(chaiFiles); 12 | 13 | var expect = chai.expect; 14 | var file = chaiFiles.file; 15 | var dir = chaiFiles.dir; 16 | 17 | var request = supertest('localhost:8800'); 18 | var app = express(); 19 | var Sharper = sharper({ 20 | field : 'image', 21 | location : __dirname + '/upload/', 22 | output : 'png', 23 | sizes : [ 24 | {suffix : 'xxs', width : 50, height: 50} 25 | ] 26 | }); 27 | 28 | // Set ping route 29 | app.get('/', function(req, res){ 30 | res.sendStatus(204); 31 | }); 32 | 33 | // Set upload route 34 | app.post('/upload', Sharper, function(err, req, res, next){ 35 | res.sendStatus(500); 36 | }, function(req, res){ 37 | res.status(201).json(res.sharper); 38 | }); 39 | 40 | 41 | /*****************************************************/ 42 | 43 | 44 | describe('Sharper', function(){ 45 | 46 | //run express server before all tests 47 | before(function(done){ 48 | app.listen(8800, function(){ 49 | done(); 50 | }); 51 | }); 52 | 53 | 54 | // test server ping 55 | it('should return status code 204 on ping', function(done){ 56 | http.get('http://127.0.0.1:8800/', function(res){ 57 | expect(res.statusCode).to.equal(204); 58 | done(); 59 | }).on('err', function(){ 60 | throw new Error('server is not reachable.'); 61 | process.exit(1); 62 | }); 63 | }); 64 | 65 | 66 | it('should return status code 201 on file upload', function(done){ 67 | request 68 | .post('/upload') 69 | .attach('image', __dirname + '/test-file.jpg') 70 | .end(function(err, res){ 71 | expect(res.statusCode).to.equal(201); 72 | expect(res.body).to.have.property('filename'); 73 | 74 | done(); 75 | }); 76 | }); 77 | 78 | 79 | it('should verify if file exists on the file system', function(done){ 80 | request 81 | .post('/upload') 82 | .attach('image', __dirname + '/test-file.jpg') 83 | .end(function(err, res){ 84 | var uploadedFile = res.body.destination + '/' + res.body.filename + '.xxs.png'; 85 | expect(file(uploadedFile)).to.exist; 86 | done(); 87 | }); 88 | }); 89 | 90 | 91 | it('png should have 50x50 image dimension', function(done){ 92 | request 93 | .post('/upload') 94 | .attach('image', __dirname + '/test-file.jpg') 95 | .end(function(err, res){ 96 | var uploadedFile = res.body.destination + '/' + res.body.filename + '.xxs.png'; 97 | var dimensions = sizeOf(uploadedFile); 98 | 99 | expect(dimensions.type).to.equal('png'); 100 | expect(dimensions.width).to.equal(50); 101 | expect(dimensions.height).to.equal(50); 102 | 103 | done(); 104 | }); 105 | }); 106 | 107 | 108 | // clean upload directory 109 | // close node processes after all test done 110 | after(function(done){ 111 | setTimeout(function(){ 112 | rimraf(__dirname + '/upload/', {unlinkSync:true}, function(){ 113 | done(); 114 | process.exit(0); 115 | }); 116 | }); 117 | }); 118 | }); 119 | 120 | --------------------------------------------------------------------------------