Merge branch 'release/22.11.0'

Author: mfraezz

CHANGELOG.md

@@ -5,6 +5,10 @@ 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).
 
 
+## [22.11.0] - 2022-12-19
+### Changed
+- Collections Moderation
+
 ## [22.10.0] - 2022-10-05
 ### Changed
 - Misc bug and a11y fixes.

app/adapters/action.ts

@@ -0,0 +1,5 @@
+import OsfAdapter from './osf-adapter';
+
+export default class Action extends OsfAdapter {
+    parentRelationship = 'target';
+}

app/adapters/collection-submission-action.ts

@@ -0,0 +1,14 @@
+import ActionAdapter from './action';
+
+export default class CollectionSubmissionActionAdapter extends ActionAdapter {
+    urlForCreateRecord() {
+        // Eventually remove this when we can just post to /v2/collection_submissions/:id/actions
+        return `${this.urlPrefix()}/collection_submission_actions/`;
+    }
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'collection-submission-action': CollectionSubmissionActionAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/collected-metadatum.ts renamed to app/adapters/collection-submission.ts

@@ -7,20 +7,20 @@ import DS from 'ember-data';
 import OsfAdapter from 'ember-osf-web/adapters/osf-adapter';
 import param from 'ember-osf-web/utils/param';
 
-export default class CollectedMetadatumAdapter extends OsfAdapter {
+export default class CollectionSubmissionAdapter extends OsfAdapter {
     urlForHybridGuid(id: string): string {
         const splitId = id.split('-');
 
-        assert('ID for findRecord should be in the format: collectionId-collectedMetadatumId', splitId.length === 2);
+        assert('ID for findRecord should be in the format: collectionSubmissionId-collectionId', splitId.length === 2);
 
-        const [collectionId, collectedMetadatumId] = splitId;
+        const [collectionSubmissionId, collectionId] = splitId;
 
-        return `${this.urlPrefix()}/collections/${collectionId}/collected_metadata/${collectedMetadatumId}`;
+        return `${this.urlPrefix()}/collections/${collectionId}/collection_submissions/${collectionSubmissionId}`;
     }
 
     urlForCreateRecord(_: string | number, { record }: DS.Snapshot): string {
         const collectionId = record.belongsTo('collection').id();
-        return `${this.urlPrefix()}/collections/${collectionId}/collected_metadata/`;
+        return `${this.urlPrefix()}/collections/${collectionId}/collection_submissions/`;
     }
 
     urlForFindRecord(id: string): string {
@@ -62,6 +62,6 @@ export default class CollectedMetadatumAdapter extends OsfAdapter {
 
 declare module 'ember-data/types/registries/adapter' {
     export default interface AdapterRegistry {
-        'collected-metadatum': CollectedMetadatumAdapter;
+        'collection-submission': CollectionSubmissionAdapter;
     } // eslint-disable-line semi
 }

app/adapters/moderator.ts

@@ -3,14 +3,15 @@ import OsfAdapter from './osf-adapter';
 
 interface ModeratorAdapterOptions {
     providerId: string;
+    providerType: 'registrations' | 'collections';
 }
 
 export default class ModeratorAdapter extends OsfAdapter {
     parentRelationship = 'provider';
     urlForFindRecord(id: string, _: string | number, snapshot: DS.Snapshot): string {
         const adapterOptions = snapshot.adapterOptions as ModeratorAdapterOptions;
-        const { providerId } = adapterOptions;
-        return `${this.urlPrefix()}/providers/registrations/${providerId}/moderators/${id}`;
+        const { providerId, providerType } = adapterOptions;
+        return `${this.urlPrefix()}/providers/${providerType}/${providerId}/moderators/${id}`;
     }
 }
 

app/adapters/review-action.ts

@@ -1,7 +1,6 @@
-import OsfAdapter from './osf-adapter';
+import ActionAdapter from './action';
 
-export default class ReviewActionAdapter extends OsfAdapter {
-    parentRelationship = 'target';
+export default class ReviewActionAdapter extends ActionAdapter {
 }
 
 declare module 'ember-data/types/registries/adapter' {

app/adapters/schema-response-action.ts

@@ -1,7 +1,6 @@
-import OsfAdapter from './osf-adapter';
+import ActionAdapter from './action';
 
-export default class SchemaResponseActionAdapter extends OsfAdapter {
-    parentRelationship = 'target';
+export default class SchemaResponseActionAdapter extends ActionAdapter {
 }
 
 declare module 'ember-data/types/registries/adapter' {

app/models/action.ts

@@ -0,0 +1,20 @@
+import { attr, belongsTo, AsyncBelongsTo } from '@ember-data/model';
+
+import UserModel from 'ember-osf-web/models/user';
+import OsfModel from './osf-model';
+
+export default class Action extends OsfModel {
+    // Override these in subclasses for better type safety
+    @attr('string') actionTrigger!: string;
+    @attr('string') fromState!: string;
+    @attr('string') toState!: string;
+
+    @attr('fixstring') comment!: string;
+    @attr('date') dateCreated!: Date;
+    @attr('date') dateModified!: Date;
+    @attr('boolean') visible!: boolean;
+    @attr('boolean') auto!: boolean;
+
+    @belongsTo('user', { inverse: null })
+    creator!: AsyncBelongsTo<UserModel> & UserModel;
+}

app/models/collection-submission-action.ts

@@ -0,0 +1,66 @@
+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 CollectionSubmissionModel, { CollectionSubmissionReviewStates } from './collection-submission';
+import Action from './action';
+
+export enum CollectionSubmissionActionTrigger {
+    Submit = 'submit',
+    Resubmit = 'resubmit',
+    Accept = 'accept',
+    Reject = 'reject',
+    Remove = 'remove',
+}
+
+const TriggerToPastTenseTranslationKey: Record<CollectionSubmissionActionTrigger, string> = {
+    submit: 'collections.actions.triggerPastTense.submit',
+    resubmit: 'collections.actions.triggerPastTense.resubmit',
+    accept: 'collections.actions.triggerPastTense.accept',
+    reject: 'collections.actions.triggerPastTense.reject',
+    remove: 'collections.actions.triggerPastTense.remove',
+};
+
+type ModeratorActionTriggers =
+    CollectionSubmissionActionTrigger.Accept |
+    CollectionSubmissionActionTrigger.Reject |
+    CollectionSubmissionActionTrigger.Remove;
+
+export const CollectionSubmissionActionTriggerToLabelMapKey: Record<ModeratorActionTriggers, string> = {
+    [CollectionSubmissionActionTrigger.Accept]: 'osf-components.makeDecisionDropdown.acceptCollectionSubmission',
+    [CollectionSubmissionActionTrigger.Reject]: 'osf-components.makeDecisionDropdown.rejectCollectionSubmission',
+    [CollectionSubmissionActionTrigger.Remove]:
+        'osf-components.makeDecisionDropdown.removeCollectionSubmission',
+};
+export const CollectionSubmissionActionTriggerToDescriptionKey: Record<ModeratorActionTriggers, string> = {
+    [CollectionSubmissionActionTrigger.Accept]:
+        'osf-components.makeDecisionDropdown.acceptCollectionSubmissionDescription',
+    [CollectionSubmissionActionTrigger.Reject]:
+        'osf-components.makeDecisionDropdown.rejectCollectionSubmissionDescription',
+    [CollectionSubmissionActionTrigger.Remove]:
+        'osf-components.makeDecisionDropdown.removeCollectionSubmissionDescription',
+};
+
+export default class CollectionSubmissionAction extends Action{
+    @service intl!: Intl;
+
+    @attr('string') actionTrigger!: CollectionSubmissionActionTrigger;
+    @attr('string') fromState!: CollectionSubmissionReviewStates;
+    @attr('string') toState!: CollectionSubmissionReviewStates;
+
+    @belongsTo('collection-submission', { inverse: 'collectionSubmissionActions' })
+    target!: AsyncBelongsTo<CollectionSubmissionModel> & CollectionSubmissionModel;
+
+    @computed('actionTrigger')
+    get triggerPastTense(): string {
+        const translationKey = TriggerToPastTenseTranslationKey[this.actionTrigger];
+        return translationKey ? this.intl.t(translationKey) : '';
+    }
+}
+
+declare module 'ember-data/types/registries/model' {
+    export default interface ModelRegistry {
+        'collection-submission-action': CollectionSubmissionAction;
+    }
+}

app/models/collected-metadatum.ts renamed to app/models/collection-submission.ts

@@ -1,11 +1,14 @@
-import { belongsTo, attr } from '@ember-data/model';
+import { belongsTo, hasMany, AsyncHasMany, attr } from '@ember-data/model';
 import { computed } from '@ember/object';
 import { alias as iAlias } from '@ember/object/computed';
 import { buildValidations, validator } from 'ember-cp-validations';
 
 import tuple from 'ember-osf-web/utils/tuple';
 
 import Collection, { ChoicesFields } from './collection';
+import CollectionSubmissionAction, {
+    CollectionSubmissionActionTrigger,
+} from './collection-submission-action';
 import Node from './node';
 import OsfModel from './osf-model';
 import User from './user';
@@ -20,6 +23,31 @@ export const choiceFields = tuple(
     'schoolType',
 );
 
+export enum CollectionSubmissionReviewStates {
+    Accepted = 'accepted',
+    InProgress = 'in_progress',
+    Pending = 'pending',
+    Removed = 'removed',
+    Rejected = 'rejected',
+}
+
+export const SubmissionIconMap = {
+    [CollectionSubmissionReviewStates.Pending]: 'clock',
+    [CollectionSubmissionReviewStates.Accepted]: 'check',
+    [CollectionSubmissionReviewStates.Removed]: 'trash',
+    [CollectionSubmissionReviewStates.Rejected]: 'times',
+    [CollectionSubmissionReviewStates.InProgress]: 'times',
+};
+
+export type ActionableCollectionSubmissionStates =
+    CollectionSubmissionReviewStates.Accepted | CollectionSubmissionReviewStates.Pending;
+
+export const collectionSubmissionStateToDecisionMap = {
+    [CollectionSubmissionReviewStates.Accepted]: [CollectionSubmissionActionTrigger.Remove],
+    [CollectionSubmissionReviewStates.Pending]:
+        [CollectionSubmissionActionTrigger.Accept, CollectionSubmissionActionTrigger.Reject],
+};
+
 const Validations = buildValidations({
     ...choiceFields.reduce((acc, val) => {
         const disabled = computed('model.displayChoiceFields.[]', function(): boolean {
@@ -42,18 +70,21 @@ const Validations = buildValidations({
     }, {}),
 });
 
-export default class CollectedMetadatumModel extends OsfModel.extend(Validations) {
+export default class CollectionSubmissionModel extends OsfModel.extend(Validations) {
     @attr('string') collectedType?: string;
     @attr('string') issue?: string;
     @attr('string') programArea?: string;
     @attr('string') status?: string;
     @attr('string') volume?: string;
+    @attr('string') reviewsState?: CollectionSubmissionReviewStates;
     @attr('string') studyDesign?: string; // custom field for Character Lab
     @attr('string') schoolType?: string; // custom field for Character Lab
 
     @belongsTo('collection') collection!: Collection;
     @belongsTo('node') guid!: Node;
     @belongsTo('user') creator!: User;
+    @hasMany('collection-submission-action')
+    collectionSubmissionActions!: AsyncHasMany<CollectionSubmissionAction> | CollectionSubmissionAction[];
 
     @computed('collection.displayChoicesFields.[]')
     get displayChoiceFields() {
@@ -69,6 +100,6 @@ export default class CollectedMetadatumModel extends OsfModel.extend(Validations
 
 declare module 'ember-data/types/registries/model' {
     export default interface ModelRegistry {
-        'collected-metadatum': CollectedMetadatumModel;
+        'collection-submission': CollectionSubmissionModel;
     } // eslint-disable-line semi
 }