@@ -14,35 +14,29 @@ The `withSubmitRevision` HOC contains the logic for submitting a manuscript vers
`submitRevision` namespace contains the following fields:
Name|Type|Description
---|---|---
initialValues|`{...fragment}`| Object containing the initial state of the fragment
addFile|`({ file: object, type: string, fragment: object }) => any`|Uploads the file to the server
journal|`function`|Des Cri Pti On!
history|`object`|Added by `react-router` to allow navigation
fragment|`function`|Des Cri Pti On!
canSubmit|`function`|Des Cri Pti On!
addAuthor|`function`|Des Cri Pti On!
showModal|`function`|Des Cri Pti On!
. initialValues|`{...fragment}`| Object containing the initial state of the fragment
. addFile|`({ file: object, type: string, fragment: object }) => any`|Uploads the file to the server
journal|`???`|???
. collection|`object`|Object containing the selected collection
. fragment|`object`|Object containing the selected fragment
. canSubmit|`bool`|Value representing if the form doesn't have errors and can be submitted
. addAuthor|`({ author, collectionId: string, fragmentId: string }) => any`|An async call to add an author to the manuscript
changeForm|`function`|Des Cri Pti On!
collection|`function`|Des Cri Pti On!
isFetching|`function`|Des Cri Pti On!
deleteFile|`function`|Des Cri Pti On!
currentUser|`function`|Des Cri Pti On!
setFetching|`function`|Des Cri Pti On!
previewFile|`function`|Des Cri Pti On!
downloadFile|`function`|Des Cri Pti On!
. deleteFile|`({ fileId: string, type: string }) => any`|Removes the file from the server
. currentUser|`object`|Object containing the currently logged user
onAuthorEdit|`function`|Des Cri Pti On!
deleteAuthor|`function`|Des Cri Pti On!
getSignedUrl|`function`|Des Cri Pti On!
. deleteAuthor|`({ authorId, fragmentId, collectionId }) => any`|An async call to remove an existing author from the manuscript
. getSignedUrl|`(id: string) => Promise({signedURL: string})`|An async call that returns the securized S3 file url
hasFormError|`function`|Des Cri Pti On!
formErrors|`function`|Des Cri Pti On!
fetchingError|`string`|Value representing a server request error
addResponseFile|`file => any`|Uploads the file and adds it on the form
deleteResponseFile|`file => any`|Deletes the file from the server and removes it from the form
isEditingAuthor|`bool`|Value representing if the current user is the editing author
onChange|`(reduxFormValues, dispatch, { collection, fragment }) => any`|Used to autosave new fragment when fields change
onSubmit|`(reduxFormValues, dispatch, { history, fragment, collection, showModal, setFetching, canSubmit })`|Handles the submission of a new manuscript version
validate|`({ editAuthors, files, responseToReviewers }) => errors: object`|Checks the form for required fields and returns the errors
responseFile|`file`|Value containing the revision's file for the reviewer's response
. onChange|`(reduxFormValues, dispatch, { collection, fragment }) => any`|Used to autosave new fragment when fields change
. onSubmit|`(reduxFormValues, dispatch, { history, fragment, collection, showModal, setFetching, canSubmit })`|Handles the submission of a new manuscript version
. validate|`({ editAuthors: , files: array, responseToReviewers: object }) => errors: object`|Checks the form for required fields and returns the errors
. responseFile|`file`|Value containing the revision's file for the reviewer's response
