From 91abe374f6e50fdf952f3c2dac4ccbafb64ee070 Mon Sep 17 00:00:00 2001
From: Daniel Cojocea <danielcojocea28@gmail.com>
Date: Thu, 11 Jul 2024 20:30:11 -0400
Subject: [PATCH] Added jsdocs and proptypes

---
 Client/src/Components/Alert/index.jsx | 13 +++++++++++++
 Client/src/Utils/toastUtils.jsx       | 18 ++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/Client/src/Components/Alert/index.jsx b/Client/src/Components/Alert/index.jsx
index 7cdc972a5..3fa0d82ab 100644
--- a/Client/src/Components/Alert/index.jsx
+++ b/Client/src/Components/Alert/index.jsx
@@ -24,6 +24,9 @@ const icons = {
  * @param {'info' | 'error' | 'warning'} props.variant - The type of alert.
  * @param {string} [props.title] - The title of the alert.
  * @param {string} [props.body] - The body text of the alert.
+ * @param {boolean} [props.isToast] - Indicates if the alert is used as a toast notification.
+ * @param {boolean} [props.hasIcon] - Whether to display an icon in the alert.
+ * @param {function} props.onClick - Toast dismiss function.
  * @returns {JSX.Element}
  */
 
@@ -105,6 +108,16 @@ Alert.propTypes = {
   variant: PropTypes.oneOf(["info", "error", "warning"]).isRequired,
   title: PropTypes.string,
   body: PropTypes.string,
+  isToast: PropTypes.bool,
+  hasIcon: PropTypes.bool,
+  onClick: function (props, propName, componentName) {
+    if (props.isToast && !props[propName]) {
+      return new Error(
+        `Prop '${propName}' is required when 'isToast' is true in '${componentName}'.`
+      );
+    }
+    return null;
+  },
 };
 
 export default Alert;
diff --git a/Client/src/Utils/toastUtils.jsx b/Client/src/Utils/toastUtils.jsx
index 7fb29ff6d..73c21c260 100644
--- a/Client/src/Utils/toastUtils.jsx
+++ b/Client/src/Utils/toastUtils.jsx
@@ -1,6 +1,16 @@
+import PropTypes from "prop-types";
 import { toast } from "react-toastify";
 import Alert from "../Components/Alert";
 
+/**
+ * @param {object} props
+ * @param {'info' | 'error' | 'warning'} - The variant of the alert (e.g., "info", "error").
+ * @param {string} props.title - The title of the alert.
+ * @param {string} props.body - The body/content of the alert.
+ * @param {boolean} props.hasIcon - Whether the alert should include an icon.
+ * @param {object} [props.config] - Additional configuration props for the toast.
+ */
+
 export const createToast = ({ variant, title, body, hasIcon, config = {} }) => {
   const toastConfig = {
     position: "bottom-right",
@@ -24,3 +34,11 @@ export const createToast = ({ variant, title, body, hasIcon, config = {} }) => {
     toastConfig
   );
 };
+
+createToast.propTypes = {
+  variant: PropTypes.oneOf(["info", "error", "warning"]).isRequired,
+  title: PropTypes.string,
+  body: PropTypes.string,
+  hasIcon: PropTypes.bool,
+  config: PropTypes.object,
+};