@scaleflex/widget-attach-dnd 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 scaleflex
+
+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,102 @@
+# `@scaleflex/widget-attach-dnd`
+
+[![Plugins][plugins-image]](#plugins)
+[![Website][filerobot-image]][sfx-url]
+[![Version][filerobot-version]][version-url]
+[![Scaleflex team][made-by-image]][sfx-url]
+[![License][license-image]][license-url]
+[![CodeSandbox][codeSandbox-image]][codeSandbox-url]
+
+
+<div align='center'>
+<img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://cdn.scaleflex.com/plugins/filerobot-widget/assets/filerobot_widget_logo_with_fire.png?vh=b2ff09" width="140"/>
+</div>
+
+
+Attaches drag & drop (dnd) zone of the Scaleflex widget to some HTML element of your page [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core).
+
+> Note: This plugin requires [@scaleflex/widget-explorer](../@scaleflex/widget-explorer) plugin to be existed & used in the widget, as the `attach-dnd` plugin role is only attaching the drag & drop zone to some element of your page and the rest is handled through the explorer & widget.
+
+## Usage
+
+### NPM
+
+```bash
+npm install --save @scaleflex/widget-attach-dnd
+```
+
+### YARN
+
+```bash
+yarn add @scaleflex/widget-attach-dnd
+```
+
+then
+
+```js
+import AttachDragAndDrop from '@scaleflex/widget-attach-dnd'
+...
+...
+...
+scaleflexWidget.use(AttachDragAndDrop, propertiesObject)
+```
+
+### CDN
+
+If installed via a [CDN link](../@scaleflex/widget-core#installation), the plugin is inside the `ScaleflexWidget` global object as `ScaleflexWidget.AttachDnD`
+
+```js
+const AttachDragAndDrop = window.ScaleflexWidget.AttachDnD
+...
+...
+...
+scaleflexWidget.use(AttachDragAndDrop, propertiesObject)
+```
+
+## Properties
+
+Required attributes are marked with ***(Required)***.
+
+### `target`
+
+<u>Type:</u> `string or HTML Element` **_Required_**.
+
+<u>Default:</u> `document.body`
+
+The selector (ID, Class) of an HTML element or an existed HTML element that would be attached with the drag & drop zone, also the drop hint would be shown to this target selector's element, by default it's the body of the document page.
+
+### `fixedDropHint`
+
+<u>Type:</u> `boolean`.
+
+<u>Default:</u> `false`
+
+If set to `true`, the drop hint shown while dragging the file/folder on the `target` element would be in a fixed position.
+
+> Note: it might be useful to use this property if your page scroll and the drop zone doesn't keep in the same scroll position.
+
+### `noDropHint`
+
+<u>Type:</u> `boolean`.
+
+<u>Default:</u> `false`
+
+If you don't want to show the drop hint shown while dragging the file/folder over the target element then provide `true` value here, otherwise it would be shown normally.
+
+
+<!-- Variables -->
+
+[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-attach-dnd
+[license-url]: https://opensource.org/licenses/MIT
+[sfx-url]: https://www.scaleflex.com/
+[version-url]: https://www.npmjs.com/package/@scaleflex/widget-attach-dnd
+[codeSandbox-url]: https://codesandbox.io/s/filerobot-widget-v3-c5l9th
+
+
+[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
+[made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
+[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
+[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
+[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-attach-dnd?label=Version&style=for-the-badge&logo=npm
+[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox

package/lib/index.js

@@ -0,0 +1,209 @@
+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 _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
+function _get() { return _get = "undefined" != typeof Reflect && Reflect.get ? Reflect.get.bind() : function (e, t, r) { var p = _superPropBase(e, t); if (p) { var n = Object.getOwnPropertyDescriptor(p, t); return n.get ? n.get.call(arguments.length < 3 ? e : r) : n.value; } }, _get.apply(null, arguments); }
+function _superPropBase(t, o) { for (; !{}.hasOwnProperty.call(t, o) && null !== (t = _getPrototypeOf(t));); 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 { createElement } from 'react';
+import { createRoot } from 'react-dom/client';
+import { Plugin } from '@scaleflex/widget-core';
+import Explorer from '@scaleflex/widget-explorer';
+import isDragDropSupported from '@scaleflex/widget-utils/lib/isDragDropSupported';
+import getDroppedFiles from '@scaleflex/widget-utils/lib/getDroppedFiles';
+import findDOMElement from '@scaleflex/widget-utils/lib/findDOMElement';
+import { DropFilesWindow } from '@scaleflex/widget-common';
+import { PLUGINS_IDS } from '@scaleflex/widget-utils/lib/constants';
+// 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'
+var AttachDragAndDrop = /*#__PURE__*/function (_Plugin) {
+  // static VERSION = packageInfo.version
+
+  function AttachDragAndDrop(filerobot) {
+    var _this;
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, AttachDragAndDrop);
+    _this = _callSuper(this, AttachDragAndDrop, [filerobot, opts]);
+    _defineProperty(_this, "addFiles", function (files) {
+      var descriptors = files.map(function (file) {
+        return {
+          source: _this.id,
+          name: file.name,
+          type: file.type,
+          data: file,
+          meta: {
+            relativePath: file.relativePath || null
+          }
+        };
+      });
+      try {
+        _this.filerobot.addFiles(descriptors);
+      } catch (err) {
+        _this.filerobot.info(err, 'warning');
+        _this.filerobot.log(err);
+      }
+    });
+    _defineProperty(_this, "handleDragEnter", function (event) {
+      event.preventDefault();
+      event.stopPropagation();
+      if (_this.dropHintElement) {
+        _this.dropHintElement.style.visibility = 'visible';
+        _this._oldTargetPosition = _this.targetElement.style.position || 'initial';
+        _this._oldTargetMinHeight = _this.targetElement.style.minHeight || 'initial';
+        _this.targetElement.style.position = 'relative';
+        _this.targetElement.style.minHeight = '150px';
+      }
+      _this.targetElement.classList.add('filerobot-common-DropFilesTarget');
+      _this._isDragging = true;
+    });
+    _defineProperty(_this, "handleDragOver", function (event) {
+      event.preventDefault();
+      event.stopPropagation();
+      event.dataTransfer.dropEffect = 'copy';
+    });
+    _defineProperty(_this, "endDragging", function () {
+      if (_this.dropHintElement) {
+        _this.dropHintElement.style.visibility = 'hidden';
+        _this.targetElement.style.position = _this._oldTargetPosition;
+        _this.targetElement.style.minHeight = _this._oldTargetMinHeight;
+      }
+      _this.targetElement.classList.remove('filerobot-common-DropFilesTarget');
+      _this._isDragging = false;
+    });
+    _defineProperty(_this, "handleDrop", function (event) {
+      event.preventDefault();
+      event.stopPropagation();
+
+      // Remove dragover class
+      _this.endDragging();
+      if (_this.explorerPlugin && !_this.explorerPlugin.opts.inline) {
+        _this.explorerPlugin.openModal();
+      }
+
+      // Adding the dropped files
+      _this.filerobot.log('[AttachDragAndDrop] Files dropped.');
+      var logDropError = function logDropError(error) {
+        _this.filerobot.info(error, 'warning');
+        _this.filerobot.log(error, 'error');
+      };
+      getDroppedFiles(event.dataTransfer, {
+        logDropError: logDropError
+      }).then(function (files) {
+        return _this.addFiles(files);
+      });
+    });
+    _defineProperty(_this, "handleDragLeave", function (event) {
+      if (_this._isDragging) {
+        event.preventDefault();
+        _this.endDragging();
+      }
+    });
+    _defineProperty(_this, "handleMouseEnter", function (event) {
+      if (_this._isDragging) {
+        event.preventDefault();
+        _this.endDragging();
+      }
+    });
+    _defineProperty(_this, "addDropHintWindow", function () {
+      var newElement = document.createElement('div');
+      _this.targetElement.appendChild(newElement);
+      var style = {};
+      if (_this.opts.fixedDropHint) {
+        style.position = 'fixed';
+      }
+      var DropFilesWindowElem = /*#__PURE__*/createElement(DropFilesWindow, {
+        i18n: _this.filerobot.i18n,
+        style: style,
+        onMount: function onMount() {
+          _this.dropHintElement = newElement.lastElementChild;
+        }
+      });
+      _this.root = createRoot(newElement);
+      _this.root.render(DropFilesWindowElem);
+    });
+    _defineProperty(_this, "attachEventsToTargetElement", function () {
+      if (!_this.opts.noDropHint) {
+        _this.addDropHintWindow();
+      }
+      document.addEventListener('mouseenter', _this.handleMouseEnter);
+      _this.targetElement.addEventListener('dragenter', _this.handleDragEnter);
+      _this.targetElement.addEventListener('dragover', _this.handleDragOver);
+      _this.targetElement.addEventListener('drop', _this.handleDrop);
+      _this.targetElement.addEventListener('dragleave', _this.handleDragLeave);
+    });
+    _defineProperty(_this, "detachEventsFromTargetElement", function () {
+      document.removeEventListener('mouseenter', _this.handleMouseEnter);
+      _this.targetElement.removeEventListener('dragenter', _this.handleDragEnter);
+      _this.targetElement.removeEventListener('dragover', _this.handleDragOver);
+      _this.targetElement.removeEventListener('drop', _this.handleDrop);
+      _this.targetElement.removeEventListener('dragleave', _this.handleDragLeave);
+    });
+    _this.type = 'acquirer';
+    _this.id = PLUGINS_IDS.ATTACH_DND;
+    _this.invisible = true;
+    _this.title = 'Attach Drag & Drop';
+    var defaultOptions = {
+      target: document.body,
+      fixedDropHint: false,
+      noDropHint: false
+    };
+    _this.opts = _objectSpread(_objectSpread({}, defaultOptions), opts);
+    _this.targetElement = findDOMElement(_this.opts.target);
+    _this._isDragging = false;
+
+    // Check for browser drag & drop support
+    _this.isDragDropSupported = isDragDropSupported(_this.targetElement);
+    return _this;
+  }
+  _inherits(AttachDragAndDrop, _Plugin);
+  return _createClass(AttachDragAndDrop, [{
+    key: "setOptions",
+    value: function setOptions(newOpts) {
+      _superPropGet(AttachDragAndDrop, "setOptions", this, 3)([newOpts]);
+    }
+  }, {
+    key: "install",
+    value: function install() {
+      if (Explorer) {
+        this.mount(Explorer, this);
+        this.explorerPlugin = this.filerobot.getPlugin(PLUGINS_IDS.EXPLORER);
+      }
+    }
+  }, {
+    key: "onMount",
+    value: function onMount() {
+      if (this.isDragDropSupported) {
+        this.attachEventsToTargetElement();
+      } else {
+        console.warn('The browser/provided element doesn\'t support drag & drop.');
+      }
+    }
+  }, {
+    key: "uninstall",
+    value: function uninstall() {
+      this.detachEventsFromTargetElement();
+      this.unmount();
+    }
+  }]);
+}(Plugin);
+export default AttachDragAndDrop;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@scaleflex/widget-attach-dnd",
+  "version": "0.0.1",
+  "description": "Attaches drag & drop zone to the specified HTML target, so any file dropped in that target would be uploaded.",
+  "main": "lib/index.js",
+  "files": [
+    "/dist",
+    "/lib",
+    "/types"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@scaleflex/widget-utils": "^0.0.1"
+  },
+  "devDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "peerDependencies": {
+    "@scaleflex/widget-core": "^0.0.0",
+    "@scaleflex/widget-explorer": "^0.0.0",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
+  },
+  "license": "MIT",
+  "gitHead": "64ea82e745b7deda36d6794863350e6671e9010d"
+}