@scaleflex/widget-core 4.0.7 → 4.3.0

package/lib/index.js

@@ -79,16 +79,16 @@ var RestrictionError = /*#__PURE__*/function (_Error) {
   _inherits(RestrictionError, _Error);
   return _createClass(RestrictionError);
 }(/*#__PURE__*/_wrapNativeSuper(Error));
-/**
- * filerobot Core module.
- * Manages plugins, state updates, acts as an event bus,
- * adds/removes files and metadata.
+/**
+ * filerobot Core module.
+ * Manages plugins, state updates, acts as an event bus,
+ * adds/removes files and metadata.
  */
 var ScaleflexWidget = /*#__PURE__*/function () {
-  /**
-   * Instantiate filerobot
-   *
-   * @param {object} opts — filerobot options
+  /**
+   * Instantiate filerobot
+   *
+   * @param {object} opts — filerobot options
    */
   function ScaleflexWidget(opts) {
     var _this2 = this;
@@ -286,9 +286,9 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       throw new TypeError('`restrictions.allowedFileTypes` must be an array');
     }
 
-    /**
-     * saveMissing translations is temporary disabled. Until we find a good solution how to improve automation.
-     * Previous approach doesn't work thus we switched to manual translations adding to Wordplex directly by developers.
+    /**
+     * saveMissing translations is temporary disabled. Until we find a good solution how to improve automation.
+     * Previous approach doesn't work thus we switched to manual translations adding to Wordplex directly by developers.
      */
     // Translator.IS_DEV = this.opts.dev
 
@@ -296,10 +296,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
 
     // Container for different types of plugins
     this.plugins = {};
-    /*
-    * Container for the current uploads operations
-    * (not files but the upload process/operation itself that can contain multiple files)
-    * made as a property in the class as it doesn't need to cause a render or accessed externally.
+    /*
+    * Container for the current uploads operations
+    * (not files but the upload process/operation itself that can contain multiple files)
+    * made as a property in the class as it doesn't need to cause a render or accessed externally.
     */
     this.uploadOperations = {};
     this.getGlobalState = this.getGlobalState.bind(this);
@@ -403,10 +403,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }));
     }
 
-    /**
-     * Iterate on all plugins and run `update` on them.
-     * Called each time state changes.
-     *
+    /**
+     * Iterate on all plugins and run `update` on them.
+     * Called each time state changes.
+     *
      */
   }, {
     key: "updateAll",
@@ -416,9 +416,9 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       });
     }
 
-    /**
-     * creates & assigns the redux store
-     *
+    /**
+     * creates & assigns the redux store
+     *
     */
   }, {
     key: "_storeInit",
@@ -433,9 +433,9 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * injects a sub-reducer into the root reducer (mostly used for injecting a plugin's reducer)
-     *
+    /**
+     * injects a sub-reducer into the root reducer (mostly used for injecting a plugin's reducer)
+     *
     */
   }, {
     key: "_injectReducer",
@@ -443,9 +443,9 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       this.store.injectReducer(key, reducerFn);
     }
 
-    /**
-     * injects a sub-reducer into the root reducer (mostly used for injecting a plugin's reducer)
-     *
+    /**
+     * injects a sub-reducer into the root reducer (mostly used for injecting a plugin's reducer)
+     *
     */
   }, {
     key: "_removeReducer",
@@ -453,9 +453,9 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       this.store.removeReducer(key);
     }
 
-    /**
-     * Triggers the action to call store's reducers
-     * @param {Function} actionCreator
+    /**
+     * Triggers the action to call store's reducers
+     * @param {Function} actionCreator
      */
   }, {
     key: "dispatch",
@@ -463,12 +463,12 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.store.dispatch(actionCreator);
     }
 
-    /**
-     * Updates common state with a patch
-     * any state that not organized in a sub-reducer/slice
-     *
-     * @param {object} patch {foo: 'bar'}
-    //  * TODO: To check it
+    /**
+     * Updates common state with a patch
+     * any state that not organized in a sub-reducer/slice
+     *
+     * @param {object} patch {foo: 'bar'}
+    //  * TODO: To check it
      */
   }, {
     key: "setCoreCommonState",
@@ -476,10 +476,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       this.dispatch(coreCommonStateUpdated(patch));
     }
 
-    /**
-     * Returns current state of whole redux's store (global state).
-     *
-     * @returns {object}
+    /**
+     * Returns current state of whole redux's store (global state).
+     *
+     * @returns {object}
     */
   }, {
     key: "getGlobalState",
@@ -487,10 +487,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.store.getState();
     }
 
-    /**
-     * Returns current core's slice state.
-     *
-     * @returns {object}
+    /**
+     * Returns current core's slice state.
+     *
+     * @returns {object}
      */
   }, {
     key: "getCoreState",
@@ -498,10 +498,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.getGlobalState()[PLUGINS_IDS.CORE];
     }
 
-    /**
-     * Returns current core's slice state.
-     *
-     * @returns {object}
+    /**
+     * Returns current core's slice state.
+     *
+     * @returns {object}
      */
   }, {
     key: "getCoreCommonState",
@@ -509,10 +509,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return selectCommonState(this.getGlobalState());
     }
 
-    /**
-     * Returns current uploads
-     *
-     * @returns {object}
+    /**
+     * Returns current uploads
+     *
+     * @returns {object}
      */
   }, {
     key: "getUploadOperations",
@@ -520,10 +520,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.uploadOperations;
     }
 
-    /**
-     * Returns current uploads' meta
-     *
-     * @returns {object}
+    /**
+     * Returns current uploads' meta
+     *
+     * @returns {object}
      */
   }, {
     key: "getUploadCapabilities",
@@ -531,10 +531,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return selectUploadCapabilities(this.getGlobalState());
     }
 
-    /**
-     * Returns the current files that will get uploaded
-     *
-     * @returns {object}
+    /**
+     * Returns the current files that will get uploaded
+     *
+     * @returns {object}
      */
   }, {
     key: "getUploads",
@@ -548,10 +548,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return files;
     }
 
-    /**
-     * Returns the current files that will get uploaded in a type of array
-     *
-     * @returns {Array}
+    /**
+     * Returns the current files that will get uploaded in a type of array
+     *
+     * @returns {Array}
      */
   }, {
     key: "getUploadsArray",
@@ -574,8 +574,8 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       this.setFileStateBeforeUpload.apply(this, arguments);
     }
 
-    /**
-     * Shorthand to set state for a specific file.
+    /**
+     * Shorthand to set state for a specific file.
      */
   }, {
     key: "setFileStateBeforeUpload",
@@ -697,10 +697,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }));
     }
 
-    /**
-     * Get file uploading object.
-     *
-     * @param {string} fileId The ID of the file object to return.
+    /**
+     * Get file uploading object.
+     *
+     * @param {string} fileId The ID of the file object to return.
      */
   }, {
     key: "getFileUploading",
@@ -718,10 +718,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       });
     }
 
-    /**
-     * Get a file object before upload.
-     *
-     * @param {string} fileId The ID of the file object to return.
+    /**
+     * Get a file object before upload.
+     *
+     * @param {string} fileId The ID of the file object to return.
      */
   }, {
     key: "getFileBeforeUpload",
@@ -729,10 +729,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return selectUploadById(this.getGlobalState(), fileId);
     }
 
-    /**
-     * Check if minNumberOfFiles restriction is reached before uploading.
-     *
-     * @private
+    /**
+     * Check if minNumberOfFiles restriction is reached before uploading.
+     *
+     * @private
      */
   }, {
     key: "_checkMinNumberOfFiles",
@@ -745,13 +745,13 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * Check if file passes a set of restrictions set in options: maxFileSize,
-     * maxNumberOfFiles and allowedFileTypes.
-     *
-     * @param {object} files Object of files already added
-     * @param {object} file object to check
-     * @private
+    /**
+     * Check if file passes a set of restrictions set in options: maxFileSize,
+     * maxNumberOfFiles and allowedFileTypes.
+     *
+     * @param {object} files Object of files already added
+     * @param {object} file object to check
+     * @private
      */
   }, {
     key: "_checkRestrictions",
@@ -843,16 +843,16 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * Logs an error, sets Informer message, then throws the error.
-     * Emits a 'restriction-failed' event if it’s a restriction error
-     *
-     * @param {object | string} err — Error object or plain string message
-     * @param {object} [options]
-     * @param {boolean} [options.showInformer=true] — Sometimes developer might want to show Informer manually
-     * @param {object} [options.file=null] — File object used to emit the restriction error
-     * @param {boolean} [options.throwErr=true] — Errors shouldn’t be thrown, for example, in `upload-error` event
-     * @private
+    /**
+     * Logs an error, sets Informer message, then throws the error.
+     * Emits a 'restriction-failed' event if it’s a restriction error
+     *
+     * @param {object | string} err — Error object or plain string message
+     * @param {object} [options]
+     * @param {boolean} [options.showInformer=true] — Sometimes developer might want to show Informer manually
+     * @param {object} [options.file=null] — File object used to emit the restriction error
+     * @param {boolean} [options.throwErr=true] — Errors shouldn’t be thrown, for example, in `upload-error` event
+     * @private
      */
   }, {
     key: "_showOrLogErrorAndThrow",
@@ -905,12 +905,12 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * Create a file state object based on user-provided `addFile()` options.
-     *
-     * Note this is extremely side-effectful and should only be done when a file state object will be added to state immediately afterward!
-     *
-     * The `files` value is passed in because it may be updated by the caller without updating the store.
+    /**
+     * Create a file state object based on user-provided `addFile()` options.
+     *
+     * Note this is extremely side-effectful and should only be done when a file state object will be added to state immediately afterward!
+     *
+     * The `files` value is passed in because it may be updated by the caller without updating the store.
      */
   }, {
     key: "_checkAndCreateFileStateObject",
@@ -998,12 +998,12 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return newFile;
     }
 
-    /**
-     * check if file is available and if not it will throw an error
-     *
-     * @param {string} error — Error message
-     * @param {object} file — File object
-     * @private
+    /**
+     * check if file is available and if not it will throw an error
+     *
+     * @param {string} error — Error message
+     * @param {object} file — File object
+     * @private
      */
   }, {
     key: "_checkIfFileIsAvailable",
@@ -1060,13 +1060,13 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * Add a new file to `state.files`. This will run `onBeforeFileAdded`,
-     * try to guess file type in a clever way, check file against restrictions,
-     * and start an upload if `autoProceed === true`.
-     *
-     * @param {object} file object to add
-     * @returns {string} id for the added file
+    /**
+     * Add a new file to `state.files`. This will run `onBeforeFileAdded`,
+     * try to guess file type in a clever way, check file against restrictions,
+     * and start an upload if `autoProceed === true`.
+     *
+     * @param {object} file object to add
+     * @returns {string} id for the added file
      */
   }, {
     key: "addFile",
@@ -1101,12 +1101,12 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return newFile.id;
     }
 
-    /**
-     * Add multiple files to `state.files`. See the `addFile()` documentation.
-     *
-     * This cuts some corners for performance, so should typically only be used in cases where there may be a lot of files.
-     *
-     * If an error occurs while adding a file, it is logged and the user is notified. This is good for UI plugins, but not for programmatic use. Programmatic users should usually still use `addFile()` on individual files.
+    /**
+     * Add multiple files to `state.files`. See the `addFile()` documentation.
+     *
+     * This cuts some corners for performance, so should typically only be used in cases where there may be a lot of files.
+     *
+     * If an error occurs while adding a file, it is logged and the user is notified. This is good for UI plugins, but not for programmatic use. Programmatic users should usually still use `addFile()` on individual files.
      */
   }, {
     key: "addFiles",
@@ -1295,9 +1295,9 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.upload(_defineProperty({}, file.id, file));
     }
 
-    /**
-     * Registers listeners for all global actions, like:
-     * `error`, `file-removed`, `upload-progress`
+    /**
+     * Registers listeners for all global actions, like:
+     * `error`, `file-removed`, `upload-progress`
      */
   }, {
     key: "_addListeners",
@@ -1396,12 +1396,12 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.opts.id;
     }
 
-    /**
-     * Registers a plugin with Core.
-     *
-     * @param {object} Plugin object
-     * @param {object} [opts] object with options to be passed to Plugin
-     * @returns {object} self for chaining
+    /**
+     * Registers a plugin with Core.
+     *
+     * @param {object} Plugin object
+     * @param {object} [opts] object with options to be passed to Plugin
+     * @returns {object} self for chaining
      */
   }, {
     key: "use",
@@ -1439,11 +1439,11 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this;
     }
 
-    /**
-     * Find one Plugin by name.
-     *
-     * @param {string} id plugin id
-     * @returns {object|boolean}
+    /**
+     * Find one Plugin by name.
+     *
+     * @param {string} id plugin id
+     * @returns {object|boolean}
      */
   }, {
     key: "getPlugin",
@@ -1458,10 +1458,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return foundPlugin;
     }
 
-    /**
-     * Get all the pre-processor plugins
-     *
-     * @returns array
+    /**
+     * Get all the pre-processor plugins
+     *
+     * @returns array
      */
   }, {
     key: "getPreProcessors",
@@ -1469,10 +1469,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.preProcessors;
     }
 
-    /**
-     * Get all the post-processor plugins
-     *
-     * @returns array
+    /**
+     * Get all the post-processor plugins
+     *
+     * @returns array
      */
   }, {
     key: "getPostProcessors",
@@ -1480,10 +1480,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.postProcessors;
     }
 
-    /**
-     * Iterate through all `use`d plugins.
-     *
-     * @param {Function} method that will be run on each plugin
+    /**
+     * Iterate through all `use`d plugins.
+     *
+     * @param {Function} method that will be run on each plugin
      */
   }, {
     key: "iteratePlugins",
@@ -1513,10 +1513,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return Boolean(this.getPlugin(pluginIdToCheck));
     }
 
-    /**
-     * Uninstall and remove a plugin.
-     *
-     * @param {object} instance The plugin instance to remove.
+    /**
+     * Uninstall and remove a plugin.
+     *
+     * @param {object} instance The plugin instance to remove.
      */
   }, {
     key: "removePlugin",
@@ -1536,8 +1536,8 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       this.emit('plugins-updated', this._getInstalledPkgs());
     }
 
-    /**
-     * Uninstall all plugins and close down this filerobot instance.
+    /**
+     * Uninstall all plugins and close down this filerobot instance.
      */
   }, {
     key: "close",
@@ -1553,13 +1553,13 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       });
     }
 
-    /**
-     * Set info message in `state.info`, so that UI plugins like `Informer`
-     * can display the message.
-     *
-     * @param {string | object} message Message to be displayed by the informer
-     * @param {string} [type]
-     * @param {number} [duration]
+    /**
+     * Set info message in `state.info`, so that UI plugins like `Informer`
+     * can display the message.
+     *
+     * @param {string | object} message Message to be displayed by the informer
+     * @param {string} [type]
+     * @param {number} [duration]
      */
   }, {
     key: "info",
@@ -1598,12 +1598,12 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       this.emit('info-hidden');
     }
 
-    /**
-     * Passes messages to a function, provided in `opts.logger`.
-     * If `opts.logger: filerobot.debugLogger` or `opts.debug: true`, logs to the browser console.
-     *
-     * @param {string|object} message to log
-     * @param {string} [type] optional `error` or `warning`
+    /**
+     * Passes messages to a function, provided in `opts.logger`.
+     * If `opts.logger: filerobot.debugLogger` or `opts.debug: true`, logs to the browser console.
+     *
+     * @param {string|object} message to log
+     * @param {string} [type] optional `error` or `warning`
      */
   }, {
     key: "log",
@@ -1625,8 +1625,8 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * Obsolete, event listeners are now added in the constructor.
+    /**
+     * Obsolete, event listeners are now added in the constructor.
      */
   }, {
     key: "run",
@@ -1635,8 +1635,8 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this;
     }
 
-    /**
-     * Restore an upload by its ID.
+    /**
+     * Restore an upload by its ID.
      */
   }, {
     key: "restore",
@@ -1649,11 +1649,11 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this._runUploadOperation(uploadId);
     }
 
-    /**
-     * Create an upload for a bunch of files.
-     *
-     * @param {Object} files Files to include in this upload.
-     * @returns {string} ID of this upload.
+    /**
+     * Create an upload for a bunch of files.
+     *
+     * @param {Object} files Files to include in this upload.
+     * @returns {string} ID of this upload.
      */
   }, {
     key: "_createUploadOperation",
@@ -1692,11 +1692,11 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       return this.getUploadOperations()[uploadId];
     }
 
-    /**
-     * Add data to an upload's result object.
-     *
-     * @param {string} uploadId The ID of the upload.
-     * @param {object} data Data properties to add to the result object.
+    /**
+     * Add data to an upload's result object.
+     *
+     * @param {string} uploadId The ID of the upload.
+     * @param {object} data Data properties to add to the result object.
      */
   }, {
     key: "addResultData",
@@ -1712,10 +1712,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       });
     }
 
-    /**
-     * Remove an upload, eg. if it has been canceled or completed.
-     *
-     * @param {string} uploadId The ID of the upload.
+    /**
+     * Remove an upload, eg. if it has been canceled or completed.
+     *
+     * @param {string} uploadId The ID of the upload.
     */
   }, {
     key: "_removeUploadOperation",
@@ -1723,10 +1723,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       delete this.uploadOperations[uploadId];
     }
 
-    /**
-     * Edit an upload, eg. if its step/phase is being updated.
-     *
-     * @param {string} updatedUpload - the updated/changed upload operation must contain `id` for the upload's id to be changed.
+    /**
+     * Edit an upload, eg. if its step/phase is being updated.
+     *
+     * @param {string} updatedUpload - the updated/changed upload operation must contain `id` for the upload's id to be changed.
      */
   }, {
     key: "_updateUploadOperation",
@@ -1758,10 +1758,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       });
     }
 
-    /**
-     * Run an upload. This picks up where it left off in case the upload is being restored.
-     *
-     * @private
+    /**
+     * Run an upload. This picks up where it left off in case the upload is being restored.
+     *
+     * @private
      */
   }, {
     key: "_runUploadOperation",
@@ -1845,10 +1845,10 @@ var ScaleflexWidget = /*#__PURE__*/function () {
       });
     }
 
-    /**
-     * Start an upload for all the files that are not currently being uploaded.
-     *
-     * @returns {Promise}
+    /**
+     * Start an upload for all the files that are not currently being uploaded.
+     *
+     * @returns {Promise}
      */
   }, {
     key: "upload",