View guestbook and download file with guestbook

CHANGELOG.md

@@ -17,6 +17,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Added Notifications tab in Account Page
 - Added runtime configuration options for homepage branding and support link.
 - Added an environment variable to docker-compose-dev.yml to hide the OIDC client used in the SPA from the JSF frontend: DATAVERSE_AUTH_OIDC_HIDDEN_JSF: 1
+- Download with terms of use and guestbook.
 
 ### Changed
 

dev-env/docker-compose-dev.yml

@@ -72,8 +72,8 @@ services:
         -Ddataverse.files.s3.connection-pool-size=2048
         -Ddataverse.files.s3.custom-endpoint-region=us-east-1
         -Ddataverse.files.s3.custom-endpoint-url=https://s3.us-east-1.amazonaws.com
-    # We publish the port on the host machine instead of just exposing it within the network, so that the browser can access the URLs of images generated by Dataverse (http://localhost:8080...). 
-    # This is necessary because the dev_nginx proxy is placed on top of the Dataverse service, making those URLs unreachable unless this port is exposed. 
+    # We publish the port on the host machine instead of just exposing it within the network, so that the browser can access the URLs of images generated by Dataverse (http://localhost:8080...).
+    # This is necessary because the dev_nginx proxy is placed on top of the Dataverse service, making those URLs unreachable unless this port is exposed.
     # This workaround is only necessary and intended for the local dev environment and will not be used in the remote environment, where we use a production DNS.
     ports:
       - '8080:8080'
@@ -214,7 +214,7 @@ services:
       - DATAVERSE_DB_PORT=5432
       - DATAVERSE_DB_USER=${DATAVERSE_DB_USER}
       - DATAVERSE_DB_PASSWORD=secret
-      - DATAVERSE_BASE_URL=http://dataverse:8080
+      - DATAVERSE_BASE_URL=http://localhost:8000
     networks:
       dataverse:
         aliases:

dev-env/nginx.conf

@@ -9,6 +9,11 @@ http {
     # Default route for other URLs
     location / {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Keycloak reverse proxy for /realms
@@ -23,31 +28,61 @@ http {
     # Specific route for /resources/images
     location /resources/images {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/css
     location /resources/css {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/js
     location /resources/js {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/dev
     location /resources/dev {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/fontcustom
     location /resources/fontcustom {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/iqbs
     location /resources/iqbs {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # General route for other /resources routes, handled by Keycloak

dev-env/shib-dev-env/docker-compose-dev.yml

@@ -208,7 +208,7 @@ services:
       - DATAVERSE_DB_PORT=5432
       - DATAVERSE_DB_USER=${DATAVERSE_DB_USER}
       - DATAVERSE_DB_PASSWORD=secret
-      - DATAVERSE_BASE_URL=http://dataverse:8080
+      - DATAVERSE_BASE_URL=https://localhost
     networks:
       dataverse:
         aliases:

dev-env/shib-dev-env/nginx/nginx.conf

@@ -12,6 +12,11 @@ http {
     # Default route for other URLs
     location / {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Keycloak reverse proxy for /realms
@@ -26,31 +31,61 @@ http {
     # Specific route for /resources/images
     location /resources/images {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/css
     location /resources/css {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/js
     location /resources/js {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/dev
     location /resources/dev {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/fontcustom
     location /resources/fontcustom {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # Specific route for /resources/iqbs
     location /resources/iqbs {
       proxy_pass http://dataverse:8080;
+      proxy_set_header    Host               $http_host;
+      proxy_set_header    X-Forwarded-For    $proxy_add_x_forwarded_for;
+      proxy_set_header    X-Forwarded-Proto  $scheme;
+      proxy_set_header    X-Forwarded-Host   $http_host;
+      proxy_set_header    X-Forwarded-Port   $server_port;
     }
 
     # General route for other /resources routes, handled by Keycloak

package.json

@@ -18,7 +18,7 @@
     "@dnd-kit/sortable": "8.0.0",
     "@dnd-kit/utilities": "3.2.2",
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.1.0-alpha.1",
+    "@iqss/dataverse-client-javascript": "2.1.0-pr438.62748a8",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

packages/design-system/src/lib/index.ts

@@ -12,6 +12,7 @@ export { NavbarDropdown } from './components/navbar/navbar-dropdown/NavbarDropdo
 export { ThemeProvider, useTheme } from './components/theme/ThemeProvider'
 export { Breadcrumb } from './components/breadcrumb/Breadcrumb'
 export { Alert } from './components/alert/Alert'
+export type { AlertVariant } from './components/alert/AlertVariant'
 export { Tabs } from './components/tabs/Tabs'
 export { Accordion } from './components/accordion/Accordion'
 export { ButtonGroup } from './components/button-group/ButtonGroup'

packages/design-system/tsconfig.json

@@ -11,11 +11,11 @@
     "forceConsistentCasingInFileNames": true,
     "noFallthroughCasesInSwitch": true,
     "module": "esnext",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,
-    "jsx": "react-jsx"
+    "jsx": "react-jsx"   
   },
   "include": ["src", "tests", "vite.config.ts", "cypress.config.ts", ".storybook/test-runner.ts"],
   "exclude": ["tests/**/**.spec.ts", "tests/**/**.spec.tsx"]

public/locales/en/dataset.json

@@ -186,6 +186,11 @@
     "requestAccessTip": "If checked, users can request access to the restricted files in this dataset.",
     "requestAccessTrue": "Users may request access to files.",
     "requestAccessFalse": "Users may not request access to files.",
+    "guestbookTitle": "Guestbook",
+    "guestbookTip": "User information (i.e., name, email, institution, and position) will be collected when files are downloaded.",
+    "guestbookDescription": "The following guestbook will prompt a user to provide additional information when downloading a file.",
+    "noGuestbookAssigned": "No guestbook is assigned to this dataset so users will not be prompted to provide any information when downloading files. To learn more about guestbooks, visit the <anchor>Dataset Guestbook</anchor> section of the User Guide.",
+    "guestbookPreviewButton": "Preview Guestbook",
     "restrictedFilesTip": "The number of restricted files in this dataset.",
     "dataAccessPlaceTip": "If the data is not only in Dataverse, list the location(s) where the data are currently stored.",
     "originalArchiveTip": "Archive from which the data was obtained.",
@@ -350,7 +355,7 @@
     "tabs": {
       "datasetTerms": "Dataset Terms",
       "restrictedFilesTerms": "Restricted Files + Terms of Access",
-      "guestBook": "GuestBook"
+      "guestbook": "Guestbook"
     },
     "datasetTerms": {
       "title": "Dataset Terms",
@@ -364,10 +369,11 @@
       "title": "Restricted Files + Terms of Access",
       "description": "Set up access restrictions and terms for restricted files in this dataset."
     },
-    "guestBook": {
-      "title": "GuestBook",
-      "description": "Select a guestbook to have a user provide additional information when downloading a file.",
-      "testGuestbook": "Test Guestbook",
+    "guestbook": {
+      "title": "Guestbook",
+      "description": "Select a guestbook to have a user provide additional information when downloading a file. To learn more about guestbooks, visit the <anchor>Dataset Guestbook</anchor> section of the User Guide.",
+      "clearSelection": "Clear Selection",
+      "noGuestbooksEnabled": "There are no guestbooks enabled in {{collectionName}}. To create a guestbook, return to {{collectionName}}, click the \"Edit\" button and select the \"Dataset Guestbooks\" option.",
       "previewButton": "Preview Guestbook"
     },
     "unsavedChangesModal": {
@@ -376,6 +382,7 @@
       "stay": "Stay on this page",
       "leave": "Leave without saving"
     },
+    "defaultGuestbookUpdateError": "An error occurred while updating the dataset guestbook. Please try again.",
     "defaultLicenseUpdateError": "An error occurred while updating the dataset license. Please try again.",
     "defaultTermsOfAccessUpdateError": "An error occurred while updating the dataset terms of access. Please try again."
   }

public/locales/en/file.json

@@ -91,6 +91,18 @@
       "helpText": "Share this file on your favorite social media networks."
     }
   },
+  "actions": {
+    "optionsMenu": {
+      "guestbookCollectModal": {
+        "submitError": "Something went wrong submitting guestbook responses. Try again later.",
+        "downloadError": "Something went wrong downloading the file. Try again later.",
+        "validation": {
+          "required": "This field is required.",
+          "invalidEmail": "Please enter a valid email address."
+        }
+      }
+    }
+  },
   "deleteFileModal": {
     "title": "Delete File",
     "message": "The file will be deleted after you click on the Delete button.",

public/locales/en/files.json

@@ -80,6 +80,19 @@
       "title": "File Options",
       "headers": {
         "editOptions": "Edit Options"
+      },
+      "guestbookCollectModal": {
+        "title": "Dataset Guestbook",
+        "message": "A guestbook is assigned to this dataset. Users will be prompted to provide additional information when downloading files.",
+        "close": "Close",
+        "additionalQuestions": "Additional Questions",
+        "submitError": "Something went wrong submitting guestbook responses. Try again later.",
+        "downloadStarted": "Your download has started.",
+        "downloadError": "Something went wrong downloading the file. Try again later.",
+        "validation": {
+          "required": "This field is required.",
+          "invalidEmail": "Please enter a valid email address."
+        }
       }
     },
     "alreadyDeletedAlert": {

public/locales/en/guestbooks.json

@@ -0,0 +1,31 @@
+{
+  "title": "Dataset Guestbooks",
+  "errors": {
+    "getGuestbook": "Something went wrong getting the guestbook. Try again later."
+  },
+  "preview": {
+    "title": "Preview Guestbook",
+    "description": "Upon downloading files the guestbook asks for the following information.",
+    "guestbookNameLabel": "Guestbook Name",
+    "guestbookDataLabel": "Collected Data",
+    "guestbookDataTip": "User data collected by the guestbook.",
+    "accountInformation": "Account Information",
+    "customQuestionsLabel": "Custom Questions",
+    "required": "Required",
+    "optional": "Optional"
+  },
+  "create": {
+    "fields": {
+      "dataCollected": {
+        "label": "Data Collected",
+        "help": "Dataverse account information that will be collected when a user downloads a file. Check the ones that will be required.",
+        "options": {
+          "name": "Name",
+          "email": "Email",
+          "institution": "Institution",
+          "position": "Position"
+        }
+      }
+    }
+  }
+}