PathwayCommons · jvwong · Sep 30, 2020 · Sep 28, 2020
diff --git a/src/client/components/carousel.js b/src/client/components/carousel.js
@@ -5,6 +5,8 @@ import _ from 'lodash';
 import { formatDistanceToNow } from 'date-fns';
 import queryString from 'query-string';
 
+import Document from '../../model/document';
+
 export const CAROUSEL_CONTENT = {
   FIGURE: 'figure',
   ABSTRACT: 'abstract'
@@ -14,6 +16,8 @@ export class Carousel extends Component {
   constructor(props){
     super(props);
 
+    const DOCUMENT_STATUS_FIELDS = Document.statusFields();
+
     this.state = {
       pagerLeftAvailable: false,
       pagerRightAvailable: false,
@@ -23,7 +27,7 @@ export class Carousel extends Component {
       refresh: props.refresh || (() => { // get all docs from service by default
         const url = `/api/document`;
         const params = queryString.stringify({
-          status: ['published'].join(','),
+          status: [DOCUMENT_STATUS_FIELDS.PUBLIC].join(','),
           limit: 20
         });
         const doFetch = () => fetch(`${url}?${params}`);

diff --git a/src/client/components/document-management-components.js b/src/client/components/document-management-components.js
@@ -323,7 +323,7 @@ class DocumentManagementDocumentComponent extends React.Component {
               className: makeClassList({ 'show': hasIssues( doc ) })
             }, 'warning' ),
             h( 'i.material-icons.hide-by-default.complete', {
-              className: makeClassList({ 'show': doc.submitted() || doc.published() })
+              className: makeClassList({ 'show': doc.submitted() || doc.isPublic() })
             }, 'check_circle' ),
             h( 'i.material-icons.hide-by-default.mute', {
               className: makeClassList({ 'show': doc.trashed() })
@@ -477,15 +477,15 @@ class DocumentManagementDocumentComponent extends React.Component {
             buttonKey: EMAIL_TYPE_INVITE,
             value: EMAIL_TYPE_INVITE,
             label: _.capitalize( EMAIL_TYPE_INVITE ),
-            disableWhen: doc.requested() || doc.trashed()
+            disableWhen: doc.initiated() || doc.trashed()
           }),
           h( DocumentEmailButtonComponent, {
             params: { doc, apiKey },
             workingMessage: 'Sending...',
             buttonKey: EMAIL_TYPE_FOLLOWUP,
             value: EMAIL_TYPE_FOLLOWUP,
             label: _.upperFirst( EMAIL_TYPE_FOLLOWUP.replace(/([A-Z])/g, (match, letter) => '-' + letter) ),
-            disableWhen: doc.requested() || doc.trashed()
+            disableWhen: doc.initiated() || doc.trashed()
           })
         ]);
       }

diff --git a/src/client/components/document-management.js b/src/client/components/document-management.js
@@ -118,10 +118,6 @@ class DocumentManagement extends DirtyComponent {
       .catch( () => {} );
   }
 
-  handleApproveRequest( doc ){
-    doc.approve();
-  }
-
   handleStatusChange( e ){
     const { value, checked } = e.target;
     const status = this.state.status.slice();

diff --git a/src/client/components/editor/index.js b/src/client/components/editor/index.js
@@ -138,7 +138,7 @@ class Editor extends DataComponent {
 
     doc.on('update', change => {
       if( _.has( change, 'status' ) ){
-        const isDone = this.data.document.submitted() || this.data.document.published();
+        const isDone = this.data.document.submitted() || this.data.document.isPublic();
         this.done( isDone );
       }
     });
@@ -218,7 +218,7 @@ class Editor extends DataComponent {
         this.setData({
           initted: true,
           showHelp: this.data.document.editable(),
-          done: this.data.document.submitted() || this.data.document.published()
+          done: this.data.document.submitted() || this.data.document.isPublic()
         });
 
         const title = _.get(this.data.document.citation(), ['title']);

diff --git a/src/client/components/tasks.js b/src/client/components/tasks.js
@@ -84,7 +84,7 @@ class TaskView extends DataComponent {
     const id = this.props.document.id();
     const secret = this.props.document.secret();
     const params = [
-      { op: 'replace', path: 'status', value: DOCUMENT_STATUS_FIELDS.PUBLISHED }
+      { op: 'replace', path: 'status', value: DOCUMENT_STATUS_FIELDS.PUBLIC }
     ];
     const url = `/api/document/${id}/${secret}`;
     return fetch( url, {

diff --git a/src/model/document/document.js b/src/model/document/document.js
@@ -20,10 +20,9 @@ const DEFAULTS = Object.freeze({
 const METADATA_FIELDS = ['provided', 'article', 'correspondence', 'createdDate', 'lastEditedDate', 'status', 'verified' ];
 const READONLY_METADATA_FIELDS = _.difference( METADATA_FIELDS, ['provided', 'correspondence'] );
 const DOCUMENT_STATUS_FIELDS = Object.freeze({
-  REQUESTED: 'requested',
-  APPROVED: 'approved',
+  INITIATED: 'initiated',
   SUBMITTED: 'submitted',
-  PUBLISHED: 'published',
+  PUBLIC: 'public',
   TRASHED: 'trashed'
 });
 
@@ -419,14 +418,12 @@ class Document {
   }
 
   static statusFields(){ return DOCUMENT_STATUS_FIELDS; }
-  request(){ return this.status( DOCUMENT_STATUS_FIELDS.REQUESTED ); }
-  requested(){ return this.status() === DOCUMENT_STATUS_FIELDS.REQUESTED ? true : false; }
-  approve(){ return this.status( DOCUMENT_STATUS_FIELDS.APPROVED ); }
-  approved(){ return this.status() === DOCUMENT_STATUS_FIELDS.APPROVED ? true : false; }
+  initiate(){ return this.status( DOCUMENT_STATUS_FIELDS.INITIATED ); }
+  initiated(){ return this.status() === DOCUMENT_STATUS_FIELDS.INITIATED ? true : false; }
   submit(){ return this.status( DOCUMENT_STATUS_FIELDS.SUBMITTED ); }
   submitted(){ return this.status() === DOCUMENT_STATUS_FIELDS.SUBMITTED ? true : false; }
-  publish(){ return this.status( DOCUMENT_STATUS_FIELDS.PUBLISHED ); }
-  published(){ return this.status() === DOCUMENT_STATUS_FIELDS.PUBLISHED ? true : false; }
+  makePublic(){ return this.status( DOCUMENT_STATUS_FIELDS.PUBLIC ); }
+  isPublic(){ return this.status() === DOCUMENT_STATUS_FIELDS.PUBLIC ? true : false; }
   trash(){ return this.status( DOCUMENT_STATUS_FIELDS.TRASHED ); }
   trashed(){ return this.status() === DOCUMENT_STATUS_FIELDS.TRASHED ? true : false; }
 

diff --git a/src/server/routes/api/document/export.js b/src/server/routes/api/document/export.js
@@ -3,11 +3,14 @@ import JSZip from 'jszip';
 import _ from 'lodash';
 import fs from 'fs';
 
+import Document from '../../../../model/document';
+
 import { convertDocumentToBiopax,
         convertDocumentToJson,
         convertDocumentToSbgn,
         checkHTTPStatus } from '../../../../util';
 
+const DOCUMENT_STATUS_FIELDS = Document.statusFields();
 const CHUNK_SIZE = 20;
 const EXPORT_TYPES = Object.freeze({
   'JS': 'js',
@@ -26,7 +29,7 @@ const exportToZip = (baseUrl, zipPath, types) => {
       .then( res => {
         offset += res.length;
         if ( res.length > 0 ) {
-          const includedStatuses = ['published'];
+          const includedStatuses = [DOCUMENT_STATUS_FIELDS.PUBLIC];
           const shouldInclude = doc => _.includes(includedStatuses, doc.status);
           let ids = res.filter( shouldInclude ).map( doc => doc.id );
           return addToZip( ids ).then( processNext );

diff --git a/src/server/routes/api/document/index.js b/src/server/routes/api/document/index.js
@@ -711,10 +711,9 @@ http.get('/zip/biopax', function( req, res, next ){
  *   status:
  *     type: string
  *     enum:
- *       - requested
- *       - approved
+ *       - initiated
  *       - submitted
- *       - published
+ *       - public
  *       - trashed
  *
  *   Document:
@@ -1240,8 +1239,7 @@ http.post('/', function( req, res, next ){
   const id = paperId === DEMO_ID ? DEMO_ID: undefined;
   const secret = paperId === DEMO_ID ? DEMO_SECRET: uuid();
 
-  const setRequestStatus = doc => tryPromise( () => doc.request() ).then( () => doc );
-  const setApprovedStatus = doc => tryPromise( () => doc.approve() ).then( () => doc );
+  const setStatus = doc => tryPromise( () => doc.initiate() ).then( () => doc );
   const handleDocCreation = async ({ docDb, eleDb }) => {
     if( id === DEMO_ID ) await deleteTableRows( API_KEY, secret );
     return await createDoc({ docDb, eleDb, id, secret, provided });
@@ -1253,9 +1251,8 @@ http.post('/', function( req, res, next ){
   tryPromise( () => createSecret({ secret }) )
     .then( loadTables )
     .then( handleDocCreation )
-    .then( setRequestStatus )
+    .then( setStatus )
     .then( fillDoc )
-    .then( setApprovedStatus )
     .then( tryVerify )
     .then( sendJSONResponse )
     .then( updateRelatedPapers )
@@ -1364,17 +1361,13 @@ http.post('/email/:id/:secret', function( req, res, next ){
 http.patch('/:id/:secret', function( req, res, next ){
   const { id, secret } = req.params;
 
-  // Publish criteria: non-empty; all entities complete
-  const tryPublish = async doc => {
-    let didPublish = false;
+  // Public criteria: non-empty; all entities complete
+  const tryMakePublic = async doc => {
     const hasEles = doc => doc.elements().length > 0;
     const hasIncompleteEles = doc => doc.elements().some( ele => !ele.completed() && !ele.isInteraction() && ele.type() !== ENTITY_TYPE.COMPLEX );
-    const isPublishable = doc => hasEles( doc ) && !hasIncompleteEles( doc );
-    if( isPublishable( doc ) ){
-      await doc.publish();
-      didPublish = true;
-    }
-    return didPublish;
+    const shouldMakePublic = doc => hasEles( doc ) && !hasIncompleteEles( doc );
+    if( shouldMakePublic( doc ) ) await doc.makePublic();
+    return;
   };
 
   const sendFollowUpNotification = async doc => await configureAndSendMail( EMAIL_TYPE_FOLLOWUP, doc.id(), doc.secret() );
@@ -1388,9 +1381,9 @@ http.patch('/:id/:secret', function( req, res, next ){
       }
     }
   };
-  const handlePublishRequest = async doc => {
-    const didPublish = await tryPublish( doc );
-    if( didPublish ) {
+  const handleMakePublicRequest = async doc => {
+    await tryMakePublic( doc );
+    if( doc.isPublic() ) {
       updateRelatedPapers( doc );
       await tryTweetingDoc( doc );
       sendFollowUpNotification( doc );
@@ -1404,7 +1397,7 @@ http.patch('/:id/:secret', function( req, res, next ){
 
       switch ( path ) {
         case 'status':
-          if( op === 'replace' && value === DOCUMENT_STATUS_FIELDS.PUBLISHED ) await handlePublishRequest( doc );
+          if( op === 'replace' && value === DOCUMENT_STATUS_FIELDS.PUBLIC ) await handleMakePublicRequest( doc );
           break;
         case 'article':
           if( op === 'replace' ) await fillDocArticle( doc );