@scaleflex/widget-dropbox 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,87 @@
+# @scaleflex/widget-dropbox
+
+[![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>
+
+The Dropbox plugin for [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core). lets users import files from their Dropbox account.
+
+
+## Usage
+
+### NPM
+
+```bash
+npm install --save @scaleflex/widget-dropbox
+```
+### YARN
+
+```bash
+yarn add @scaleflex/widget-dropbox
+```
+
+then
+
+```js
+import Dropbox from '@scaleflex/widget-dropbox'
+...
+...
+...
+scaleflexWidget.use(Dropbox, propertiesObject)
+```
+
+### CDN
+
+The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Dropbox`
+
+```js
+const dropbox = window.ScaleflexWidget.Dropbox
+...
+...
+...
+scaleflexWidget.use(dropbox, propertiesObject)
+```
+
+## Properties
+
+### `title`
+
+<u>Type:</u> `string`
+
+<u>Default:</u> `'Dropbox'`
+
+The title/label that would be shown & used for the plugin.
+
+### `companionHeaders`
+
+<u>Type:</u> `null` | `object`
+
+<u>Default:</u> `null`
+
+If you need to pass additional headers for in companion requests then pass them in this property.
+
+
+<!-- Variables -->
+
+[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-dropbox
+[license-url]: https://opensource.org/licenses/MIT
+[sfx-url]: https://www.scaleflex.com/
+[version-url]: https://www.npmjs.com/package/@scaleflex/widget-dropbox
+[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-dropbox?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/common.slice.js

@@ -0,0 +1,35 @@
+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 _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 { createSlice } from '@reduxjs/toolkit';
+import { PLUGINS_IDS } from '@scaleflex/widget-utils/lib/constants';
+
+// If the plugin instantiates a Provider, then we must have a common slice for it, as it will get updated through the provider.
+var initialState = {
+  authenticated: false,
+  files: [],
+  folders: [],
+  openedFolders: [],
+  selectedFolders: {},
+  activeRow: -1,
+  filterInput: '',
+  isSearchVisible: false
+};
+var commonSlice = createSlice({
+  name: PLUGINS_IDS.DROPBOX,
+  initialState: initialState,
+  reducers: {
+    dropboxCommonStateUpdated: function dropboxCommonStateUpdated(state, action) {
+      return _objectSpread(_objectSpread({}, state), action.payload);
+    }
+  }
+});
+var dropboxCommonStateUpdated = commonSlice.actions.dropboxCommonStateUpdated;
+export { dropboxCommonStateUpdated };
+export var selectDropboxCommonState = function selectDropboxCommonState(state) {
+  return state[PLUGINS_IDS.DROPBOX];
+};
+export default commonSlice.reducer;

package/lib/index.js

@@ -0,0 +1,101 @@
+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 _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 _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); }
+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); }
+import { Plugin } from '@scaleflex/widget-core';
+import Explorer from '@scaleflex/widget-explorer';
+import { Provider } from '@scaleflex/widget-companion-client';
+import ProviderViews from '@scaleflex/widget-provider-views';
+import { DropboxIcon } from '@scaleflex/widget-icons/lib';
+import { PLUGINS_IDS } from '@scaleflex/widget-utils/lib/constants';
+import dropboxReducer, { dropboxCommonStateUpdated } 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'
+var Dropbox = /*#__PURE__*/function (_Plugin) {
+  // static VERSION = packageInfo.version
+
+  function Dropbox(filerobot) {
+    var _this;
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, Dropbox);
+    _this = _callSuper(this, Dropbox, [filerobot, opts]);
+    _this.id = PLUGINS_IDS.DROPBOX;
+    Provider.initPlugin(_this, opts);
+    _this.title = _this.opts.title || 'Dropbox';
+    _this.icon = DropboxIcon;
+    _this.provider = new Provider(filerobot, {
+      companionHeaders: _this.opts.companionHeaders,
+      provider: 'dropbox',
+      pluginId: _this.id
+    });
+    _this.onFirstRender = _this.onFirstRender.bind(_this);
+    _this.render = _this.render.bind(_this);
+    return _this;
+  }
+  _inherits(Dropbox, _Plugin);
+  return _createClass(Dropbox, [{
+    key: "install",
+    value: function install() {
+      this.view = new ProviderViews(this, {
+        provider: this.provider
+      });
+      if (Explorer) {
+        this.mount(Explorer, this);
+      }
+    }
+  }, {
+    key: "uninstall",
+    value: function uninstall() {
+      this.unmount();
+    }
+  }, {
+    key: "setPluginCommonState",
+    value: function setPluginCommonState(update) {
+      return this.dispatch(dropboxCommonStateUpdated(update));
+    }
+  }, {
+    key: "getPluginReducer",
+    value: function getPluginReducer() {
+      return dropboxReducer;
+    }
+  }, {
+    key: "onFirstRender",
+    value: function onFirstRender() {
+      return this.view.getFolder('', 'Dropbox');
+    }
+  }, {
+    key: "addSelectedItems",
+    value: function addSelectedItems() {
+      return this.view.addSelectedItems();
+    }
+  }, {
+    key: "getPrevFolder",
+    value: function getPrevFolder(folder) {
+      return this.view.getNextFolder(folder);
+    }
+  }, {
+    key: "render",
+    value: function render(state) {
+      return this.view.render(state);
+    }
+  }]);
+}(Plugin);
+export { Dropbox as default };

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@scaleflex/widget-dropbox",
+  "description": "Import files from Dropbox, into Scaleflex.",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "types/index.d.ts",
+  "dependencies": {
+    "@scaleflex/widget-companion-client": "^0.0.1",
+    "@scaleflex/widget-icons": "^0.0.1",
+    "@scaleflex/widget-provider-views": "^0.0.1",
+    "@scaleflex/widget-utils": "^0.0.1"
+  },
+  "devDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "peerDependencies": {
+    "@reduxjs/toolkit": "^1.9.5",
+    "@scaleflex/widget-core": "^0.0.0",
+    "@scaleflex/widget-explorer": "^0.0.0",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0",
+    "react-redux": "^8.1.1"
+  },
+  "files": [
+    "/dist",
+    "/lib",
+    "/types"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "64ea82e745b7deda36d6794863350e6671e9010d"
+}

package/types/index.d.ts

@@ -0,0 +1,16 @@
+import Filerobot = require("@scaleflex/widget-core");
+import CompanionClient = require("@scaleflex/widget-companion-client");
+
+declare module Dropbox {
+  interface DropboxOptions
+    extends Filerobot.PluginOptions,
+      CompanionClient.PublicProviderOptions {
+    replaceTargetContent?: boolean;
+    target?: Filerobot.PluginTarget;
+    storage?: CompanionClient.TokenStorage;
+  }
+}
+
+declare class Dropbox extends Filerobot.Plugin<Dropbox.DropboxOptions> {}
+
+export = Dropbox;