Manage Dataset Templates Integration

CHANGELOG.md

@@ -9,6 +9,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 ### Added
 
 - Added the value entered by the user in the error messages for metadata field validation errors in EMAIL and URL type fields. For example, instead of showing “Point of Contact E-mail is not a valid email address.“, we now show “Point of Contact E-mail foo is not a valid email address.”
+- Dataset Templates UI integration, including create/edit flows, previews, and skeleton states.
 - Contact Owner button in File Page.
 - Share button in File Page.
 - Link Collection and Link Dataset features.

cypress.config.ts

@@ -47,7 +47,7 @@ export default defineConfig({
     ],
     defaultLanguage: 'en',
     codeCoverage: {
-      exclude: ['tests/**/*.*', '**/ErrorPage.tsx']
+      exclude: ['tests/**/*.*', '**/ErrorPage.tsx', '**/EditGuestBook.tsx']
     }
   }
 })

public/locales/en/collection.json

@@ -52,6 +52,7 @@
   "editCollection": {
     "edit": "Edit",
     "generalInfo": "General Information",
+    "datasetTemplates": "Dataset Templates",
     "deleteCollection": "Delete Collection"
   },
   "featuredItems": {

public/locales/en/datasetTemplates.json

@@ -0,0 +1,96 @@
+{
+  "pageTitle": "Dataset Templates",
+  "infoAlert": {
+    "title": "Manage Dataset Templates",
+    "text": "Create a template prefilled with metadata fields standard values, such as Author Affiliation, or add instructions in the metadata fields to give depositors more information on what metadata is expected."
+  },
+  "actions": {
+    "create": "Create Dataset Template",
+    "makeDefault": "Make Default",
+    "default": "Default",
+    "view": "View",
+    "copy": "Copy",
+    "edit": "Edit Template",
+    "delete": "Delete",
+    "deleteDisabledTip": "This template is already used by datasets and cannot be deleted."
+  },
+  "filters": {
+    "includeTemplatesFromRoot": "Include Templates from {{root}}"
+  },
+  "table": {
+    "name": "Template Name",
+    "created": "Date Created",
+    "usage": "Usage",
+    "action": "Action",
+    "templateCreatedAt": "Template created at {{alias}}"
+  },
+  "emptyState": {
+    "whyTitle": "Why Use Templates?",
+    "whyBullets": [
+      "Templates are useful when you have several datasets that have the same information in multiple metadata fields that you would prefer not to have to keep manually typing in.",
+      "Templates can be used to input instructions for those uploading datasets into your dataverse if you have a specific way you want a metadata field to be filled out."
+    ],
+    "howTitle": "How To Use Templates?",
+    "howBullets": [
+      "Templates are created at the dataverse level, can be deleted (so it does not show for future datasets), set to default (not required), and can be copied so you do not have to start over when creating a new template with similar metadata from another template. When a template is deleted, it does not impact the datasets that have used the template already."
+    ],
+    "howNote": "Please note that the ability to choose which metadata fields are hidden, required, or optional is done on the <anchor>General Information</anchor> page for this dataverse.",
+    "footer": "To get started, click on the Create Dataset Template button above. To learn more about templates, visit the <anchor>Dataset Templates</anchor> section of the User Guide."
+  },
+  "deleteModal": {
+    "title": "Delete Template",
+    "message": "Are you sure you want to delete this template? A new dataset will not be able to use this template."
+  },
+  "alerts": {
+    "deleteSuccess": "Template deleted.",
+    "deleteError": "Something went wrong deleting the template. Try again later.",
+    "copySuccess": "Template copied.",
+    "copyError": "Something went wrong copying the template. Try again later."
+  },
+  "copyNamePrefix": "copy {{name}}",
+  "preview": {
+    "title": "Dataset Template Preview",
+    "templateLabel": "Dataset Template",
+    "sections": {
+      "metadata": "Citation Metadata",
+      "terms": "Dataset Terms",
+      "access": "Restricted Files + Terms of Access"
+    },
+    "noMetadata": "No citation metadata is available for this template.",
+    "error": "Something went wrong loading the template preview. Please try again."
+  },
+  "createTemplate": {
+    "pageTitle": "Create Dataset Template",
+    "breadcrumb": "Create",
+    "templateName": "Template Name",
+    "requiredInfo": "Asterisks indicate metadata fields that users will be required to fill out while adding a dataset to this dataverse.",
+    "citationMissing": "Citation metadata is not available for this template.",
+    "saveAddTerms": "Save + Add Terms",
+    "cancel": "Cancel",
+    "alerts": {
+      "success": "Success! Template has been created."
+    },
+    "errors": {
+      "nameRequired": "Please add in a name for the dataset template.",
+      "saveFailed": "Something went wrong creating the template. Try again later."
+    },
+    "customInstructions": {
+      "label": "Custom Instructions:",
+      "none": "(None - click to add)",
+      "addAria": "Add custom instructions",
+      "editAria": "Edit custom instructions",
+      "inputAriaLabel": "Custom instructions",
+      "save": "Save",
+      "cancel": "Cancel"
+    },
+    "terms": {
+      "datasetTermsTitle": "Dataset Terms",
+      "licenseLabel": "License/Data Use Agreement",
+      "restrictedTitle": "Restricted Files + Terms of Access",
+      "requestAccessLabel": "Request Access",
+      "requestAccessHelp": "Enable access request",
+      "termsOfAccessLabel": "Terms of Access for Restricted Files",
+      "dataAccessPlaceLabel": "Data Access Place"
+    }
+  }
+}

public/locales/en/shared.json

@@ -7,6 +7,7 @@
   "files": "Files",
   "page": "Page",
   "asterisksIndicateRequiredFields": "Asterisks indicate required fields",
+  "asterisksRequiredDatasetFields": "Asterisks indicate metadata fields that users will be required to fill out while adding a dataset to this dataverse.",
   "remove": "Remove",
   "add": "Add",
   "yes": "Yes",

public/locales/es/collection.json

@@ -52,6 +52,7 @@
   "editCollection": {
     "edit": "Editar",
     "generalInfo": "Información general",
+    "datasetTemplates": "Plantillas de conjuntos de datos",
     "deleteCollection": "Eliminar colección"
   },
   "featuredItems": {

public/locales/es/datasetTemplates.json

@@ -0,0 +1,95 @@
+{
+  "pageTitle": "Plantillas de conjuntos de datos",
+  "infoAlert": {
+    "title": "Gestionar plantillas de conjuntos de datos",
+    "text": "Cree una plantilla precargada con valores estándar de campos de metadatos, como Afiliación del autor, o agregue instrucciones en los campos de metadatos para dar a los depositantes más información sobre qué metadatos se esperan."
+  },
+  "actions": {
+    "create": "Crear plantilla de conjunto de datos",
+    "makeDefault": "Hacer predeterminada",
+    "default": "Predeterminada",
+    "view": "Ver",
+    "copy": "Copiar",
+    "edit": "Editar plantilla",
+    "delete": "Eliminar"
+  },
+  "filters": {
+    "includeTemplatesFromRoot": "Incluir plantillas de {{root}}"
+  },
+  "table": {
+    "name": "Nombre de la plantilla",
+    "created": "Fecha de creación",
+    "usage": "Uso",
+    "action": "Acción",
+    "templateCreatedAt": "Plantilla creada en {{alias}}"
+  },
+  "emptyState": {
+    "whyTitle": "¿Por qué usar plantillas?",
+    "whyBullets": [
+      "Las plantillas son útiles cuando tienes varios conjuntos de datos que tienen la misma información en múltiples campos de metadatos y preferirías no tener que seguir escribiéndola manualmente.",
+      "Las plantillas se pueden usar para incluir instrucciones para quienes cargan conjuntos de datos en tu dataverse si tienes una forma específica en la que quieres que se complete un campo de metadatos."
+    ],
+    "howTitle": "Cómo usar plantillas",
+    "howBullets": [
+      "Las plantillas se crean a nivel de dataverse, se pueden eliminar (para que no aparezcan en futuros conjuntos de datos), establecer como predeterminadas (no obligatorias) y copiar para que no tengas que empezar de cero al crear una nueva plantilla con metadatos similares a otra. Cuando se elimina una plantilla, no afecta a los conjuntos de datos que ya la hayan usado."
+    ],
+    "howNote": "Ten en cuenta que la capacidad de elegir qué campos de metadatos están ocultos, son obligatorios u opcionales se configura en la página de <anchor>Información General</anchor> de este dataverse.",
+    "footer": "Para comenzar, haz clic en el botón Crear plantilla de conjunto de datos de arriba. Para obtener más información sobre las plantillas, visita la sección <anchor>Plantillas de conjuntos de datos</anchor> de la Guía del usuario."
+  },
+  "deleteModal": {
+    "title": "Eliminar plantilla",
+    "message": "¿Está seguro de que desea eliminar esta plantilla? Un nuevo conjunto de datos no podrá usar esta plantilla."
+  },
+  "alerts": {
+    "deleteSuccess": "Plantilla eliminada.",
+    "deleteError": "Algo salió mal al eliminar la plantilla. Inténtelo de nuevo más tarde.",
+    "copySuccess": "Plantilla copiada.",
+    "copyError": "Algo salió mal al copiar la plantilla. Inténtelo de nuevo más tarde."
+  },
+  "copyNamePrefix": "copia {{name}}",
+  "preview": {
+    "title": "Vista previa de plantilla de conjunto de datos",
+    "templateLabel": "Plantilla de conjunto de datos",
+    "sections": {
+      "metadata": "Metadatos de citación",
+      "terms": "Términos del conjunto de datos",
+      "access": "Archivos restringidos + términos de acceso"
+    },
+    "noMetadata": "No hay metadatos de citación disponibles para esta plantilla.",
+    "error": "No se pudo cargar la vista previa de la plantilla. Inténtelo de nuevo más tarde."
+  },
+  "createTemplate": {
+    "pageTitle": "Crear plantilla de conjunto de datos",
+    "breadcrumb": "Crear",
+    "templateName": "Nombre de la plantilla",
+    "requiredInfo": "Los asteriscos indican los campos de metadatos que los usuarios deberán completar al agregar un conjunto de datos a este dataverse.",
+    "citationMissing": "Los metadatos de citación no están disponibles para esta plantilla.",
+    "saveAddTerms": "Guardar + agregar términos",
+    "cancel": "Cancelar",
+    "alerts": {
+      "success": "¡Éxito! La plantilla ha sido creada."
+    },
+    "errors": {
+      "nameRequired": "Por favor, añade un nombre para la plantilla del conjunto de datos.",
+      "saveFailed": "Algo salió mal al crear la plantilla. Inténtelo de nuevo más tarde."
+    },
+    "customInstructions": {
+      "label": "Instrucciones personalizadas:",
+      "none": "(Ninguna: haz clic para añadir)",
+      "addAria": "Agregar instrucciones personalizadas",
+      "editAria": "Editar instrucciones personalizadas",
+      "inputAriaLabel": "Instrucciones personalizadas",
+      "save": "Guardar",
+      "cancel": "Cancelar"
+    },
+    "terms": {
+      "datasetTermsTitle": "Términos del conjunto de datos",
+      "licenseLabel": "Licencia/Acuerdo de uso de datos",
+      "restrictedTitle": "Archivos restringidos + términos de acceso",
+      "requestAccessLabel": "Solicitar acceso",
+      "requestAccessHelp": "Habilitar solicitud de acceso",
+      "termsOfAccessLabel": "Términos de acceso para archivos restringidos",
+      "dataAccessPlaceLabel": "Lugar de acceso a los datos"
+    }
+  }
+}

public/locales/es/shared.json

@@ -7,6 +7,7 @@
   "files": "Ficheros",
   "page": "Página",
   "asterisksIndicateRequiredFields": "Los asteriscos indican los campos obligatorios",
+  "asterisksRequiredDatasetFields": "Los asteriscos indican los campos de metadatos que los usuarios deberán completar al agregar un conjunto de datos a este dataverse.",
   "remove": "Eliminar",
   "add": "Agregar",
   "yes": "Sí",

src/dataset/domain/useCases/DTOs/DatasetDTO.ts

@@ -10,9 +10,9 @@ export interface DatasetMetadataBlockValuesDTO {
   fields: DatasetMetadataFieldsDTO
 }
 
-type DatasetMetadataFieldsDTO = Record<string, DatasetMetadataFieldValueDTO>
+export type DatasetMetadataFieldsDTO = Record<string, DatasetMetadataFieldValueDTO>
 
-type DatasetMetadataFieldValueDTO =
+export type DatasetMetadataFieldValueDTO =
   | string
   | string[]
   | DatasetMetadataChildFieldValueDTO

src/dataset/domain/useCases/updateDatasetLicense.ts

@@ -6,9 +6,5 @@ export function updateDatasetLicense(
   datasetId: string | number,
   licenseUpdateRequest: DatasetLicenseUpdateRequest
 ): Promise<void> {
-  return datasetRepository
-    .updateDatasetLicense(datasetId, licenseUpdateRequest)
-    .catch((error: Error) => {
-      throw new Error(error.message)
-    })
+  return datasetRepository.updateDatasetLicense(datasetId, licenseUpdateRequest)
 }

src/dataset/domain/useCases/updateTermsOfAccess.ts

@@ -6,7 +6,5 @@ export function updateTermsOfAccess(
   datasetId: string | number,
   termsOfAccess: TermsOfAccess
 ): Promise<void> {
-  return datasetRepository.updateTermsOfAccess(datasetId, termsOfAccess).catch((error: Error) => {
-    throw new Error(error.message)
-  })
+  return datasetRepository.updateTermsOfAccess(datasetId, termsOfAccess)
 }

src/router/routes.tsx

@@ -93,6 +93,28 @@ const EditFeaturedItems = lazy(() =>
   )
 )
 
+const DatasetTemplatesPage = lazy(() =>
+  import('../sections/templates/DatasetTemplatesFactory').then(({ DatasetTemplatesFactory }) => ({
+    default: () => DatasetTemplatesFactory.create()
+  }))
+)
+
+const CreateTemplatePage = lazy(() =>
+  import('../sections/templates/create-template/CreateTemplateFactory').then(
+    ({ CreateTemplateFactory }) => ({
+      default: () => CreateTemplateFactory.create()
+    })
+  )
+)
+
+const EditDatasetTemplateTermsPage = lazy(() =>
+  import('../sections/templates/edit-template-terms/EditTemplateTermsFactory').then(
+    ({ EditTemplateTermsFactory }) => ({
+      default: () => EditTemplateTermsFactory.create()
+    })
+  )
+)
+
 const ReplaceFile = lazy(() =>
   import('../sections/replace-file/ReplaceFileFactory').then(({ ReplaceFileFactory }) => ({
     default: () => ReplaceFileFactory.create()
@@ -292,6 +314,33 @@ export const routes: RouteObject[] = [
                 ),
                 errorElement: <ErrorPage />
               },
+              {
+                path: Route.COLLECTION_TEMPLATES,
+                element: (
+                  <Suspense fallback={<AppLoader />}>
+                    <DatasetTemplatesPage />
+                  </Suspense>
+                ),
+                errorElement: <ErrorPage />
+              },
+              {
+                path: Route.TEMPLATES_CREATE,
+                element: (
+                  <Suspense fallback={<AppLoader />}>
+                    <CreateTemplatePage />
+                  </Suspense>
+                ),
+                errorElement: <ErrorPage />
+              },
+              {
+                path: Route.TEMPLATES_EDIT_TERMS,
+                element: (
+                  <Suspense fallback={<AppLoader />}>
+                    <EditDatasetTemplateTermsPage />
+                  </Suspense>
+                ),
+                errorElement: <ErrorPage />
+              },
               {
                 path: Route.EDIT_FILE_METADATA,
                 element: (

src/sections/Route.enum.ts

@@ -20,6 +20,10 @@ export enum Route {
   ACCOUNT = '/account',
   EDIT_COLLECTION = '/collections/:collectionId/edit',
   EDIT_FEATURED_ITEMS = '/collections/:collectionId/edit-featured-items',
+  COLLECTION_TEMPLATES = '/:collectionId/templates',
+  TEMPLATES_CREATE = '/:collectionId/templates/create',
+  TEMPLATES_EDIT_METADATA = '/:collectionId/templates/:templateId/edit/metadata',
+  TEMPLATES_EDIT_TERMS = '/:collectionId/templates/:templateId/edit/terms',
   FEATURED_ITEM = '/featured-item/:parentCollectionId/:featuredItemId',
   NOT_FOUND_PAGE = '/404',
   AUTH_CALLBACK = '/auth-callback',
@@ -34,6 +38,12 @@ export const RouteWithParams = {
   CREATE_DATASET: (collectionId: string) => `/datasets/${collectionId}/create`,
   EDIT_COLLECTION: (collectionId: string) => `/collections/${collectionId}/edit`,
   EDIT_FEATURED_ITEMS: (collectionId: string) => `/collections/${collectionId}/edit-featured-items`,
+  COLLECTION_TEMPLATES: (collectionId: string) => `/${collectionId}/templates`,
+  TEMPLATES_CREATE: (collectionId: string) => `/${collectionId}/templates/create`,
+  TEMPLATES_EDIT_METADATA: (collectionId: string, templateId: number | string) =>
+    `/${collectionId}/templates/${templateId}/edit/metadata`,
+  TEMPLATES_EDIT_TERMS: (collectionId: string, templateId: number | string) =>
+    `/${collectionId}/templates/${templateId}/edit/terms`,
   EDIT_FILE_METADATA: (
     datasetPersistentId: string,
     datasetVersion: string,

src/sections/collection/edit-collection-dropdown/EditCollectionDropdown.tsx

@@ -60,6 +60,9 @@ export const EditCollectionDropdown = ({
       <DropdownButtonItem as={Link} to={RouteWithParams.EDIT_FEATURED_ITEMS(collection.id)}>
         {t('featuredItems.title')}
       </DropdownButtonItem>
+      <DropdownButtonItem as={Link} to={RouteWithParams.COLLECTION_TEMPLATES(collection.id)}>
+        {t('editCollection.datasetTemplates')}
+      </DropdownButtonItem>
 
       {canCollectionBeDeleted && (
         <>

src/sections/create-dataset/CreateDataset.tsx

@@ -15,7 +15,7 @@ import { BreadcrumbsGenerator } from '../shared/hierarchy/BreadcrumbsGenerator'
 import { useCollection } from '../collection/useCollection'
 import { NotFoundPage } from '../not-found-page/NotFoundPage'
 import { CreateDatasetSkeleton } from './CreateDatasetSkeleton'
-import { useGetTemplatesByCollectionId } from '@/dataset/domain/hooks/useGetTemplatesByCollectionId'
+import { useGetTemplatesByCollectionId } from '@/templates/domain/hooks/useGetTemplatesByCollectionId'
 import { type Template } from '@/templates/domain/models/Template'
 import { DatasetTemplateSelect } from './dataset-template-select/DatasetTemplateSelect'
 import { TemplateRepository } from '@/templates/domain/repositories/TemplateRepository'