Merge pull request #549 from IQSS/feat/545-edit-collection-page

Edit Collection page

package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-alpha.4",
+    "@iqss/dataverse-client-javascript": "2.0.0-alpha.6",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

packages/design-system/src/lib/components/dropdown-button/dropdown-header/DropdownHeader.tsx

@@ -1,6 +1,10 @@
-import { PropsWithChildren } from 'react'
 import { Dropdown } from 'react-bootstrap'
 
-export function DropdownHeader({ children }: PropsWithChildren) {
-  return <Dropdown.Header>{children}</Dropdown.Header>
+interface DropdownHeaderProps {
+  className?: string
+  children: React.ReactNode
+}
+
+export function DropdownHeader({ className, children }: DropdownHeaderProps) {
+  return <Dropdown.Header className={className}>{children}</Dropdown.Header>
 }

public/locales/en/collection.json

@@ -30,5 +30,10 @@
     "question": "Are you sure you want to publish your collection? Once you do so it must remain published.",
     "error": "There was an error publishing your collection."
   },
-  "publishedAlert": "Your collection is now public."
+  "publishedAlert": "Your collection is now public.",
+  "editedAlert": "You have successfully updated your collection!",
+  "editCollection": {
+    "edit": "Edit",
+    "generalInfo": "General Information"
+  }
 }

public/locales/en/createCollection.json

@@ -1,83 +1,4 @@
 {
   "pageTitle": "Create Collection",
-  "fields": {
-    "hostCollection": {
-      "label": "Host Collection",
-      "description": "The collection which contains this data.",
-      "required": "Host Collection is required"
-    },
-    "name": {
-      "label": "Collection Name",
-      "description": "The project, department, university, professor, or journal this collection will contain data for.",
-      "required": "Collection Name is required"
-    },
-    "affiliation": {
-      "label": "Affiliation",
-      "description": "The organization with which this collection is affiliated."
-    },
-    "alias": {
-      "label": "Identifier",
-      "description": "Short name used for the URL of this collection.",
-      "required": "Identifier is required",
-      "invalid": {
-        "format": "Identifier is not valid. Valid characters are a-Z, 0-9, '_', and '-'.",
-        "maxLength": "Identifier must be at most {{maxLength}} characters."
-      },
-      "suggestion": "Psst... try this"
-    },
-    "storage": {
-      "label": "Storage",
-      "description": "A storage service to be used for datasets in this collection."
-    },
-    "type": {
-      "label": "Category",
-      "description": "The type that most closely reflects this collection.",
-      "required": "Category is required"
-    },
-    "description": {
-      "label": "Description",
-      "description": "A summary describing the purpose, nature or scope of this collection.",
-      "subLabel": "This field supports only certain <htmlTooltip>HTML tags</htmlTooltip>.",
-      "htmlAllowedTags": "<a>, <b>, <blockquote>, <br>, <code>, <del>, <dd>, <dl>, <dt>, <em>, <hr>, <h1>-<h3>, <i>, <img>, <kbd>, <li>, <ol>, <p>, <pre>, <s>, <sup>, <sub>, <strong>, <strike>, <u>, <ul>"
-    },
-    "contacts": {
-      "label": "Email",
-      "description": "The email address(es) of the contact(s) for the collection.",
-      "required": "Email is required",
-      "invalid": "Email is not a valid email"
-    },
-    "metadataFields": {
-      "sectionLabel": "Metadata Fields",
-      "helperText": "Choose the metadata fields to use in dataset templates and when adding a dataset to this collection.",
-      "useMetadataFieldsFrom": "Use metadata fields from",
-      "inputLevelsTable": {
-        "hideTableAriaLabel": "Hide input levels table",
-        "requiredByDataverse": "Required by Dataverse",
-        "hidden": "Hidden",
-        "optional": "Optional",
-        "required": "Required",
-        "conditionallyRequired": "Conditionally Required"
-      }
-    },
-    "browseSearchFacets": {
-      "label": "Browse/Search Facets",
-      "helperText": "Choose and order the metadata fields to use as facets when browsing this collection.",
-      "useBrowseSearchFacetsFrom": "Use browse/search facets from",
-      "selectedFacets": "Selected"
-    }
-  },
-  "confirmResetModal": {
-    "title": "Reset Modifications",
-    "warning": "Are you sure you want to reset the selected metadata fields? If you do this, any customizations (hidden, required, optional) you have done will no longer appear.",
-    "continue": "Continue",
-    "cancel": "Cancel"
-  },
-  "submitStatus": {
-    "success": "Collection created successfully."
-  },
-  "formButtons": {
-    "save": "Create Collection",
-    "cancel": "Cancel"
-  },
   "notAllowedToCreateCollection": "You do not have permissions to create a collection within this collection."
 }

public/locales/en/editCollection.json

@@ -0,0 +1,8 @@
+{
+  "pageTitle": "Edit Collection",
+  "notAllowedToEditCollection": "You do not have permissions to edit this collection.",
+  "infoAlert": {
+    "heading": "Edit Collection",
+    "text": "Edit your collection and click Save Changes. Asterisks indicate required fields."
+  }
+}

public/locales/en/shared.json

@@ -61,5 +61,91 @@
       "editMode": "Save Changes"
     },
     "cancelButton": "Cancel"
+  },
+  "collectionForm": {
+    "fields": {
+      "hostCollection": {
+        "label": "Host Collection",
+        "description": "The collection which contains this data.",
+        "required": "Host Collection is required"
+      },
+      "name": {
+        "label": "Collection Name",
+        "description": "The project, department, university, professor, or journal this collection will contain data for.",
+        "required": "Collection Name is required"
+      },
+      "affiliation": {
+        "label": "Affiliation",
+        "description": "The organization with which this collection is affiliated."
+      },
+      "alias": {
+        "label": "Identifier",
+        "description": "Short name used for the URL of this collection.",
+        "required": "Identifier is required",
+        "invalid": {
+          "format": "Identifier is not valid. Valid characters are a-Z, 0-9, '_', and '-'.",
+          "maxLength": "Identifier must be at most {{maxLength}} characters."
+        },
+        "suggestion": "Psst... try this"
+      },
+      "storage": {
+        "label": "Storage",
+        "description": "A storage service to be used for datasets in this collection."
+      },
+      "type": {
+        "label": "Category",
+        "description": "The type that most closely reflects this collection.",
+        "required": "Category is required"
+      },
+      "description": {
+        "label": "Description",
+        "description": "A summary describing the purpose, nature or scope of this collection.",
+        "subLabel": "This field supports only certain <htmlTooltip>HTML tags</htmlTooltip>.",
+        "htmlAllowedTags": "<a>, <b>, <blockquote>, <br>, <code>, <del>, <dd>, <dl>, <dt>, <em>, <hr>, <h1>-<h3>, <i>, <img>, <kbd>, <li>, <ol>, <p>, <pre>, <s>, <sup>, <sub>, <strong>, <strike>, <u>, <ul>"
+      },
+      "contacts": {
+        "label": "Email",
+        "description": "The email address(es) of the contact(s) for the collection.",
+        "required": "Email is required",
+        "invalid": "Email is not a valid email"
+      },
+      "metadataFields": {
+        "sectionLabel": "Metadata Fields",
+        "helperText": "Choose the metadata fields to use in dataset templates and when adding a dataset to this collection.",
+        "useMetadataFieldsFrom": "Use metadata fields from",
+        "inputLevelsTable": {
+          "hideTableAriaLabel": "Hide input levels table",
+          "requiredByDataverse": "Required by Dataverse",
+          "hidden": "Hidden",
+          "optional": "Optional",
+          "required": "Required",
+          "conditionallyRequired": "Conditionally Required"
+        }
+      },
+      "browseSearchFacets": {
+        "label": "Browse/Search Facets",
+        "helperText": "Choose and order the metadata fields to use as facets when browsing this collection.",
+        "useBrowseSearchFacetsFrom": "Use browse/search facets from",
+        "selectedFacets": "Selected",
+        "invalid": {
+          "minLength": "At least one facet must be selected."
+        }
+      }
+    },
+    "confirmResetModal": {
+      "title": "Reset Modifications",
+      "warning": "Are you sure you want to reset the selected metadata fields? If you do this, any customizations (hidden, required, optional) you have done will no longer appear.",
+      "continue": "Continue",
+      "cancel": "Cancel"
+    },
+    "submitStatus": {
+      "createSuccess": "Collection created successfully.",
+      "editSuccess": "Collection updated successfully."
+    },
+    "saveButton": {
+      "createMode": "Create Collection",
+      "editMode": "Save Changes"
+    },
+    "cancelButton": "Cancel"
   }
 }

src/collection/domain/models/Collection.ts

@@ -1,4 +1,7 @@
 import { UpwardHierarchyNode } from '../../../shared/hierarchy/domain/models/UpwardHierarchyNode'
+import { CollectionContact } from './CollectionContact'
+import { CollectionType } from './CollectionType'
+import { CollectionInputLevel } from './CollectionInputLevel'
 
 export interface Collection {
   id: string
@@ -8,10 +11,8 @@ export interface Collection {
   description?: string
   affiliation?: string
   inputLevels?: CollectionInputLevel[]
-}
-
-export interface CollectionInputLevel {
-  datasetFieldName: string
-  include: boolean
-  required: boolean
+  type: CollectionType
+  contacts: CollectionContact[]
+  isMetadataBlockRoot: boolean
+  isFacetRoot: boolean
 }

src/collection/domain/models/CollectionContact.ts

@@ -0,0 +1,4 @@
+export interface CollectionContact {
+  email: string
+  displayOrder: number
+}

src/collection/domain/models/CollectionInputLevel.ts

@@ -0,0 +1,5 @@
+export interface CollectionInputLevel {
+  datasetFieldName: string
+  include: boolean
+  required: boolean
+}

src/collection/domain/models/CollectionType.ts

@@ -0,0 +1,11 @@
+export enum CollectionType {
+  RESEARCHERS = 'RESEARCHERS',
+  RESEARCH_PROJECTS = 'RESEARCH_PROJECTS',
+  JOURNALS = 'JOURNALS',
+  ORGANIZATIONS_INSTITUTIONS = 'ORGANIZATIONS_INSTITUTIONS',
+  TEACHING_COURSES = 'TEACHING_COURSES',
+  UNCATEGORIZED = 'UNCATEGORIZED',
+  LABORATORY = 'LABORATORY',
+  RESEARCH_GROUP = 'RESEARCH_GROUP',
+  DEPARTMENT = 'DEPARTMENT'
+}

src/collection/domain/repositories/CollectionRepository.ts

@@ -17,4 +17,5 @@ export interface CollectionRepository {
     paginationInfo: CollectionItemsPaginationInfo,
     searchCriteria?: CollectionSearchCriteria
   ): Promise<CollectionItemSubset>
+  edit(collectionIdOrAlias: string, updatedCollection: CollectionDTO): Promise<void>
 }

src/collection/domain/useCases/DTOs/CollectionDTO.ts

@@ -1,3 +1,5 @@
+import { CollectionType } from '../../models/CollectionType'
+
 export interface CollectionDTO {
   alias: string
   name: string
@@ -10,18 +12,6 @@ export interface CollectionDTO {
   inputLevels?: CollectionInputLevelDTO[]
 }
 
-export enum CollectionType {
-  RESEARCHERS = 'RESEARCHERS',
-  RESEARCH_PROJECTS = 'RESEARCH_PROJECTS',
-  JOURNALS = 'JOURNALS',
-  ORGANIZATIONS_INSTITUTIONS = 'ORGANIZATIONS_INSTITUTIONS',
-  TEACHING_COURSES = 'TEACHING_COURSES',
-  UNCATEGORIZED = 'UNCATEGORIZED',
-  LABORATORY = 'LABORATORY',
-  RESEARCH_GROUP = 'RESEARCH_GROUP',
-  DEPARTMENT = 'DEPARTMENT'
-}
-
 export interface CollectionInputLevelDTO {
   datasetFieldName: string
   include: boolean

src/collection/domain/useCases/editCollection.ts

@@ -0,0 +1,13 @@
+import { WriteError } from '@iqss/dataverse-client-javascript'
+import { CollectionRepository } from '../repositories/CollectionRepository'
+import { CollectionDTO } from './DTOs/CollectionDTO'
+
+export async function editCollection(
+  collectionRepository: CollectionRepository,
+  updatedCollection: CollectionDTO,
+  collectionId: string
+): Promise<void> {
+  return collectionRepository.edit(collectionId, updatedCollection).catch((error: WriteError) => {
+    throw error
+  })
+}

src/collection/infrastructure/mappers/JSCollectionMapper.ts

@@ -22,7 +22,11 @@ export class JSCollectionMapper {
         jsCollection.alias,
         jsCollection.isPartOf
       ),
-      inputLevels: jsCollection.inputLevels
+      inputLevels: jsCollection.inputLevels,
+      type: jsCollection.type,
+      contacts: jsCollection.contacts ?? [],
+      isMetadataBlockRoot: jsCollection.isMetadataBlockRoot,
+      isFacetRoot: jsCollection.isFacetRoot
     }
   }
 

src/collection/infrastructure/repositories/CollectionJSDataverseRepository.ts

@@ -6,7 +6,8 @@ import {
   getCollectionFacets,
   getCollectionUserPermissions,
   getCollectionItems,
-  publishCollection
+  publishCollection,
+  updateCollection
 } from '@iqss/dataverse-client-javascript'
 import { JSCollectionMapper } from '../mappers/JSCollectionMapper'
 import { CollectionDTO } from '../../domain/useCases/DTOs/CollectionDTO'
@@ -61,4 +62,8 @@ export class CollectionJSDataverseRepository implements CollectionRepository {
   publish(collectionIdOrAlias: number | string): Promise<void> {
     return publishCollection.execute(collectionIdOrAlias)
   }
+
+  edit(collectionIdOrAlias: string, updatedCollection: CollectionDTO): Promise<void> {
+    return updateCollection.execute(collectionIdOrAlias, updatedCollection)
+  }
 }

src/files/domain/models/FilePreview.ts

@@ -15,7 +15,7 @@ export interface FilePreview {
   ingest: FileIngest
   metadata: FileMetadata
   permissions: FilePermissions
-  datasetVersionNumber?: DatasetVersionNumber
+  datasetVersionNumber: DatasetVersionNumber
   releaseOrCreateDate?: Date
   someDatasetVersionHasBeenReleased?: boolean
   datasetPersistentId?: string