Merge branch 'release/20.12.0'

Author: fabmiz

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [20.12.0] - 2020-12-08
+### Added
+- branded registries moderation
+
 ## [20.11.0] - 2020-11-03
 ### Added
 - storage caps support in quickfiles and draft registrations
@@ -1674,7 +1678,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Quick Files
 
-[Unreleased]: https://github.com/CenterForOpenScience/ember-osf-web/compare/20.11.0...develop
+[Unreleased]: https://github.com/CenterForOpenScience/ember-osf-web/compare/20.12.0...develop
+[20.12.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/20.12.0
 [20.11.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/20.11.0
 [20.10.1]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/20.10.1
 [20.10.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/20.10.0

app/adapters/moderator.ts

@@ -0,0 +1,21 @@
+import DS from 'ember-data';
+import OsfAdapter from './osf-adapter';
+
+interface ModeratorAdapterOptions {
+    providerId: string;
+}
+
+export default class ModeratorAdapter extends OsfAdapter {
+    parentRelationship = 'provider';
+    urlForFindRecord(id: string, _: string, snapshot: DS.Snapshot): string {
+        const adapterOptions = snapshot.adapterOptions as ModeratorAdapterOptions;
+        const { providerId } = adapterOptions;
+        return `${this.urlPrefix()}/providers/registrations/${providerId}/moderators/${id}`;
+    }
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        moderator: ModeratorAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/review-action.ts

@@ -1,9 +1,7 @@
 import OsfAdapter from './osf-adapter';
 
 export default class ReviewActionAdapter extends OsfAdapter {
-    pathForType(_: string): string {
-        return 'actions/reviews/';
-    }
+    parentRelationship = 'target';
 }
 
 declare module 'ember-data/types/registries/adapter' {

app/adapters/subscription.ts

@@ -0,0 +1,10 @@
+import OsfAdapter from './osf-adapter';
+
+export default class SubscriptionAdapter extends OsfAdapter {
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        subscription: SubscriptionAdapter;
+    } // eslint-disable-line semi
+}

app/models/moderator.ts

@@ -0,0 +1,32 @@
+import DS from 'ember-data';
+
+import UserModel from 'ember-osf-web/models/user';
+import OsfModel from './osf-model';
+import RegistrationProviderModel from './registration-provider';
+
+const { attr, belongsTo } = DS;
+
+export enum PermissionGroup {
+    Admin = 'admin',
+    Moderator = 'moderator',
+}
+
+export default class ModeratorModel extends OsfModel {
+    @attr('string') permissionGroup!: PermissionGroup;
+
+    // Write-only attributes
+    @attr('string') fullName!: string;
+    @attr('string') email!: string;
+
+    @belongsTo('registration-provider', { inverse: 'moderators', polymorphic: true })
+    provider!: RegistrationProviderModel;
+
+    @belongsTo('user', { inverse: null })
+    user!: UserModel;
+}
+
+declare module 'ember-data/types/registries/model' {
+    export default interface ModelRegistry {
+        'moderator': ModeratorModel;
+    } // eslint-disable-line semi
+}

app/models/preprint-provider.ts

@@ -24,9 +24,7 @@ export default class PreprintProviderModel extends ProviderModel {
 
     // Reviews settings
     @attr('array') permissions!: string[];
-    @attr('string') reviewsWorkflow!: string | null;
     @attr('boolean', { allowNull: true }) reviewsCommentsPrivate!: boolean | null;
-    @attr('boolean', { allowNull: true }) reviewsCommentsAnonymous!: boolean | null;
 
     // Relationships
     @hasMany('preprint', { inverse: 'provider' })

app/models/provider.ts

@@ -20,6 +20,24 @@ export interface Assets {
     wide_white: string;
 }
 
+export enum ReviewPermissions {
+    SetUpModeration = 'set_up_moderation',
+    ViewSubmissions = 'view_submissions',
+    AcceptSubmissions = 'accept_submissions',
+    RejectSubmissions = 'reject_submissions',
+    WithdrawSubmissions = 'withdraw_submissions',
+    EditReviewComments = 'edit_review_comments',
+    ViewActions = 'view_actions',
+    AddModerator = 'add_moderator',
+    UpdateModerator = 'update_moderator',
+    RemoveModerator = 'remove_moderator',
+    EditReviewSettings = 'edit_review_settings',
+    AddReviewer = 'add_reviewer',
+    AssignReviewer = 'assign_reviewer',
+    ViewAssignedSubmissions = 'view_assigned_submissions',
+    ReviewAssignedSubmissions = 'review_assigned_submissions',
+}
+
 /* eslint-enable camelcase */
 
 export default abstract class ProviderModel extends OsfModel {
@@ -34,6 +52,8 @@ export default abstract class ProviderModel extends OsfModel {
     @attr('string') facebookAppId!: string;
     @attr('boolean') allowSubmissions!: boolean;
     @attr('boolean') allowCommenting!: boolean;
+    @attr('fixstring') reviewsWorkflow!: string | null;
+    @attr('boolean') reviewsCommentsAnonymous!: boolean | null;
     @attr() assets?: Partial<Assets>; // TODO: camelize in transform
 
     @hasMany('subject', { inverse: null, async: false })

app/models/registration-provider.ts

@@ -1,8 +1,11 @@
 import DS from 'ember-data';
+import ReviewActionModel from 'ember-osf-web/models/review-action';
 
+import { computed } from '@ember/object';
 import RegistrationSchemaModel from 'ember-osf-web/models/registration-schema';
 import BrandModel from './brand';
-import ProviderModel from './provider';
+import ModeratorModel from './moderator';
+import ProviderModel, { ReviewPermissions } from './provider';
 import RegistrationModel from './registration';
 
 const { attr, hasMany, belongsTo } = DS;
@@ -17,11 +20,28 @@ export default class RegistrationProviderModel extends ProviderModel {
     @hasMany('registration-schema', { inverse: null })
     schemas!: DS.PromiseManyArray<RegistrationSchemaModel> | RegistrationSchemaModel[];
 
+    @hasMany('moderator', { inverse: 'provider' })
+    moderators!: DS.PromiseManyArray<ModeratorModel> | ModeratorModel[];
+
+    @hasMany('review-action', { inverse: null })
+    actions!: DS.PromiseManyArray<ReviewActionModel> | ReviewActionModel[];
+
     @attr('fixstring')
     shareSource?: string;
 
     @attr('boolean')
     brandedDiscoveryPage?: boolean;
+
+    @attr('array')
+    permissions!: ReviewPermissions[];
+
+    @computed('permissions')
+    get currentUserCanReview() {
+        if (this.permissions) {
+            return this.permissions.includes(ReviewPermissions.ViewSubmissions);
+        }
+        return false;
+    }
 }
 
 declare module 'ember-data/types/registries/model' {

app/models/registration.ts

@@ -1,8 +1,8 @@
-import { computed } from '@ember/object';
 import { buildValidations, validator } from 'ember-cp-validations';
 import DS from 'ember-data';
 
 import DraftRegistrationModel from 'ember-osf-web/models/draft-registration';
+import ReviewActionModel, { ReviewActionTrigger } from 'ember-osf-web/models/review-action';
 import { RegistrationResponse } from 'ember-osf-web/packages/registration-schema';
 
 import CommentModel from './comment';
@@ -15,16 +15,33 @@ import UserModel from './user';
 
 const { attr, belongsTo, hasMany } = DS;
 
-export enum RegistrationState {
-    Embargoed = 'Embargoed',
-    Public = 'Public',
-    Withdrawn = 'Withdrawn',
-    PendingRegistration = 'PendingRegistration',
-    PendingWithdrawal = 'PendingWithdrawal',
-    PendingEmbargo = 'PendingEmbargo',
-    PendingEmbargoTermination = 'PendingEmbargoTermination',
+export enum RegistrationReviewStates {
+    Initial = 'initial',
+    Pending = 'pending',
+    Accepted = 'accepted',
+    Rejected = 'rejected',
+    Withdrawn = 'withdrawn',
+    Embargo = 'embargo',
+    PendingEmbargoTermination = 'pending_embargo_termination',
+    PendingWithdrawRequest = 'pending_withdraw_request',
+    PendingWithdraw = 'pending_withdraw',
 }
 
+type NonActionableStates = RegistrationReviewStates.Initial
+    | RegistrationReviewStates.Withdrawn | RegistrationReviewStates.Rejected;
+
+export type ReviewsStateToDecisionMap = Exclude<RegistrationReviewStates, NonActionableStates>;
+export const reviewsStateToDecisionMap: { [index in ReviewsStateToDecisionMap]: ReviewActionTrigger[] } = {
+    [RegistrationReviewStates.Accepted]: [ReviewActionTrigger.ForceWithdraw],
+    [RegistrationReviewStates.Embargo]: [ReviewActionTrigger.ForceWithdraw],
+    [RegistrationReviewStates.Pending]:
+        [ReviewActionTrigger.AcceptSubmission, ReviewActionTrigger.RejectSubmission],
+    [RegistrationReviewStates.PendingWithdraw]:
+        [ReviewActionTrigger.AcceptWithdrawal, ReviewActionTrigger.RejectWithdrawal],
+    [RegistrationReviewStates.PendingWithdrawRequest]: [ReviewActionTrigger.ForceWithdraw],
+    [RegistrationReviewStates.PendingEmbargoTermination]: [ReviewActionTrigger.ForceWithdraw],
+};
+
 const Validations = buildValidations({
     license: [
         validator('presence', {
@@ -57,26 +74,13 @@ export default class RegistrationModel extends NodeModel.extend(Validations) {
     @attr('fixstring') articleDoi!: string | null;
     @attr('object') registeredMeta!: RegistrationMetadata;
     @attr('registration-responses') registrationResponses!: RegistrationResponse;
+    @attr('fixstring') reviewsState!: RegistrationReviewStates;
 
     // Write-only attributes
     @attr('array') includedNodeIds?: string[];
     @attr('boolean') createDoi?: boolean;
     @attr('fixstring') draftRegistrationId?: string;
 
-    @computed(
-        'withdrawn', 'embargoed', 'public', 'pendingRegistrationApproval',
-        'pendingEmbargoApproval', 'pendingEmbargoTerminationApproval',
-        'pendingWithdrawal',
-    )
-    get state(): RegistrationState {
-        const stateMap: any = this.registrationStateMap();
-        const currentState: RegistrationState = Object.keys(stateMap)
-            .filter(active => stateMap[active])
-            .map(key => RegistrationState[key as keyof typeof RegistrationState])[0];
-
-        return currentState || RegistrationState.Public;
-    }
-
     @belongsTo('node', { inverse: 'registrations' })
     registeredFrom!: DS.PromiseObject<NodeModel> & NodeModel;
 
@@ -107,31 +111,12 @@ export default class RegistrationModel extends NodeModel.extend(Validations) {
     @hasMany('institution', { inverse: 'registrations' })
     affiliatedInstitutions!: DS.PromiseManyArray<InstitutionModel> | InstitutionModel[];
 
+    @hasMany('review-action', { inverse: 'target' })
+    reviewActions!: DS.PromiseManyArray<ReviewActionModel> | ReviewActionModel[];
+
     // Write-only relationships
     @belongsTo('draft-registration', { inverse: null })
     draftRegistration!: DraftRegistrationModel;
-
-    registrationStateMap(): Record<RegistrationState, boolean> {
-        const {
-            pendingRegistrationApproval,
-            pendingEmbargoApproval,
-            pendingEmbargoTerminationApproval,
-            pendingWithdrawal,
-            withdrawn,
-            embargoed,
-        } = this;
-        const embargo = embargoed && !pendingEmbargoTerminationApproval;
-
-        return {
-            PendingRegistration: pendingRegistrationApproval,
-            PendingEmbargo: pendingEmbargoApproval,
-            PendingEmbargoTermination: pendingEmbargoTerminationApproval,
-            PendingWithdrawal: pendingWithdrawal,
-            Withdrawn: withdrawn,
-            Embargoed: embargo,
-            Public: !pendingWithdrawal,
-        };
-    }
 }
 
 declare module 'ember-data/types/registries/model' {

app/models/review-action.ts

@@ -1,28 +1,59 @@
+import { computed } from '@ember/object';
+import { inject as service } from '@ember/service';
 import DS from 'ember-data';
+import Intl from 'ember-intl/services/intl';
 
 import OsfModel from './osf-model';
-import PreprintModel from './preprint';
-import PreprintProviderModel from './preprint-provider';
+import RegistrationModel from './registration';
 import UserModel from './user';
 
 const { attr, belongsTo } = DS;
 
+export enum ReviewActionTrigger {
+    Submit = 'submit', // registration submitted by admins
+    AcceptSubmission = 'accept_submission', // accept submission
+    RejectSubmission = 'reject_submission', // reject submission
+    ForceWithdraw = 'force_withdraw', // force withdraw without request
+    RequestWithdrawal = 'request_withdrawal', // request to withdraw by contributors
+    AcceptWithdrawal = 'accept_withdrawal', // accept withdrawal request
+    RejectWithdrawal = 'reject_withdrawal', // deny withdrawal request
+    RequestEmbargoTermination = 'request_embargo_termination', // admin requests embargo termination
+}
+
+const TriggerToPastTenseTranslationKey: Record<ReviewActionTrigger, string> = {
+    submit: 'registries.reviewActions.triggerPastTense.submit',
+    accept_submission: 'registries.reviewActions.triggerPastTense.accept_submission',
+    reject_submission: 'registries.reviewActions.triggerPastTense.reject_submission',
+    force_withdraw: 'registries.reviewActions.triggerPastTense.force_withdraw',
+    request_withdrawal: 'registries.reviewActions.triggerPastTense.request_withdrawal',
+    accept_withdrawal: 'registries.reviewActions.triggerPastTense.accept_withdrawal',
+    reject_withdrawal: 'registries.reviewActions.triggerPastTense.reject_withdrawal',
+    request_embargo_termination: 'registries.reviewActions.triggerPastTense.request_embargo_termination',
+};
+
 export default class ReviewActionModel extends OsfModel {
-    @attr('string') actionTrigger!: string;
+    @service intl!: Intl;
+
+    @attr('string') actionTrigger!: ReviewActionTrigger;
     @attr('string') comment!: string;
     @attr('string') fromState!: string;
     @attr('string') toState!: string;
     @attr('date') dateCreated!: Date;
     @attr('date') dateModified!: Date;
+    @attr('boolean') auto!: boolean;
+    @attr('boolean') visible!: boolean;
 
-    @belongsTo('preprint-provider', { inverse: null })
-    provider!: DS.PromiseObject<PreprintProviderModel> & PreprintProviderModel;
-
-    @belongsTo('preprint', { inverse: 'reviewActions' })
-    target!: DS.PromiseObject<PreprintModel> & PreprintModel;
+    @belongsTo('registration', { inverse: 'reviewActions', polymorphic: true })
+    target!: DS.PromiseObject<RegistrationModel> & RegistrationModel;
 
     @belongsTo('user', { inverse: null })
     creator!: DS.PromiseObject<UserModel> & UserModel;
+
+    @computed('actionTrigger')
+    get triggerPastTense(): string {
+        const translationKey = TriggerToPastTenseTranslationKey[this.actionTrigger];
+        return translationKey ? this.intl.t(translationKey) : '';
+    }
 }
 
 declare module 'ember-data/types/registries/model' {