@scaleflex/widget-thumbnail-generator 0.0.1

package/lib/defaultLocale.js

@@ -0,0 +1,4 @@
+export default {
+  thumbnailGeneratorGeneratingThumbnailsMessage: 'Generating thumbnails...',
+  thumbnailGeneratorThumbnailGenerationFailed: 'Unable to load thumbnail of the file %{file_name}.'
+};

package/lib/index.js

@@ -0,0 +1,481 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { Plugin } from '@scaleflex/widget-core';
+import Translator from '@scaleflex/widget-utils/lib/Translator';
+import dataURItoBlob from '@scaleflex/widget-utils/lib/dataURItoBlob';
+import isObjectURL from '@scaleflex/widget-utils/lib/isObjectURL';
+import isThumbnailLocallySupported from '@scaleflex/widget-utils/lib/isThumbnailLocallySupported';
+import isPhotoshopFile from '@scaleflex/widget-utils/lib/isPhotoshopFile';
+import generatePsdThumbnail from '@scaleflex/widget-utils/lib/generatePsdThumbnail/generatePsdThumbnail';
+import MathLog2 from 'math-log2';
+import IMAGE from '../assets/CHECKERED_BACKGROUND.svg';
+import defaultLocale from './defaultLocale';
+// TODO: find a way to show version of the current plugin
+// why solution below isn't good?
+// first import doesn't work with webpack 5 as it was deprecated
+// second import fixes webpack 5 issue as it was mentioned in their docs
+// but it exposes our package.json to the client and it is mentioned as security rist in mutiple places
+// https://github.com/axelpale/genversion
+// https://stackoverflow.com/questions/64993118/error-should-not-import-the-named-export-version-imported-as-version
+// https://stackoverflow.com/questions/9153571/is-there-a-way-to-get-version-from-package-json-in-nodejs-code/10855054#10855054
+// import { version } from '../package.json'
+// import packageInfo from '../package.json'
+
+/**
+ * The Thumbnail Generator plugin
+ */
+var ThumbnailGenerator = /*#__PURE__*/function (_Plugin) {
+  // static VERSION = packageInfo.version
+
+  function ThumbnailGenerator(filerobot) {
+    var _this;
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, ThumbnailGenerator);
+    _this = _callSuper(this, ThumbnailGenerator, [filerobot, opts]);
+    _defineProperty(_this, "onFileAdded", function (file) {
+      if (!file.preview && isThumbnailLocallySupported(file) && !file.isRemote && file.id) {
+        _this.addToQueue(file.id);
+      }
+    });
+    _defineProperty(_this, "onThumbnailUpdateRequest", function (file) {
+      if (isThumbnailLocallySupported(file) && !file.isRemote) {
+        if (file.preview && isObjectURL(file.preview)) {
+          URL.revokeObjectURL(file.preview);
+        }
+        _this.addToQueue(file.id);
+      }
+    });
+    /**
+     * Cancel a lazy request for a thumbnail if the thumbnail has not yet been generated.
+     */
+    _defineProperty(_this, "onCancelRequest", function (file) {
+      var index = _this.queue.indexOf(file.id);
+      if (index !== -1) {
+        _this.queue.splice(index, 1);
+      }
+    });
+    /**
+     * Clean up the thumbnail for a file. Cancel lazy requests and free the thumbnail URL.
+     */
+    _defineProperty(_this, "onFileRemoved", function (file) {
+      var index = _this.queue.indexOf(file.id);
+      if (index !== -1) {
+        _this.queue.splice(index, 1);
+      }
+
+      // Clean up object URLs.
+      if (file.preview && isObjectURL(file.preview)) {
+        URL.revokeObjectURL(file.preview);
+      }
+    });
+    _defineProperty(_this, "onRestored", function () {
+      var fileIds = _this.filerobot.getUploads();
+      fileIds.forEach(function (fileId) {
+        var file = _this.filerobot.getFileBeforeUpload(fileId);
+        if (!file.isRestored) return;
+        // Only add blob URLs; they are likely invalid after being restored.
+        if (!file.preview || isObjectURL(file.preview)) {
+          _this.addToQueue(file.id);
+        }
+      });
+    });
+    _defineProperty(_this, "waitUntilAllProcessed", function (fileIds) {
+      fileIds.forEach(function (fileId) {
+        var file = _this.filerobot.getFileBeforeUpload(fileId);
+        _this.filerobot.emit('preprocess-progress', file, {
+          mode: 'indeterminate',
+          message: _this.i18n('thumbnailGeneratorGeneratingThumbnailsMessage')
+        });
+      });
+      var emitPreprocessCompleteForAll = function emitPreprocessCompleteForAll() {
+        fileIds.forEach(function (fileId) {
+          var file = _this.filerobot.getFileBeforeUpload(fileId);
+          _this.filerobot.emit('preprocess-complete', file);
+        });
+      };
+      return new Promise(function (resolve, reject) {
+        if (_this.queueProcessing) {
+          _this.filerobot.once('thumbnail:all-generated', function () {
+            emitPreprocessCompleteForAll();
+            resolve();
+          });
+        } else {
+          emitPreprocessCompleteForAll();
+          resolve();
+        }
+      });
+    });
+    _this.type = 'modifier';
+    _this.invisible = true;
+    _this.id = _this.opts.id || 'ThumbnailGenerator';
+    _this.title = 'Thumbnail Generator';
+    _this.queue = [];
+    _this.queueProcessing = false;
+    _this.transparencyBackground = null;
+    _this.defaultLocale = {
+      strings: defaultLocale
+    };
+    var defaultOptions = {
+      thumbnailWidth: 200,
+      thumbnailHeight: 170,
+      waitForThumbnailsBeforeUpload: false,
+      lazy: false
+    };
+    _this.opts = _objectSpread(_objectSpread({}, defaultOptions), opts);
+    if (_this.opts.lazy && _this.opts.waitForThumbnailsBeforeUpload) {
+      throw new Error('ThumbnailGenerator: The `lazy` and `waitForThumbnailsBeforeUpload` options are mutually exclusive. Please ensure at most one of them is set to `true`.');
+    }
+    _this.i18nInit();
+    return _this;
+  }
+  _inherits(ThumbnailGenerator, _Plugin);
+  return _createClass(ThumbnailGenerator, [{
+    key: "i18nInit",
+    value: function i18nInit() {
+      this.translator = new Translator([this.defaultLocale, this.filerobot.locale, this.opts.locale]);
+      this.i18n = this.translator.translate.bind(this.translator);
+    }
+
+    /**
+     * Create a thumbnail for the given Filerobot file object.
+     *
+     * @param {{data: Blob}} file
+     * @param {number} targetWidth
+     * @param {number} targetHeight
+     * @returns {Promise}
+     */
+  }, {
+    key: "createThumbnail",
+    value: function createThumbnail(file, targetWidth, targetHeight) {
+      var _this2 = this;
+      var originalUrl = isPhotoshopFile(file) ? generatePsdThumbnail(file.data).then(function (thumbnail) {
+        return thumbnail;
+      })["catch"](function (err) {
+        return err.message;
+      }) : Promise.resolve(URL.createObjectURL(file.data));
+      var loadPreviewImg = function loadPreviewImg(previewUrl) {
+        return new Promise(function (resolve, reject) {
+          var image = new Image();
+          image.src = previewUrl;
+          image.addEventListener('load', function () {
+            URL.revokeObjectURL(originalUrl);
+            resolve(image);
+          });
+          image.addEventListener('error', function (event) {
+            URL.revokeObjectURL(originalUrl);
+            reject(event.error || new Error('Could not create thumbnail'));
+          });
+        });
+      };
+      return originalUrl.then(loadPreviewImg).then(function (image) {
+        var dimensions = _this2.getProportionalDimensions(image, targetWidth, targetHeight);
+        return _this2.addBackground(file, image, dimensions.width, dimensions.height).then(function (canvas) {
+          return _this2.canvasToBlob(canvas, 'image/png', 80);
+        });
+      }).then(function (blob) {
+        return URL.createObjectURL(blob);
+      });
+    }
+
+    /**
+     * Get the new calculated dimensions for the given image and a target width
+     * or height. If both width and height are given, only width is taken into
+     * account. If neither width nor height are given, the default dimension
+     * is used.
+     */
+  }, {
+    key: "getProportionalDimensions",
+    value: function getProportionalDimensions(img, width, height) {
+      var aspectRatio = img.width / img.height;
+      if (img.width >= img.height) {
+        return {
+          width: width,
+          height: Math.round(width / aspectRatio)
+        };
+      }
+      if (img.height > img.width) {
+        return {
+          width: Math.round(height * aspectRatio),
+          height: height
+        };
+      }
+    }
+
+    /**
+     * Make sure the image doesn’t exceed browser/device canvas limits.
+     * For ios with 256 RAM and ie
+     */
+  }, {
+    key: "protect",
+    value: function protect(image) {
+      // https://stackoverflow.com/questions/6081483/maximum-size-of-a-canvas-element
+
+      var ratio = image.width / image.height;
+      var maxSquare = 5000000; // ios max canvas square
+      var maxSize = 4096; // ie max canvas dimensions
+
+      var maxW = Math.floor(Math.sqrt(maxSquare * ratio));
+      var maxH = Math.floor(maxSquare / Math.sqrt(maxSquare * ratio));
+      if (maxW > maxSize) {
+        maxW = maxSize;
+        maxH = Math.round(maxW / ratio);
+      }
+      if (maxH > maxSize) {
+        maxH = maxSize;
+        maxW = Math.round(ratio * maxH);
+      }
+      if (image.width > maxW) {
+        var canvas = document.createElement('canvas');
+        canvas.width = maxW;
+        canvas.height = maxH;
+        canvas.getContext('2d').drawImage(image, 0, 0, maxW, maxH);
+        image = canvas;
+      }
+      return image;
+    }
+
+    /**
+     * Resize an image to the target `width` and `height`.
+     *
+     * Returns a Canvas with the resized image on it.
+     */
+  }, {
+    key: "resizeImage",
+    value: function resizeImage(image, targetWidth, targetHeight) {
+      // Resizing in steps refactored to use a solution from
+      // https://blog.uploadcare.com/image-resize-in-browsers-is-broken-e38eed08df01
+
+      image = this.protect(image);
+      var steps = Math.ceil(MathLog2(image.width / targetWidth));
+      if (steps < 1) {
+        steps = 1;
+      }
+      var sW = targetWidth * Math.pow(2, steps - 1);
+      var sH = targetHeight * Math.pow(2, steps - 1);
+      var x = 2;
+      while (steps--) {
+        var canvas = document.createElement('canvas');
+        canvas.width = sW;
+        canvas.height = sH;
+        canvas.getContext('2d').drawImage(image, 0, 0, sW, sH);
+        image = canvas;
+        sW = Math.round(sW / x);
+        sH = Math.round(sH / x);
+      }
+      return image;
+    }
+  }, {
+    key: "draw",
+    value: function draw(image, background) {
+      var imgWidth = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
+      var imgHeight = arguments.length > 3 ? arguments[3] : undefined;
+      var canvas = arguments.length > 4 ? arguments[4] : undefined;
+      var ctx = arguments.length > 5 ? arguments[5] : undefined;
+      ctx.drawImage(background, 0, 0, this.opts.thumbnailWidth, this.opts.thumbnailHeight);
+      if (ctx.filter === 'blur(6px)') {
+        ctx.filter = 'none';
+      }
+      ctx.drawImage(image, canvas.width / 2 - imgWidth / 2, canvas.height / 2 - imgHeight / 2, imgWidth, imgHeight);
+    }
+
+    /**
+     * Makes sure that the image dimensions wouldn't exceed the limits &
+     * Adds a blurry background of the image to the target `width` and `height`.
+     *
+     * adds a Canvas with the image and checkered or blurry background.
+     */
+  }, {
+    key: "addBackground",
+    value: function addBackground(file, image, targetWidth, targetHeight) {
+      var _this3 = this;
+      return new Promise(function (resolve, reject) {
+        image = _this3.protect(image);
+        var imgWidth = image.width;
+        var imgHeight = image.height;
+        var canvas = document.createElement('canvas');
+        canvas.width = _this3.opts.thumbnailWidth;
+        canvas.height = _this3.opts.thumbnailHeight;
+        var ctx = canvas.getContext('2d');
+        if (imgWidth > targetWidth || imgHeight > targetHeight) {
+          var imgRatio = imgWidth / imgHeight;
+          if (imgHeight > imgWidth) {
+            imgHeight = targetHeight;
+            imgWidth = imgHeight * imgRatio;
+          } else {
+            imgWidth = targetWidth;
+            imgHeight = imgWidth / imgRatio;
+          }
+          image = _this3.resizeImage(image, targetWidth, targetHeight);
+          imgHeight = image.height;
+          imgWidth = image.width;
+        }
+        if (file.extension === 'svg' || file.extension === 'png') {
+          if (!_this3.transparencyBackground) {
+            _this3.transparencyBackground = new Image();
+            _this3.transparencyBackground.crossOrigin = 'Anonymous';
+            _this3.transparencyBackground.src = IMAGE;
+            _this3.transparencyBackground.onload = function () {
+              _this3.draw(image, _this3.transparencyBackground, imgWidth, imgHeight, canvas, ctx);
+              resolve(canvas);
+            };
+            _this3.transparencyBackground.onerror = function () {
+              reject(new Error(_this3.i18n('thumbnailGeneratorThumbnailGenerationFailed', {
+                file_name: (file === null || file === void 0 ? void 0 : file.name) || ''
+              })));
+            };
+          } else {
+            _this3.draw(image, _this3.transparencyBackground, imgWidth, imgHeight, canvas, ctx);
+            resolve(canvas);
+          }
+        } else {
+          ctx.filter = 'blur(6px)';
+          _this3.draw(image, image, imgWidth, imgHeight, canvas, ctx);
+          resolve(canvas);
+        }
+      });
+    }
+
+    /**
+     * Save a <canvas> element's content to a Blob object.
+     *
+     * @param {HTMLCanvasElement} canvas
+     * @returns {Promise}
+     */
+  }, {
+    key: "canvasToBlob",
+    value: function canvasToBlob(canvas, type, quality) {
+      try {
+        canvas.getContext('2d').getImageData(0, 0, 1, 1);
+      } catch (err) {
+        if (err.code === 18) {
+          return Promise.reject(new Error('cannot read image, probably an svg with external resources'));
+        }
+      }
+      if (canvas.toBlob) {
+        return new Promise(function (resolve) {
+          canvas.toBlob(resolve, type, quality);
+        }).then(function (blob) {
+          if (blob === null) {
+            throw new Error('cannot read image, probably an svg with external resources');
+          }
+          return blob;
+        });
+      }
+      return Promise.resolve().then(function () {
+        return dataURItoBlob(canvas.toDataURL(type, quality), {});
+      }).then(function (blob) {
+        if (blob === null) {
+          throw new Error('could not extract blob, probably an old browser');
+        }
+        return blob;
+      });
+    }
+
+    /**
+     * Set the preview URL for a file.
+     */
+  }, {
+    key: "setPreviewURL",
+    value: function setPreviewURL(fileId, preview) {
+      this.filerobot.setFileStateBeforeUpload(fileId, {
+        preview: preview
+      });
+    }
+  }, {
+    key: "addToQueue",
+    value: function addToQueue(item) {
+      this.queue.push(item);
+      if (this.queueProcessing === false) {
+        this.processQueue();
+      }
+    }
+  }, {
+    key: "processQueue",
+    value: function processQueue() {
+      var _this4 = this;
+      this.queueProcessing = true;
+      if (this.queue.length > 0) {
+        var current = this.filerobot.getFileBeforeUpload(this.queue.shift());
+        if (!current) {
+          this.filerobot.log('[ThumbnailGenerator] file was removed before a thumbnail could be generated, but not removed from the queue. This is probably a bug', 'error');
+          return;
+        }
+        return this.requestThumbnail(current)["catch"](function (err) {
+          return err;
+        }) // eslint-disable-line handle-callback-err
+        .then(function () {
+          return _this4.processQueue();
+        });
+      } else {
+        this.queueProcessing = false;
+        this.filerobot.log('[ThumbnailGenerator] Emptied thumbnail queue');
+        this.filerobot.emit('thumbnail:all-generated');
+      }
+    }
+  }, {
+    key: "requestThumbnail",
+    value: function requestThumbnail(file) {
+      var _this5 = this;
+      if (isThumbnailLocallySupported(file) && !file.isRemote) {
+        return this.createThumbnail(file, this.opts.thumbnailWidth, this.opts.thumbnailHeight).then(function (preview) {
+          _this5.setPreviewURL(file.id, preview);
+          _this5.filerobot.log("[ThumbnailGenerator] Generated thumbnail for ".concat(file.id));
+          _this5.filerobot.emit('thumbnail:generated', _this5.filerobot.getFileBeforeUpload(file.id), preview);
+        })["catch"](function (err) {
+          _this5.filerobot.log("[ThumbnailGenerator] Failed thumbnail for ".concat(file.id, ":"), 'warning');
+          _this5.filerobot.log(err, 'warning');
+          _this5.filerobot.info(err.message, 'warning');
+          _this5.filerobot.emit('thumbnail:error', _this5.filerobot.getFileBeforeUpload(file.id), err);
+        });
+      }
+      return Promise.resolve();
+    }
+  }, {
+    key: "install",
+    value: function install() {
+      this.filerobot.on('file-removed', this.onFileRemoved);
+      this.filerobot.on('thumbnail:update', this.onThumbnailUpdateRequest);
+      if (this.opts.lazy) {
+        this.filerobot.on('thumbnail:request', this.onFileAdded);
+        this.filerobot.on('thumbnail:cancel', this.onCancelRequest);
+      } else {
+        this.filerobot.on('file-added', this.onFileAdded);
+        this.filerobot.on('restored', this.onRestored);
+      }
+      if (this.opts.waitForThumbnailsBeforeUpload) {
+        this.filerobot.addPreProcessor(this.waitUntilAllProcessed);
+      }
+    }
+  }, {
+    key: "uninstall",
+    value: function uninstall() {
+      this.filerobot.off('file-removed', this.onFileRemoved);
+      if (this.opts.lazy) {
+        this.filerobot.off('thumbnail:request', this.onFileAdded);
+        this.filerobot.off('thumbnail:cancel', this.onCancelRequest);
+      } else {
+        this.filerobot.off('file-added', this.onFileAdded);
+        this.filerobot.off('thumbnail:update', this.onThumbnailUpdateRequest);
+        this.filerobot.off('restored', this.onRestored);
+      }
+      if (this.opts.waitForThumbnailsBeforeUpload) {
+        this.filerobot.removePreProcessor(this.waitUntilAllProcessed);
+      }
+    }
+  }]);
+}(Plugin);
+export { ThumbnailGenerator as default };

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@scaleflex/widget-thumbnail-generator",
+  "description": "Scaleflex plugin that generates small previews of images to show on your upload UI.",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "types/index.d.ts",
+  "files": [
+    "/dist",
+    "/lib",
+    "/types",
+    "/assets"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@scaleflex/widget-utils": "^0.0.1",
+    "math-log2": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@scaleflex/widget-core": "^0.0.0"
+  },
+  "gitHead": "64ea82e745b7deda36d6794863350e6671e9010d"
+}

package/types/index.d.ts

@@ -0,0 +1,16 @@
+import Filerobot = require("@scaleflex/widget-core");
+import ThumbnailGeneratorLocale = require("./generatedLocale");
+
+declare module ThumbnailGenerator {
+  interface ThumbnailGeneratorOptions extends Filerobot.PluginOptions {
+    thumbnailWidth?: number;
+    thumbnailHeight?: number;
+    waitForThumbnailsBeforeUpload?: boolean;
+    lazy?: boolean;
+    locale?: ThumbnailGeneratorLocale;
+  }
+}
+
+declare class ThumbnailGenerator extends Filerobot.Plugin<ThumbnailGenerator.ThumbnailGeneratorOptions> {}
+
+export = ThumbnailGenerator;