README.md

# Preface:

- This data model is based on current xpub-collabra and xpub-faraday models, and the discussion that was held in Athens by teams working on those projects.
- This data model is also based on the current work in xpub-elife and the wireframes that are used as guides to build this project.
- These models do not use Collections and Fragments, instead they are standalone models in separate tables.
- JATS was used as a vocabulary, wherever appropriate.
- JATS was used as a source of data types, wherever appropriate.
- All groups of users are modelled with Teams (e.g. Editors, Reviewers, etc.)
- All models have potentially semantic implicit 'created' and 'updated' dates
- All models have an implicit 'id' UUID 
- All dates are ISO-8601 strings, as PostgreSQL recommends this as date input, JATS allows it, and GraphQL can handle it.

# Models

##  Journal

|   | type  | JATS  | comment  |  
|---|---|---|---|
| journalTitle  | String  | `<journal-title>`  |   |
| manuscripts  | [UUID]  |   | Usefulness unclear  |
| meta | JournalMetadata | | 
|  └ meta.publisherName | String | `<publisher-name>` |
|  └ meta.issn | String | `<issn>` | |

##  Manuscript

|   | type  | JATS  | comment  |  
|---|---|---|---|
| journalId  | UUID  |   | Link to Journal  |
| versions  | [UUID]  |   | Link to Versions  |


## ManuscriptVersion

|   | type  | JATS  | comment  |  
|---|---|---|---|
| submissionDate  | String  |   | date  |
| status  | String  |   | e.g. `initial` or `QA`   |
| reviewers  | Team -> [Reviewer]  |   | Link to the reviewers team's members |
| files  | [File]  | `<ext-link>` ?  |   |
| suggestedEditors | [Suggestion] |  |
|  └ suggestion.name | String | | e.g. 'Mr. Opposition' |
|  └ suggestion.type | String |  | e.g. 'seniorEditor' |
|  └ suggestion.reason | String | | e.g. 'They oppose me' |
| suggestedReviewers | [Suggestion] | | same structure as above |
| opposedReviewers | [Suggestion] | | same structure as above |
| opposedEditors | [Suggestion] | | same structure as above |
| recommendations  | [Recommendation]  |   |  Link to the version's reviews' recommentations |
| decision  | Decision  |   |   |
| meta  | ManuscriptMetadata  |   |   |
|  └ meta.title | String | `<title>` |
|  └ meta.abstract | String | `<abstract>` | |
|  └ meta.coverLetter | String | | |
|  └ meta.contributors | [Contributor] | `<contrib>` |
|  &nbsp;&nbsp;└ contributor.stringName | String | `<string-name>` |
|  &nbsp;&nbsp;└ contributor.givenNames | String | `<given-names>` |
|  &nbsp;&nbsp;└ contributor.surname | String | `<surname>` |
|  &nbsp;&nbsp;└ contributor.aff | String | `<aff>` |
|  └ meta.authorNote | String | | |
|  └ meta.publicationDate | String | | date |

## Team

|   | type  | JATS  | comment  |  
|---|---|---|---|
| teamType  | String  |   | e.g. 'reviewers' | 'editors' |
| members | [User] | | |  
| meta | JSON {}  |   | e.g. `{ someMembersId: { status: invited } }`  |
| object | TeamObject | | |
|  └ object.type | String |  | e.g. `ManuscriptVersion`|
|  └ object.id | UUID |  | |


## Decision

|   | type  | JATS  | comment  |  
|---|---|---|---|
| status  | String  |   | e.g. 'accept'  |
| submissionDate  | String  |   | date  |
| content | String  |   |   |
| files | [File]  |   |   |
| userId | UUID  |   | Link to the editor's user  |


## Reviewer

|   | type  | JATS  | comment  |  
|---|---|---|---|
| invitationDate  | String  |   | date  |
| review  | UUID  |   | Link to Review  |
| accepted | Boolean  |   |   |
| responseDate | String  |   |  date |
| userId | UUID  |   |  |
| reminders | [String]  |   | dates |


## Review

|   | type  | JATS  | comment  |  
|---|---|---|---|
| versionId  | UUID  |   | Link to Version  |
| reviewerId | UUID  |   | Link to Reviewer |
| content | String  |   |  |
| files | [File] |   |  |
| submissionDate | String  |   | date |
| recommendationId | UUID | | Link to Recommendation |
 
## Recommendation

| | type  | JATS   | comment |
|---|---|---|---|
| recommendation | String | | accept or revise, etc. |
| userId | UUID | | Link to the user making the recommendation
| recommendationType | String | | e.g. 'review', 'editor'|
| submissionDate | String | | date
| comments | [Comment] | | |
|  &nbsp;&nbsp;└ comment.content | String | | |
|  &nbsp;&nbsp;└ comment.public | String | | |
|  &nbsp;&nbsp;└ files | [File] | | |

## File

| | type | JATS | comment |
|---|---|---|---|
| name | String | |
| URL | String | | 


# Removed

## Journal.owners
The owners relationship is non-core/non-semantic and can be modelled with Teams if needed. As such, it will be deprecated/removed.

## Manuscript.originalSubmissionDate
Original submission date is the first versions's submission date, and isn't needed on the container model.

## ManuscriptVersion.meta.contributors.middleName
JATS recommends using `<given-names>` elements instead