Add missing JSDoc.

Fix project/survey regular attachments error display (shows error in the list, not as a popup).

app/src/components/attachments/FileUploadWithMeta.tsx

@@ -6,6 +6,11 @@ import { FileUploadSingleItem } from 'components/file-upload/FileUploadSingleIte
 import { AttachmentTypeFileExtensions } from 'constants/attachments';
 import { useFormikContext } from 'formik';
 
+/**
+ * File upload with meta form. Used to upload a report with accompanying meta data.
+ *
+ * @return {*}
+ */
 export const FileUploadWithMeta = () => {
   const { handleSubmit, setFieldValue, setFieldError, values, errors } = useFormikContext<IReportMetaForm>();
 

app/src/components/dialog/attachments/FileUploadDialog.tsx

@@ -19,7 +19,9 @@ interface IFileUploadDialogProps extends IComponentDialogProps {
 }
 
 /**
+ * Wraps the standard `FileUpload` component in a dialog.
  *
+ * The wrapped `FileUpload` component allows for drag-and-drop file uploads of any number of files with any file type.
  *
  * @param {IFileUploadDialogProps} props
  * @return {*}

app/src/components/dialog/attachments/ReportFileUploadDialog.tsx

@@ -44,9 +44,7 @@ export interface IReportFileUploadDialogProps {
 }
 
 /**
- * A dialog to wrap any component(s) that need to be displayed as a modal.
- *
- * Any component(s) passed in `props.children` will be rendered as the content of the dialog.
+ * Wraps the `FileUploadWithMeta` component in a dialog.
  *
  * @param {*} props
  * @return {*}

app/src/features/projects/view/ProjectAttachments.tsx

@@ -8,7 +8,7 @@ import { FileUploadDialog } from 'components/dialog/attachments/FileUploadDialog
 import { ReportFileUploadDialog } from 'components/dialog/attachments/ReportFileUploadDialog';
 import { ProjectRoleGuard } from 'components/security/Guards';
 import { H2MenuToolbar } from 'components/toolbar/ActionToolbars';
-import { AttachmentsI18N, ReportI18N } from 'constants/i18n';
+import { ReportI18N } from 'constants/i18n';
 import { PROJECT_PERMISSION, SYSTEM_ROLE } from 'constants/roles';
 import { ProjectContext } from 'contexts/projectContext';
 import { APIError } from 'hooks/api/useAxios';
@@ -18,7 +18,7 @@ import { useContext, useEffect, useState } from 'react';
 import ProjectAttachmentsList from './ProjectAttachmentsList';
 
 /**
- * Project attachments content for a project.
+ * Project attachments component.
  *
  * @return {*}
  */
@@ -53,25 +53,7 @@ const ProjectAttachments = () => {
   };
 
   const handleUploadAttachments = async (file: File) => {
-    try {
-      await biohubApi.project.uploadProjectAttachments(projectContext.projectId, file);
-    } catch (error) {
-      const apiError = error as APIError;
-
-      dialogContext.setErrorDialog({
-        open: true,
-        dialogTitle: AttachmentsI18N.uploadErrorTitle,
-        dialogText: AttachmentsI18N.uploadErrorText,
-        dialogError: apiError.message,
-        dialogErrorDetails: apiError.errors,
-        onClose: () => {
-          dialogContext.setErrorDialog({ open: false });
-        },
-        onOk: () => {
-          dialogContext.setErrorDialog({ open: false });
-        }
-      });
-    }
+    return biohubApi.project.uploadProjectAttachments(projectContext.projectId, file);
   };
 
   useEffect(() => {

app/src/features/surveys/view/SurveyAttachments.tsx

@@ -8,7 +8,7 @@ import { FileUploadDialog } from 'components/dialog/attachments/FileUploadDialog
 import { ReportFileUploadDialog } from 'components/dialog/attachments/ReportFileUploadDialog';
 import { ProjectRoleGuard } from 'components/security/Guards';
 import { H2MenuToolbar } from 'components/toolbar/ActionToolbars';
-import { AttachmentsI18N, ReportI18N } from 'constants/i18n';
+import { ReportI18N } from 'constants/i18n';
 import { PROJECT_PERMISSION, SYSTEM_ROLE } from 'constants/roles';
 import { SurveyContext } from 'contexts/surveyContext';
 import { APIError } from 'hooks/api/useAxios';
@@ -17,6 +17,11 @@ import { useDialogContext } from 'hooks/useContext';
 import { useContext, useState } from 'react';
 import SurveyAttachmentsList from './SurveyAttachmentsList';
 
+/**
+ * Survey attachments component.
+ *
+ * @return {*}
+ */
 const SurveyAttachments = () => {
   const biohubApi = useBiohubApi();
 
@@ -50,25 +55,7 @@ const SurveyAttachments = () => {
   };
 
   const handleUploadAttachments = async (file: File) => {
-    try {
-      await biohubApi.survey.uploadSurveyAttachments(projectId, surveyId, file);
-    } catch (error) {
-      const apiError = error as APIError;
-
-      dialogContext.setErrorDialog({
-        open: true,
-        dialogTitle: AttachmentsI18N.uploadErrorTitle,
-        dialogText: AttachmentsI18N.uploadErrorText,
-        dialogError: apiError.message,
-        dialogErrorDetails: apiError.errors,
-        onClose: () => {
-          dialogContext.setErrorDialog({ open: false });
-        },
-        onOk: () => {
-          dialogContext.setErrorDialog({ open: false });
-        }
-      });
-    }
+    return biohubApi.survey.uploadSurveyAttachments(projectId, surveyId, file);
   };
 
   return (