Merge branch 'release/21.10.0'

Author: adlius

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).
 
+## [21.10.0] - 2021-11-30
+### Added
+- Registration versioning
+
 ## [21.9.0] - 2021-11-08
 ### Changed
 - Misc a11y fixes
@@ -1810,7 +1814,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Quick Files
 
-[21.8.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.9.0
+[21.10.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.10.0
+[21.9.2]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.9.2
+[21.9.1]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.9.1
+[21.9.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.9.0
 [21.8.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.8.0
 [21.7.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.7.0
 [21.6.3]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/21.6.3

app/adapters/schema-response-action.ts

@@ -0,0 +1,11 @@
+import OsfAdapter from './osf-adapter';
+
+export default class SchemaResponseActionAdapter extends OsfAdapter {
+    parentRelationship = 'target';
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'schema-response-action': SchemaResponseActionAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/schema-response.ts

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

app/models/node.ts

@@ -218,6 +218,12 @@ export default class NodeModel extends AbstractNodeModel.extend(Validations, Col
         return Array.isArray(this.currentUserPermissions) && this.currentUserPermissions.includes(Permission.Read);
     }
 
+    @computed('currentUserPermissions.length')
+    get currentUserIsReadOnly() {
+        return Array.isArray(this.currentUserPermissions) && this.currentUserPermissions.includes(Permission.Read)
+            && this.currentUserPermissions.length === 1;
+    }
+
     /**
      * The type of this node.
      */

app/models/provider.ts

@@ -50,6 +50,7 @@ export default abstract class ProviderModel extends OsfModel {
     @attr('string') facebookAppId!: string;
     @attr('boolean') allowSubmissions!: boolean;
     @attr('boolean') allowCommenting!: boolean;
+    @attr('boolean') allowUpdates!: boolean;
     @attr('fixstring') reviewsWorkflow!: string | null;
     @attr('boolean') reviewsCommentsAnonymous!: boolean | null;
     @attr() assets?: Partial<Assets>; // TODO: camelize in transform

app/models/registration.ts

@@ -3,6 +3,7 @@ import { buildValidations, validator } from 'ember-cp-validations';
 
 import DraftRegistrationModel from 'ember-osf-web/models/draft-registration';
 import ReviewActionModel, { ReviewActionTrigger } from 'ember-osf-web/models/review-action';
+import SchemaResponseModel, { RevisionReviewStates } from 'ember-osf-web/models/schema-response';
 import { RegistrationResponse } from 'ember-osf-web/packages/registration-schema';
 
 import CommentModel from './comment';
@@ -11,6 +12,7 @@ import InstitutionModel from './institution';
 import NodeModel from './node';
 import RegistrationProviderModel from './registration-provider';
 import RegistrationSchemaModel, { RegistrationMetadata } from './registration-schema';
+import { SchemaResponseActionTrigger } from './schema-response-action';
 import UserModel from './user';
 
 export enum RegistrationReviewStates {
@@ -25,11 +27,29 @@ export enum RegistrationReviewStates {
     PendingWithdraw = 'pending_withdraw',
 }
 
-type NonActionableStates = RegistrationReviewStates.Initial
+export type NonActionableRegistrationStates = RegistrationReviewStates.Initial
     | RegistrationReviewStates.Withdrawn | RegistrationReviewStates.Rejected;
 
-export type ReviewsStateToDecisionMap = Exclude<RegistrationReviewStates, NonActionableStates>;
-export const reviewsStateToDecisionMap: { [index in ReviewsStateToDecisionMap]: ReviewActionTrigger[] } = {
+export type ActionableRevisionStates = RevisionReviewStates.RevisionPendingModeration;
+
+export type ReviewsStateToDecisionMap =
+    Exclude<RegistrationReviewStates, NonActionableRegistrationStates> | RevisionReviewStates.RevisionPendingModeration;
+export const reviewsStateToDecisionMap: {
+    [index in ReviewsStateToDecisionMap]: Array<
+        Exclude<
+            ReviewActionTrigger,
+            ReviewActionTrigger.Submit
+            | ReviewActionTrigger.RequestWithdrawal
+            | ReviewActionTrigger.RequestEmbargoTermination>
+        |
+        Exclude<
+            SchemaResponseActionTrigger,
+            SchemaResponseActionTrigger.SubmitRevision
+            | SchemaResponseActionTrigger.AdminApproveRevision
+            | SchemaResponseActionTrigger.AdminRejectRevision
+        >
+    >
+} = {
     [RegistrationReviewStates.Accepted]: [ReviewActionTrigger.ForceWithdraw],
     [RegistrationReviewStates.Embargo]: [ReviewActionTrigger.ForceWithdraw],
     [RegistrationReviewStates.Pending]:
@@ -38,6 +58,8 @@ export const reviewsStateToDecisionMap: { [index in ReviewsStateToDecisionMap]:
         [ReviewActionTrigger.AcceptWithdrawal, ReviewActionTrigger.RejectWithdrawal],
     [RegistrationReviewStates.PendingWithdrawRequest]: [ReviewActionTrigger.ForceWithdraw],
     [RegistrationReviewStates.PendingEmbargoTermination]: [ReviewActionTrigger.ForceWithdraw],
+    [RevisionReviewStates.RevisionPendingModeration]:
+        [SchemaResponseActionTrigger.AcceptRevision, SchemaResponseActionTrigger.RejectRevision],
 };
 
 const Validations = buildValidations({
@@ -79,9 +101,10 @@ 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;
+    @attr('fixstring') reviewsState!: RegistrationReviewStates;
     @attr('fixstring') iaUrl?: string;
     @attr('array') providerSpecificMetadata!: ProviderMetadata[];
+    @attr('fixstring') revisionState!: RevisionReviewStates;
     @attr('boolean') wikiEnabled!: boolean;
 
     // Write-only attributes
@@ -121,6 +144,15 @@ export default class RegistrationModel extends NodeModel.extend(Validations) {
     @hasMany('review-action', { inverse: 'target' })
     reviewActions!: AsyncHasMany<ReviewActionModel> | ReviewActionModel[];
 
+    @hasMany('schema-response', { inverse: 'registration' })
+    schemaResponses!: AsyncHasMany<SchemaResponseModel> | SchemaResponseModel[];
+
+    @belongsTo('schema-response', { inverse: null })
+    originalResponse!: AsyncBelongsTo<SchemaResponseModel> | SchemaResponseModel;
+
+    @belongsTo('schema-response', { inverse: null })
+    latestResponse!: AsyncBelongsTo<SchemaResponseModel> | SchemaResponseModel; // Latest accepted response
+
     // Write-only relationships
     @belongsTo('draft-registration', { inverse: null })
     draftRegistration!: DraftRegistrationModel;

app/models/schema-response-action.ts

@@ -0,0 +1,53 @@
+import { attr, belongsTo, AsyncBelongsTo } from '@ember-data/model';
+import { computed } from '@ember/object';
+import { inject as service } from '@ember/service';
+import Intl from 'ember-intl/services/intl';
+import SchemaResponseModel, { RevisionReviewStates } from 'ember-osf-web/models/schema-response';
+import UserModel from 'ember-osf-web/models/user';
+import OsfModel from './osf-model';
+
+export enum SchemaResponseActionTrigger {
+    SubmitRevision = 'submit',
+    AdminApproveRevision = 'approve',
+    AdminRejectRevision = 'admin_reject',
+    AcceptRevision = 'accept',
+    RejectRevision = 'moderator_reject',
+}
+
+const TriggerToPastTenseTranslationKey: Record<SchemaResponseActionTrigger, string> = {
+    submit: 'registries.schemaResponseActions.triggerPastTense.submit',
+    approve: 'registries.schemaResponseActions.triggerPastTense.approve',
+    admin_reject: 'registries.schemaResponseActions.triggerPastTense.admin_reject',
+    accept: 'registries.schemaResponseActions.triggerPastTense.accept',
+    moderator_reject: 'registries.schemaResponseActions.triggerPastTense.moderator_reject',
+};
+
+export default class SchemaResponseActionModel extends OsfModel {
+    @service intl!: Intl;
+
+    @attr('string') actionTrigger!: SchemaResponseActionTrigger;
+    @attr('fixstring') comment!: string;
+    @attr('string') fromState!: RevisionReviewStates;
+    @attr('string') toState!: RevisionReviewStates;
+    @attr('date') dateCreated!: Date;
+    @attr('date') dateModified!: Date;
+    @attr('boolean') visible!: boolean;
+
+    @belongsTo('user', { inverse: null })
+    creator!: AsyncBelongsTo<UserModel> & UserModel;
+
+    @belongsTo('schema-response', { inverse: 'actions' })
+    target!: AsyncBelongsTo<SchemaResponseModel> & SchemaResponseModel;
+
+    @computed('actionTrigger')
+    get triggerPastTense(): string {
+        const key = TriggerToPastTenseTranslationKey[this.actionTrigger] || '';
+        return key ? this.intl.t(key) : '';
+    }
+}
+
+declare module 'ember-data/types/registries/model' {
+    export default interface ModelRegistry {
+        'schema-response-action': SchemaResponseActionModel;
+    } // eslint-disable-line semi
+}

app/models/schema-response.ts

@@ -0,0 +1,39 @@
+import { AsyncBelongsTo, AsyncHasMany, attr, belongsTo, hasMany } from '@ember-data/model';
+import RegistrationModel from 'ember-osf-web/models/registration';
+import RegistrationSchemaModel from 'ember-osf-web/models/registration-schema';
+import SchemaResponseActionModel from 'ember-osf-web/models/schema-response-action';
+import UserModel from 'ember-osf-web/models/user';
+import { RegistrationResponse } from 'ember-osf-web/packages/registration-schema';
+
+import OsfModel from './osf-model';
+
+export enum RevisionReviewStates {
+    Unapproved = 'unapproved',
+    RevisionInProgress = 'in_progress',
+    RevisionPendingModeration = 'pending_moderation',
+    Approved = 'approved',
+}
+
+export default class SchemaResponseModel extends OsfModel {
+    @attr('fixstring') reviewsState!: RevisionReviewStates;
+    @attr('date') dateCreated!: Date;
+    @attr('date') dateModified!: Date;
+    @attr('fixstring') revisionJustification!: string;
+    @attr('registration-response-key-array') updatedResponseKeys!: string[];
+    @attr('registration-responses') revisionResponses!: RegistrationResponse;
+    @attr('boolean') isOriginalResponse!: boolean;
+    @attr('boolean') isPendingCurrentUserApproval!: boolean;
+
+    @belongsTo('user') initiatedBy!: AsyncBelongsTo<UserModel> & UserModel;
+    @belongsTo('registration') registration!: AsyncBelongsTo<RegistrationModel> & RegistrationModel;
+    @belongsTo('registration-schema')
+    registrationSchema!: AsyncBelongsTo<RegistrationSchemaModel> & RegistrationSchemaModel;
+    @hasMany('schema-response-action', { inverse: 'target' })
+    actions!: AsyncHasMany<SchemaResponseActionModel> | SchemaResponseActionModel[];
+}
+
+declare module 'ember-data/types/registries/model' {
+    export default interface ModelRegistry {
+        'schema-response': SchemaResponseModel;
+    } // eslint-disable-line semi
+}

app/packages/registration-schema/get-schema-block-group.ts

@@ -8,7 +8,7 @@ function isEmpty(input?: string | null) {
     return false;
 }
 
-export function getSchemaBlockGroups(blocks: SchemaBlock[] | undefined) {
+export function getSchemaBlockGroups(blocks: SchemaBlock[], updatedGroupKeys?: string[]) {
     if (!blocks) {
         assert('getSchemaBlockGroups() requires blocks');
         return undefined;
@@ -52,6 +52,9 @@ export function getSchemaBlockGroups(blocks: SchemaBlock[] | undefined) {
                 schemaBlockGroup.inputBlock = block;
                 schemaBlockGroup.registrationResponseKey = block.registrationResponseKey;
                 schemaBlockGroup.groupType = block.blockType;
+                if (updatedGroupKeys && updatedGroupKeys.includes(schemaBlockGroup.registrationResponseKey!)) {
+                    schemaBlockGroup.updated = true;
+                }
                 break;
             case 'select-input-option':
                 if (schemaBlockGroup.inputBlock) {

app/packages/registration-schema/index.ts

@@ -2,7 +2,7 @@ export { getPages } from './get-pages';
 export { getSchemaBlockGroups } from './get-schema-block-group';
 export { SchemaBlock, SchemaBlockType } from './schema-block';
 export { SchemaBlockGroup } from './schema-block-group';
-export { buildValidation, buildMetadataValidations } from './validations';
+export { buildValidation, buildMetadataValidations, buildSchemaResponseValidations } from './validations';
 export {
     FileReference,
     RegistrationResponse,