@scaleflex/widget-pixaforge 4.4.0 → 4.5.1

package/lib/index.js

@@ -0,0 +1,327 @@
+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 Explorer from '@scaleflex/widget-explorer';
+import Translator from '@scaleflex/widget-utils/lib/Translator';
+import { BadgeButton, CloseButton } from '@scaleflex/widget-common';
+import { RequestClient } from '@scaleflex/widget-companion-client';
+import { PixaforgeIcon } from '@scaleflex/widget-icons';
+import { PLUGINS_IDS } from '@scaleflex/widget-utils/lib/constants';
+import defaultLocale from './defaultLocale';
+import MainView from './components/MainView';
+import GalleryViewsOptionsMenu from './components/GalleryViewsOptionsMenu';
+import { GALLERIES } from './constants';
+import pixaforgeReducer, { loadingToggled, pixaforgeCommonStateUpdated, selectGallery } from './common.slice';
+// 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'
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+var Pixaforge = /*#__PURE__*/function (_Plugin) {
+  // static VERSION = packageInfo.version
+
+  function Pixaforge(filerobot) {
+    var _this;
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, Pixaforge);
+    _this = _callSuper(this, Pixaforge, [filerobot, opts]);
+    _defineProperty(_this, "i18nInit", function () {
+      _this.translator = new Translator([_this.defaultLocale, _this.filerobot.locale, _this.opts.locale]);
+      _this.i18n = _this.translator.translate.bind(_this.translator);
+      _this.i18nArray = _this.translator.translateArray.bind(_this.translator);
+    });
+    _defineProperty(_this, "getFileNameFromUrl", function (_ref) {
+      var url = _ref.url,
+        type = _ref.type;
+      return url.substring(url.lastIndexOf('/') + 1) + ".".concat(type.substring(type.lastIndexOf('/') + 1));
+    });
+    _defineProperty(_this, "getMeta", function (url) {
+      return _this.client.post('url/meta', {
+        url: url
+      }).then(function (res) {
+        if (res.error) {
+          _this.filerobot.log('[Pixaforge] Error:');
+          _this.filerobot.log(res.error);
+          throw new Error('Failed to fetch the file');
+        }
+        return res;
+      });
+    });
+    _defineProperty(_this, "addImage", function () {
+      var image = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var url = image.src;
+      if (!url) {
+        return;
+      }
+      return _this.getMeta(url).then(function (meta) {
+        var tagFile = {
+          source: _this.id,
+          name: _this.getFileNameFromUrl({
+            url: url,
+            type: meta.type
+          }),
+          type: meta.type,
+          preview: image.preview,
+          data: {
+            size: meta.size
+          },
+          isRemote: true,
+          body: {
+            url: url
+          },
+          remote: {
+            companionUrl: _this.client.companionUrl,
+            url: "".concat(_this.hostname, "/url/get"),
+            body: {
+              fileId: image.id,
+              url: url
+            },
+            providerOptions: _this.client.opts
+          }
+        };
+        return tagFile;
+      }).then(function (tagFile) {
+        _this.filerobot.log('[Pixaforge] Adding remote file');
+        try {
+          _this.filerobot.addFile(tagFile);
+        } catch (err) {
+          if (!err.isRestriction) {
+            _this.filerobot.log(err);
+          }
+        }
+      })["catch"](function (err) {
+        _this.filerobot.log(err);
+        _this.filerobot.info({
+          message: _this.i18n('pixaforgeFailedToFetchMessage'),
+          details: (err === null || err === void 0 ? void 0 : err.message) || (err === null || err === void 0 ? void 0 : err.toString()) || err
+        }, 'error', 5000);
+      });
+    });
+    _defineProperty(_this, "toggleLoader", function () {
+      _this.dispatch(loadingToggled());
+    });
+    _defineProperty(_this, "addImages", function () {
+      var images = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+      var imagesLength = images.length;
+      if (imagesLength === 0) {
+        return;
+      }
+      _this.toggleLoader();
+      Promise.all(images.map(_this.addImage))["finally"](_this.toggleLoader);
+    });
+    _defineProperty(_this, "getIconFileDescriptorToBeAdded", function () {
+      var _ref2, _ref3, _icon$name;
+      var icon = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var currentDate = Date.now();
+      var iconStringReplacedWithFinalColor = (icon.svgStringified || '').replace('color="currentColor"', "color=\"".concat(icon.color, "\""));
+      if (!iconStringReplacedWithFinalColor) {
+        return;
+      }
+      var iconName = (_ref2 = (_ref3 = (_icon$name = icon.name) !== null && _icon$name !== void 0 ? _icon$name : icon.alt) !== null && _ref3 !== void 0 ? _ref3 : icon.uid) !== null && _ref2 !== void 0 ? _ref2 : currentDate;
+      var iconFileProperties = {
+        type: 'image/svg+xml',
+        lastModified: currentDate
+      };
+      var iconFile = new File([iconStringReplacedWithFinalColor], iconName, iconFileProperties);
+      var previewUrl = URL.createObjectURL(iconFile);
+      var fileDescriptor = {
+        source: _this.id,
+        name: iconFile.name,
+        type: iconFile.type,
+        data: iconFile,
+        preview: previewUrl
+      };
+      setTimeout(function () {
+        URL.revokeObjectURL(previewUrl);
+      }, 3000);
+      return fileDescriptor;
+    });
+    _defineProperty(_this, "addIcons", function () {
+      var icons = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+      var iconsLength = icons.length;
+      if (iconsLength === 0) {
+        return;
+      }
+      _this.toggleLoader();
+      var iconsFilesDescriptors = icons.map(_this.getIconFileDescriptorToBeAdded);
+      try {
+        _this.filerobot.addFiles(iconsFilesDescriptors);
+      } catch (err) {
+        _this.filerobot.log(err);
+      }
+      _this.toggleLoader();
+    });
+    _defineProperty(_this, "sendSelectedMediaToUpload", function () {
+      var _this$getPluginCommon = _this.getPluginCommonState(),
+        _this$getPluginCommon2 = _this$getPluginCommon.currentSelection,
+        currentSelection = _this$getPluginCommon2 === void 0 ? [] : _this$getPluginCommon2,
+        _this$getPluginCommon3 = _this$getPluginCommon.customizedIcons,
+        customizedIcons = _this$getPluginCommon3 === void 0 ? [] : _this$getPluginCommon3;
+      if (customizedIcons.length > 0) {
+        _this.addIcons(customizedIcons);
+      } else {
+        _this.addImages(currentSelection);
+      }
+      _this.setPluginCommonState({
+        currentSelection: [],
+        customizedIcons: []
+      });
+    });
+    _defineProperty(_this, "sendSelectedIconsToCustomize", function () {
+      var _this$getPluginCommon4 = _this.getPluginCommonState(),
+        _this$getPluginCommon5 = _this$getPluginCommon4.currentSelection,
+        currentSelection = _this$getPluginCommon5 === void 0 ? [] : _this$getPluginCommon5;
+      if (currentSelection.length > 0) {
+        _this.dispatch(pixaforgeCommonStateUpdated({
+          customizedIcons: currentSelection,
+          currentSelection: []
+        }));
+      }
+    });
+    _defineProperty(_this, "clearSelection", function () {
+      _this.dispatch(pixaforgeCommonStateUpdated({
+        currentSelection: [],
+        customizedIcons: [],
+        isAllSelected: false
+      }));
+    });
+    _defineProperty(_this, "listenToElementResize", function (elementSelectorOrRef, callback) {
+      _this.stopListeningToElementResize();
+      _this.resizeObserver = new ResizeObserver(function (entries) {
+        var filerobotPixaforgeInnerEl = entries[0];
+        var _filerobotPixaforgeIn = filerobotPixaforgeInnerEl.contentRect,
+          width = _filerobotPixaforgeIn.width,
+          height = _filerobotPixaforgeIn.height;
+        _this.filerobot.log("[Pixaforge] resized: ".concat(width, " / ").concat(height), 'debug');
+        if (typeof callback === 'function') {
+          callback(width, height);
+        }
+      });
+      _this.resizeObserver.observe(typeof elementSelectorOrRef === 'string' ? _this.el.querySelector(elementSelectorOrRef) : elementSelectorOrRef);
+    });
+    _defineProperty(_this, "stopListeningToElementResize", function () {
+      if (_this.resizeObserver) {
+        _this.resizeObserver.disconnect();
+      }
+    });
+    _defineProperty(_this, "renderPanelBarTopLeftComponent", function () {
+      var _this$getPluginCommon6 = _this.getPluginCommonState(),
+        _this$getPluginCommon7 = _this$getPluginCommon6.currentSelection,
+        currentSelection = _this$getPluginCommon7 === void 0 ? [] : _this$getPluginCommon7,
+        _this$getPluginCommon8 = _this$getPluginCommon6.customizedIcons,
+        customizedIcons = _this$getPluginCommon8 === void 0 ? [] : _this$getPluginCommon8,
+        gallery = _this$getPluginCommon6.gallery;
+      var selectionCount = currentSelection.length;
+      var customizedIconsCount = customizedIcons.length;
+      var isIconsGallery = gallery === GALLERIES.ICONS;
+      var hasCustomizedIcons = customizedIconsCount > 0;
+      var isInIconsSelectionStep = isIconsGallery && !hasCustomizedIcons;
+      var isDisabled = selectionCount === 0 && !hasCustomizedIcons;
+      var onClickHandler = isInIconsSelectionStep ? _this.sendSelectedIconsToCustomize : _this.sendSelectedMediaToUpload;
+      return /*#__PURE__*/_jsxs(_Fragment, {
+        children: [/*#__PURE__*/_jsx(BadgeButton, {
+          onClick: isDisabled ? undefined : onClickHandler,
+          background: "accent",
+          disabled: isDisabled,
+          label: _this.filerobot.i18n(isInIconsSelectionStep ? 'mutualizedSelectLabel' : 'mutualizedImportLabel'),
+          badgeContent: selectionCount === 0 && customizedIconsCount === 0 ? undefined : customizedIconsCount || selectionCount
+        }), !isDisabled && /*#__PURE__*/_jsx(CloseButton, {
+          onClick: _this.clearSelection,
+          hideDivider: true
+        })]
+      });
+    });
+    _defineProperty(_this, "renderPanelBarTopRightComponent", function () {
+      if (selectGallery(_this.getGlobalState()) !== GALLERIES.IMAGES) {
+        return null;
+      }
+      return /*#__PURE__*/_jsx(GalleryViewsOptionsMenu, {
+        i18n: _this.i18n
+      });
+    });
+    _this.id = PLUGINS_IDS.PIXAFORGE;
+    _this.type = 'acquirer';
+    _this.icon = function () {
+      return /*#__PURE__*/_jsx(PixaforgeIcon, {});
+    };
+    _this.title = _this.opts.title || 'Free images & icons';
+    _this.render = _this.render.bind(_this);
+    _this.defaultLocale = {
+      strings: defaultLocale
+    };
+    var defaultOptions = {
+      noIconsGallery: false
+    };
+    _this.opts = _objectSpread(_objectSpread({}, defaultOptions), opts);
+    _this.i18nInit();
+
+    // !TODO: Check why this.i18n('pixaforgeTitle') doesn't render the proper title.
+    // this.title = this.opts.title || this.i18n('pixaforgeTitle')
+
+    _this.client = new RequestClient(filerobot, {
+      companionHeaders: _this.opts.companionHeaders
+    });
+    _this.hostname = _this.client.companionUrl;
+    if (!_this.hostname) {
+      throw new Error('Companion hostname is required');
+    }
+    return _this;
+  }
+  _inherits(Pixaforge, _Plugin);
+  return _createClass(Pixaforge, [{
+    key: "install",
+    value: function install() {
+      if (Explorer) {
+        this.mount(Explorer, this);
+      }
+    }
+  }, {
+    key: "uninstall",
+    value: function uninstall() {
+      this.unmount();
+      this.stopListeningToElementResize();
+    }
+  }, {
+    key: "setPluginCommonState",
+    value: function setPluginCommonState(update) {
+      return this.dispatch(pixaforgeCommonStateUpdated(update));
+    }
+  }, {
+    key: "getPluginReducer",
+    value: function getPluginReducer() {
+      return pixaforgeReducer;
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      return /*#__PURE__*/_jsx(MainView, {
+        listenToElementResize: this.listenToElementResize,
+        stopListeningToElementResize: this.stopListeningToElementResize,
+        clearSelection: this.clearSelection,
+        i18n: this.i18n,
+        info: this.filerobot.info
+      });
+    }
+  }]);
+}(Plugin);
+export { Pixaforge as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scaleflex/widget-pixaforge",
   "description": "Import free images & icons from Pixaforge that has free gallery for both.",
-  "version": "4.4.0",
+  "version": "4.5.1",
   "license": "MIT",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -11,10 +11,10 @@
   "dependencies": {
     "@scaleflex/icons": "^3.0.0-beta.11",
     "@scaleflex/ui": "^3.0.0-beta.11",
-    "@scaleflex/widget-common": "^4.4.0",
-    "@scaleflex/widget-companion-client": "^4.4.0",
-    "@scaleflex/widget-icons": "^4.4.0",
-    "@scaleflex/widget-utils": "^4.4.0"
+    "@scaleflex/widget-common": "^4.5.1",
+    "@scaleflex/widget-companion-client": "^4.5.1",
+    "@scaleflex/widget-icons": "^4.5.1",
+    "@scaleflex/widget-utils": "^4.5.1"
   },
   "devDependencies": {
     "react": "^19.0.0",
@@ -31,5 +31,5 @@
     "/lib",
     "/types"
   ],
-  "gitHead": "04b8ec545c4f10be89f5a44eed954acf8433360c"
+  "gitHead": "b211f9961ad30d3eaa01138f34e190ad5d38fb91"
 }