@tryghost/image-transform 1.0.14

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2021 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# Image Transform
+
+## Install
+
+`npm install @tryghost/image-transform --save`
+
+or
+
+`yarn add @tryghost/image-transform`
+
+
+## Usage
+
+
+## Develop
+
+This is a mono repository, managed with [lerna](https://lernajs.io/).
+
+Follow the instructions for the top-level repo.
+1. `git clone` this repo & `cd` into it as usual
+2. Run `yarn` to install top-level dependencies.
+
+
+## Run
+
+- `yarn dev`
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+
+
+
+
+# Copyright & License
+
+Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/transform');

package/lib/transform.js

@@ -0,0 +1,105 @@
+const Promise = require('bluebird');
+const errors = require('@tryghost/errors');
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * Check if this tool can handle any file transformations as Sharp is an optional dependency
+ */
+const canTransformFiles = () => {
+    try {
+        require('sharp');
+        return true;
+    } catch (err) {
+        return false;
+    }
+};
+
+/**
+ * Check if this tool can handle a particular extension
+ * NOTE: .gif optimization is currently not supported by sharp but will be soon
+ *       as there has been support added in underlying libvips library https://github.com/lovell/sharp/issues/1372
+ *       As for .svg files, sharp only supports conversion to png, and this does not
+ *       play well with animated svg files
+ * @param {String} ext the extension to check, including the leading dot
+ */
+const canTransformFileExtension = ext => !['.gif', '.svg', '.svgz', '.ico'].includes(ext);
+
+/**
+  * @NOTE: Sharp cannot operate on the same image path, that's why we have to use in & out paths.
+  *
+  * We currently can't enable compression or having more config options, because of
+  * https://github.com/lovell/sharp/issues/1360.
+  *
+  * Resize an image referenced by the `in` path and write it to the `out` path
+  * @param {{in, out, width}} options
+  */
+const unsafeResizeFromPath = (options = {}) => {
+    return fs.readFile(options.in)
+        .then((data) => {
+            return unsafeResizeFromBuffer(data, {
+                width: options.width
+            });
+        })
+        .then((data) => {
+            return fs.writeFile(options.out, data);
+        });
+};
+
+/**
+ * Resize an image
+ *
+ * @param {Buffer} originalBuffer image to resize
+ * @param {{width, height}} options
+ * @returns {Buffer} the resizedBuffer
+ */
+const unsafeResizeFromBuffer = (originalBuffer, {width, height} = {}) => {
+    const sharp = require('sharp');
+    return sharp(originalBuffer)
+        .resize(width, height, {
+            // CASE: dont make the image bigger than it was
+            withoutEnlargement: true
+        })
+        // CASE: Automatically remove metadata and rotate based on the orientation.
+        .rotate()
+        .toBuffer()
+        .then((resizedBuffer) => {
+            return resizedBuffer.length < originalBuffer.length ? resizedBuffer : originalBuffer;
+        });
+};
+
+/**
+ * Internal utility to wrap all transform functions in error handling
+ * Allows us to keep Sharp as an optional dependency
+ *
+ * @param {Function} fn
+ */
+const makeSafe = fn => (...args) => {
+    try {
+        require('sharp');
+    } catch (err) {
+        return Promise.reject(new errors.InternalServerError({
+            message: 'Sharp wasn\'t installed',
+            code: 'SHARP_INSTALLATION',
+            err: err
+        }));
+    }
+    return fn(...args).catch((err) => {
+        throw new errors.InternalServerError({
+            message: 'Unable to manipulate image.',
+            err: err,
+            code: 'IMAGE_PROCESSING'
+        });
+    });
+};
+
+const generateOriginalImageName = (originalPath) => {
+    const parsedFileName = path.parse(originalPath);
+    return path.join(parsedFileName.dir, `${parsedFileName.name}_o${parsedFileName.ext}`);
+};
+
+module.exports.canTransformFiles = canTransformFiles;
+module.exports.canTransformFileExtension = canTransformFileExtension;
+module.exports.generateOriginalImageName = generateOriginalImageName;
+module.exports.resizeFromPath = makeSafe(unsafeResizeFromPath);
+module.exports.resizeFromBuffer = makeSafe(unsafeResizeFromBuffer);

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@tryghost/image-transform",
+  "version": "1.0.14",
+  "repository": "https://github.com/TryGhost/Utils/tree/master/packages/image-transform",
+  "author": "Ghost Foundation",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing c8 mocha './test/**/*.test.js'",
+    "lint": "eslint . --ext .js --cache",
+    "posttest": "yarn lint"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "c8": "7.9.0",
+    "mocha": "9.0.0",
+    "should": "13.2.3",
+    "sinon": "11.0.0"
+  },
+  "dependencies": {
+    "@tryghost/errors": "^0.2.14",
+    "bluebird": "^3.7.2",
+    "fs-extra": "^9.1.0"
+  },
+  "optionalDependencies": {
+    "sharp": "^0.29.0"
+  },
+  "gitHead": "9545d13a14c1b0ac70cd80ee111f66f642eb0a4d"
+}