add beforePrepareOutput hook

pqina · Dec 14, 2020 · 2c4e4fb · 2c4e4fb
1 parent 6bcfe7e
commit 2c4e4fb
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 4.25.0
+
+- Add `beforePrepareOutput` hook to intercept and prevent preparing a new output file.
+
+
 ## 4.24.0
 
 - Add action info to internal `SHOULD_PREPARE_OUTPUT` call

diff --git a/dist/filepond.css b/dist/filepond.css
@@ -1,5 +1,5 @@
 /*!
- * FilePond 4.24.0
+ * FilePond 4.25.0
  * Licensed under MIT, https://opensource.org/licenses/MIT/
  * Please visit https://pqina.nl/filepond/ for details.
  */

diff --git a/dist/filepond.esm.js b/dist/filepond.esm.js
@@ -1,5 +1,5 @@
 /*!
- * FilePond 4.24.0
+ * FilePond 4.25.0
  * Licensed under MIT, https://opensource.org/licenses/MIT/
  * Please visit https://pqina.nl/filepond/ for details.
  */
@@ -2011,6 +2011,7 @@ const defaultOptions = {
   beforeDropFile: [null, Type.FUNCTION],
   beforeAddFile: [null, Type.FUNCTION],
   beforeRemoveFile: [null, Type.FUNCTION],
+  beforePrepareOutput: [null, Type.FUNCTION],
 
   // styles
   stylePanelLayout: [null, Type.STRING], // null 'integrated', 'compact', 'circle'
@@ -4195,9 +4196,16 @@ const actions = (dispatch, query, state) => ({
           query,
           action
         }).then(shouldPrepareOutput => {
-          if (!shouldPrepareOutput) {
-            return;
-          }
+          // plugins determined the output data should be prepared (or not), can be adjusted with beforePrepareOutput hook
+          const beforePrepareOutput = query('GET_BEFORE_PREPARE_OUTPUT');
+          if (beforePrepareOutput)
+            shouldPrepareOutput = beforePrepareOutput(
+              item,
+              shouldPrepareOutput
+            );
+
+          if (!shouldPrepareOutput) return;
+
           dispatch(
             'REQUEST_PREPARE_OUTPUT',
             {
@@ -4540,6 +4548,14 @@ const actions = (dispatch, query, state) => ({
         // means we'll do this and wait for idle state
         applyFilterChain('SHOULD_PREPARE_OUTPUT', false, { item, query }).then(
           shouldPrepareOutput => {
+            // plugins determined the output data should be prepared (or not), can be adjusted with beforePrepareOutput hook
+            const beforePrepareOutput = query('GET_BEFORE_PREPARE_OUTPUT');
+            if (beforePrepareOutput)
+              shouldPrepareOutput = beforePrepareOutput(
+                item,
+                shouldPrepareOutput
+              );
+
             const loadComplete = () => {
               dispatch('COMPLETE_LOAD_ITEM', {
                 query: id,

diff --git a/dist/filepond.esm.min.js b/dist/filepond.esm.min.js
diff --git a/dist/filepond.js b/dist/filepond.js
@@ -1,5 +1,5 @@
 /*!
- * FilePond 4.24.0
+ * FilePond 4.25.0
  * Licensed under MIT, https://opensource.org/licenses/MIT/
  * Please visit https://pqina.nl/filepond/ for details.
  */
@@ -4051,6 +4051,7 @@
     beforeDropFile: [null, Type.FUNCTION],
     beforeAddFile: [null, Type.FUNCTION],
     beforeRemoveFile: [null, Type.FUNCTION],
+    beforePrepareOutput: [null, Type.FUNCTION],
 
     // styles
     stylePanelLayout: [null, Type.STRING], // null 'integrated', 'compact', 'circle'
@@ -6630,9 +6631,16 @@
               query: query,
               action: action
             }).then(function(shouldPrepareOutput) {
-              if (!shouldPrepareOutput) {
-                return;
-              }
+              // plugins determined the output data should be prepared (or not), can be adjusted with beforePrepareOutput hook
+              var beforePrepareOutput = query('GET_BEFORE_PREPARE_OUTPUT');
+              if (beforePrepareOutput)
+                shouldPrepareOutput = beforePrepareOutput(
+                  item,
+                  shouldPrepareOutput
+                );
+
+              if (!shouldPrepareOutput) return;
+
               dispatch(
                 'REQUEST_PREPARE_OUTPUT',
                 {
@@ -6998,6 +7006,14 @@
               item: item,
               query: query
             }).then(function(shouldPrepareOutput) {
+              // plugins determined the output data should be prepared (or not), can be adjusted with beforePrepareOutput hook
+              var beforePrepareOutput = query('GET_BEFORE_PREPARE_OUTPUT');
+              if (beforePrepareOutput)
+                shouldPrepareOutput = beforePrepareOutput(
+                  item,
+                  shouldPrepareOutput
+                );
+
               var loadComplete = function loadComplete() {
                 dispatch('COMPLETE_LOAD_ITEM', {
                   query: id,

diff --git a/dist/filepond.min.css b/dist/filepond.min.css
diff --git a/dist/filepond.min.js b/dist/filepond.min.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "filepond",
-    "version": "4.24.0",
+    "version": "4.25.0",
     "description": "FilePond, Where files go to stretch their bits.",
     "license": "MIT",
     "author": {

diff --git a/src/js/app/actions.js b/src/js/app/actions.js
@@ -149,9 +149,13 @@ export const actions = (dispatch, query, state) => ({
                 // should we update the output data
                 applyFilterChain('SHOULD_PREPARE_OUTPUT', false, { item, query, action })
                 .then(shouldPrepareOutput => {
-                    if (!shouldPrepareOutput) {
-                        return;
-                    }
+
+                    // plugins determined the output data should be prepared (or not), can be adjusted with beforePrepareOutput hook
+                    const beforePrepareOutput = query('GET_BEFORE_PREPARE_OUTPUT');
+                    if (beforePrepareOutput) shouldPrepareOutput = beforePrepareOutput(item, shouldPrepareOutput);
+
+                    if (!shouldPrepareOutput) return;
+
                     dispatch('REQUEST_PREPARE_OUTPUT', {
                         query: id,
                         item,
@@ -475,6 +479,10 @@ export const actions = (dispatch, query, state) => ({
                 applyFilterChain('SHOULD_PREPARE_OUTPUT', false, { item, query })
                 .then(shouldPrepareOutput => {
 
+                    // plugins determined the output data should be prepared (or not), can be adjusted with beforePrepareOutput hook
+                    const beforePrepareOutput = query('GET_BEFORE_PREPARE_OUTPUT');
+                    if (beforePrepareOutput) shouldPrepareOutput = beforePrepareOutput(item, shouldPrepareOutput);
+
                     const loadComplete = () => {
 
                         dispatch('COMPLETE_LOAD_ITEM', {

diff --git a/src/js/app/options.js b/src/js/app/options.js
@@ -174,6 +174,7 @@ export const defaultOptions = {
     beforeDropFile: [null, Type.FUNCTION],
     beforeAddFile: [null, Type.FUNCTION],
     beforeRemoveFile: [null, Type.FUNCTION],
+    beforePrepareOutput: [null, Type.FUNCTION],
 
     // styles
     stylePanelLayout: [null, Type.STRING],         // null 'integrated', 'compact', 'circle'