@scaleflex/widget-canva 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,124 @@
+# @scaleflex/widget-canva
+
+[![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>
+
+Create your own design & customize it then upload it  on the go by integrating this plugin inside [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core).
+
+## Usage
+
+### NPM
+
+```bash
+npm install --save @scaleflex/widget-canva
+```
+### YARN
+
+```bash
+yarn add @scaleflex/widget-canva
+```
+then
+
+```js
+import Canva from '@scaleflex/widget-canva'
+...
+...
+...
+scaleflexWidget.use(Canva, propertiesObject)
+```
+
+### CDN
+
+The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Canva`
+
+```js
+const Canva = window.ScaleflexWidget.Canva
+...
+...
+...
+scaleflexWidget.use(Canva, propertiesObject)
+```
+
+## Properties
+
+### `title`
+
+<u>Type:</u> `string`.
+
+<u>Default:</u> `'Canva (Design & Upload)'`
+
+The title/label that would be shown & used for the plugin.
+
+### `apiKey`
+
+<u>Type:</u> `string`.
+
+<u>Default:</u> `'scaleflexWidget's canva api key'`
+
+The API key used in initializing canva & creating the design through their SDK.
+
+### `designType`
+
+<u>Type:</u> `string`.
+
+<u>Default:</u> `'A4Document'`
+
+The design type of the design workspace that would be opened to create the design, visit [Canva's design types](https://docs.developer.canva.com/button/reference/design-types) for all available types.
+
+### `fileType: string`
+
+<u>Type:</u> `string`.
+
+<u>Default:</u> `'png'`
+
+The type of the final created design's to be saved & uploaded with it.
+
+### `companionHeaders`
+
+<u>Type:</u> `null` | `object`.
+
+<u>Default:</u> `null`
+
+If you need to pass additonal headers in companion requests then pass them in this property (used in retrieving the metadata of the design file).
+
+### `locale`
+
+<u>Type:</u> `object`.
+
+<u>Default:</u>  locales from scaleflexWidget's backend then default locale file with all labels is under `lib/defaultLocale.js`.
+
+You can override some labels by specifying a translation object here, such as:
+
+```js
+{
+  strings: {
+    canvaPluginTitle: 'Canva (Design & upload)' // overrides the default Standard portraits value to standard verticals
+  }
+}
+```
+
+<!-- Variables -->
+
+[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-canva
+[license-url]: https://opensource.org/licenses/MIT
+[sfx-url]: https://www.scaleflex.com/
+[version-url]: https://www.npmjs.com/package/@scaleflex/widget-canva
+[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-canva?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/CanvaWorkspace.js

@@ -0,0 +1,69 @@
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+import { useState, useEffect } from 'react';
+import { LoaderView } from '@scaleflex/widget-common';
+import loadCanvaSDK from './utils/loadCanvaSDK';
+import { jsx as _jsx } from "react/jsx-runtime";
+var openedBlockStyles = {
+  display: 'flex',
+  justifyContent: 'center',
+  alignItems: 'center',
+  marginTop: 50
+};
+var CanvaWorkspace = function CanvaWorkspace(_ref) {
+  var pluginOpts = _ref.pluginOpts,
+    addDesign = _ref.addDesign,
+    i18n = _ref.i18n,
+    canvaApi = _ref.canvaApi,
+    setCanvaApi = _ref.setCanvaApi,
+    closePlugin = _ref.closePlugin;
+  var apiKey = pluginOpts.apiKey,
+    designType = pluginOpts.designType,
+    fileType = pluginOpts.fileType;
+  var _useState = useState(true),
+    _useState2 = _slicedToArray(_useState, 2),
+    isLoading = _useState2[0],
+    setIsLoading = _useState2[1];
+  var createDesign = function createDesign(api) {
+    setIsLoading(false);
+    if (!canvaApi) {
+      setCanvaApi(api);
+    }
+    api.createDesign({
+      design: {
+        type: designType
+      },
+      editor: {
+        fileType: fileType
+      },
+      onDesignPublish: function onDesignPublish(opts) {
+        addDesign(opts);
+      },
+      onDesignClose: function onDesignClose() {
+        closePlugin();
+      }
+    });
+  };
+  useEffect(function () {
+    if (!window.Canva || !window.Canva.DesignButton || !canvaApi) {
+      loadCanvaSDK().then(function () {
+        window.Canva.DesignButton.initialize({
+          apiKey: apiKey
+        }).then(createDesign);
+      });
+    } else {
+      createDesign(canvaApi);
+    }
+  }, []);
+  return isLoading ? /*#__PURE__*/_jsx(LoaderView, {
+    loaderLabel: i18n('loaderLoadingLabel')
+  }) : /*#__PURE__*/_jsx("div", {
+    style: openedBlockStyles,
+    children: i18n('canvaOpenedInModalHint')
+  });
+};
+export default CanvaWorkspace;

package/lib/defaultLocale.js

@@ -0,0 +1,6 @@
+export default {
+  canvaPluginTitle: 'Canva (Design & upload)',
+  canvaOpenedInModalHint: 'Canva is opened in an external modal',
+  canvaFailedToFetchDesignFileMetaError: 'Failed to fetch the meta of the design file',
+  canvaFailedToFetchDesignFileMessage: 'Failed to fetch the design file'
+};

package/lib/index.js

@@ -0,0 +1,178 @@
+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 { CanvaIcon } from '@scaleflex/widget-icons';
+import { RequestClient } from '@scaleflex/widget-companion-client';
+import { PLUGINS_IDS } from '@scaleflex/widget-utils/lib/constants';
+import defaultLocale from './defaultLocale';
+import CanvaWorkspace from './CanvaWorkspace';
+var DEV_API_KEY = '6PlJP_VARP0ey8hLCNQQsp1P';
+var PROD_API_KEY = 'xdXpp6KdBRtRAJbPGs64yEl-';
+
+// 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 Canva = /*#__PURE__*/function (_Plugin) {
+  // static VERSION = packageInfo.version
+
+  function Canva(filerobot) {
+    var _this;
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, Canva);
+    _this = _callSuper(this, Canva, [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, "getFileType", function (type) {
+      return type.substring(type.lastIndexOf('/') + 1);
+    });
+    _defineProperty(_this, "getFileNameFromUrl", function (_ref) {
+      var url = _ref.url,
+        type = _ref.type;
+      return url.substring(url.lastIndexOf('/') + 1) + ".".concat(type);
+    });
+    _defineProperty(_this, "getMeta", function (url) {
+      return _this.client.post('url/meta', {
+        url: url
+      }).then(function (res) {
+        if (res.error) {
+          _this.filerobot.log('[Canva] Error:');
+          _this.filerobot.log(res.error);
+          throw new Error(_this.i18n('canvaFailedToFetchDesignFileMetaError'));
+        }
+        return res;
+      });
+    });
+    _defineProperty(_this, "addDesign", function (design) {
+      if (!design.exportUrl) {
+        return;
+      }
+      return _this.getMeta(design.exportUrl).then(function (meta) {
+        var tagFile = {
+          source: _this.id,
+          name: "".concat(design.designTitle, "-").concat(design.designId, ".").concat(_this.getFileType(meta.type)) || _this.getFileNameFromUrl({
+            url: design.exportUrl,
+            type: _this.getFileType(meta.type)
+          }),
+          type: meta.type,
+          data: {
+            size: meta.size
+          },
+          isRemote: true,
+          body: {
+            url: design.exportUrl
+          },
+          preview: design.exportUrl,
+          remote: {
+            companionUrl: _this.client.companionUrl,
+            url: "".concat(_this.hostname, "/url/get"),
+            body: {
+              fileId: design.designId,
+              url: design.exportUrl
+            },
+            providerOptions: _this.client.opts
+          }
+        };
+        return tagFile;
+      }).then(function (tagFile) {
+        _this.filerobot.log('[Canva] 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('canvaFailedToFetchDesignFileMessage'),
+          details: err
+        }, 'error', 5000);
+      });
+    });
+    _defineProperty(_this, "setCanvaApi", function (canvaApi) {
+      _this.canvaApi = canvaApi;
+    });
+    _this.id = PLUGINS_IDS.CANVA;
+    _this.type = 'acquirer';
+    _this.icon = CanvaIcon;
+    _this.title = 'Canva';
+    _this.render = _this.render.bind(_this);
+    _this.canvaApi = undefined;
+    var defaultOptions = {
+      apiKey: _this.filerobot.opts.dev ? DEV_API_KEY : PROD_API_KEY,
+      designType: 'A4Document',
+      fileType: 'png'
+    };
+    _this.opts = _objectSpread(_objectSpread({}, defaultOptions), opts);
+    _this.defaultLocale = {
+      strings: defaultLocale
+    };
+    _this.i18nInit();
+
+    // !TODO: Check why this.i18n('canvaPluginTitle') doesn't render the proper title.
+    // this.title = this.opts.title || this.i18n('canvaPluginTitle')
+
+    _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(Canva, _Plugin);
+  return _createClass(Canva, [{
+    key: "install",
+    value: function install() {
+      if (Explorer) {
+        this.mount(Explorer, this);
+      }
+    }
+  }, {
+    key: "uninstall",
+    value: function uninstall() {
+      this.unmount();
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      return CanvaWorkspace({
+        pluginOpts: this.opts,
+        addDesign: this.addDesign,
+        i18n: this.i18n,
+        canvaApi: this.canvaApi,
+        setCanvaApi: this.setCanvaApi,
+        closePlugin: this.parent.hideAllPanelsAndShowAddFilesPanel
+      });
+    }
+  }]);
+}(Plugin);
+export { Canva as default };

package/lib/utils/loadCanvaSDK.js

@@ -0,0 +1,11 @@
+var loadCanvaSDK = function loadCanvaSDK() {
+  return new Promise(function (resolve, reject) {
+    var scriptElement = document.createElement('script');
+    scriptElement.src = 'https://sdk.canva.com/designbutton/v2/api.js';
+    scriptElement.async = true;
+    scriptElement.onload = resolve;
+    scriptElement.onerror = reject;
+    document.body.appendChild(scriptElement);
+  });
+};
+export default loadCanvaSDK;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@scaleflex/widget-canva",
+  "description": "Create your own design & customize it then upload it through the widget on the go.",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@scaleflex/widget-common": "^0.0.1",
+    "@scaleflex/widget-companion-client": "^0.0.1",
+    "@scaleflex/widget-icons": "^0.0.1",
+    "@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"
+  },
+  "files": [
+    "/dist",
+    "/lib",
+    "/types"
+  ],
+  "gitHead": "64ea82e745b7deda36d6794863350e6671e9010d"
+}