Feature/change event name on success to on upload done (#106)

* feat(event): change name event onSuccess to onUploadDone

* docs(event): @deprecated onSuccess, add onUploadDone

Author: konradkrk

README.md

@@ -25,11 +25,12 @@
   - [Examples](#examples)
   - [filestack-js Client](#filestack-js-client)
   - [SSR](#ssr)
-  - [Migration from 1.x.x and 2.x.x](#migration-from-1.x.x-and-2.x.x)
+  - [Migration from 3.x.x and 4.x.x](#migration-from-3xx-and-4xx)
+  - [Migration from 1.x.x and 2.x.x](#migration-from-1xx-and-2xx)
 - [Live demo](#live-demo)
 - [Development](#development)
 - [Documentation](#documentation)
-- [Contributing](#contributing)
+- [Contribution](#contribution)
 - [Future](#future)
 
 ## Overview
@@ -47,6 +48,7 @@ import { PickerOverlay } from 'filestack-react';
 <PickerOverlay
   apikey={YOUR_API_KEY}
   onSuccess={(res) => console.log(res)}
+  onUploadDone={(res) => console.log(res)}
 />
 ```
 ### Props
@@ -55,7 +57,9 @@ import { PickerOverlay } from 'filestack-react';
 | apikey                           | String        |  true    |                               | Filestack api key                                                                                                                                                                                          |
 | clientOptions                    | Object        |  false   |                               | https://filestack.github.io/filestack-js/interfaces/clientoptions.html                                                                                                                                                          |
 | pickerOptions                    | Object        |  false   |                               | https://filestack.github.io/filestack-js/interfaces/pickeroptions.html                                                                                                                                                          |
-| onSuccess                        | Function      |  false   | result => console.log(result) | A function to be called after successful completed action                                                                                                                                                  |
+| @deprecated onSuccess            | Function      |  false   | result => console.log(result) |  A function to be called after successful completed action                                                                                                                                                  |
+| onUploadDone                     | Function      |  false   | result => console.log(result) | Called when all files have been uploaded                                                                                                                                                  |
+| onError                          | Function      |  false   | error => console.error(error) | A function to be called when error occurs                                                                                                                                                                  |
 | onError                          | Function      |  false   | error => console.error(error) | A function to be called when error occurs                                                                                                                                                                  |
 
 ### Examples

src/picker/picker-base.js

@@ -5,5 +5,6 @@ export const pickerPropTypes = {
   pickerOptions: PropTypes.object,
   clientOptions: PropTypes.object,
   onSuccess: PropTypes.func,
+  onUploadDone: PropTypes.func,
   onError: PropTypes.func
 };

src/picker/picker-drop-pane.jsx

@@ -8,6 +8,7 @@ const PickerDropPane = ({
   pickerOptions,
   clientOptions,
   onSuccess,
+  onUploadDone,
   onError,
   children
 }) => {
@@ -19,6 +20,7 @@ const PickerDropPane = ({
     },
     clientOptions,
     onSuccess,
+    onUploadDone,
     onError
   });
 

src/picker/picker-inline.jsx

@@ -8,6 +8,7 @@ const PickerInline = ({
   pickerOptions,
   clientOptions,
   onSuccess,
+  onUploadDone,
   onError,
   children
 }) => {
@@ -16,6 +17,7 @@ const PickerInline = ({
     pickerOptions: { displayMode: PickerDisplayMode.inline, ...pickerOptions },
     clientOptions,
     onSuccess,
+    onUploadDone,
     onError
   });
 

src/picker/picker-overlay.jsx

@@ -8,6 +8,7 @@ const PickerOverlay = ({
   pickerOptions,
   clientOptions,
   onSuccess,
+  onUploadDone,
   onError,
   children
 }) => {
@@ -16,6 +17,7 @@ const PickerOverlay = ({
     pickerOptions: { displayMode: PickerDisplayMode.overlay, ...pickerOptions },
     clientOptions,
     onSuccess,
+    onUploadDone,
     onError
   });
 

src/picker/use-picker.jsx

@@ -8,22 +8,24 @@ const usePicker = ({
   pickerOptions = {},
   clientOptions = {},
   onSuccess = console.log,
+  onUploadDone = console.log,
   onError = console.error
 }) => {
   const _onError = (error) => {
     onError(error);
   };
 
-  const _onSuccess = (result) => {
+  const _onUploadDone = (result) => {
     onSuccess(result);
+    onUploadDone(result);
   };
 
   const rootId = _generateRandomId();
   const containerId = _generateRandomId();
   const picker = filestack.Filestack(apikey, clientOptions).picker({
     rootId,
     container: `#${containerId}`,
-    onUploadDone: _onSuccess,
+    onUploadDone: _onUploadDone,
     ...pickerOptions
   });
 

src/picker/use-picker.test.js

@@ -32,6 +32,12 @@ describe('usePicker hook', () => {
     expect(onSuccess).toHaveBeenCalledTimes(1);
   });
 
+  it('should call passed onUploadDone function', async () => {
+    const onUploadDone = jest.fn();
+    renderHook(() => usePicker({ apikey: 'x', onUploadDone }));
+    expect(onUploadDone).toHaveBeenCalledTimes(1);
+  });
+
   it('should call passed onError function', async () => {
     const onError = jest.fn();
     renderHook(() => usePicker({ apikey: 'x', onError }));