Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added documentation, shoutoutAPI #579

Merged
merged 4 commits into from
Mar 4, 2024
Merged

added documentation, shoutoutAPI #579

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e897e84
added documentation, shoutoutAPI
keverie Feb 12, 2024
0f8ee58
"Gives" --> "Creates"
keverie Feb 12, 2024
3eca2dc
Merge branch 'main' into so-api-documentation
keverie Mar 4, 2024
8335d0f
removed redundant @param from so-api-documentation
keverie Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions backend/src/API/shoutoutAPI.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,17 @@ import ShoutoutsDao from '../dao/ShoutoutsDao';

const shoutoutsDao = new ShoutoutsDao();

/**
* Retrieves all shoutouts from the database.
* @returns A promise that resolves to an array of Shoutout objects.
*/
export const getAllShoutouts = (): Promise<Shoutout[]> => shoutoutsDao.getAllShoutouts();

/**
* Creates a shoutout, ensuring the giver has the correct permissions.
* @throws {PermissionError} If the user attempting to give a shoutout is not the same as the giver specified in the shoutout.
* @returns A promise that resolves to the created Shoutout object.
*/
export const giveShoutout = async (body: Shoutout, user: IdolMember): Promise<Shoutout> => {
if (body.giver.email !== user.email) {
throw new PermissionError(
Expand All @@ -15,6 +24,11 @@ export const giveShoutout = async (body: Shoutout, user: IdolMember): Promise<Sh
return shoutoutsDao.createShoutout(body);
};

/**
* Retrieves shoutouts based on the type (given or received) for a specific member.
* @throws {PermissionError} If the user does not have permission to view the shoutouts.
* @returns A promise that resolves to an array of Shoutout objects.
*/
export const getShoutouts = async (
memberEmail: string,
type: 'given' | 'received',
Expand All @@ -29,6 +43,11 @@ export const getShoutouts = async (
return shoutoutsDao.getShoutouts(memberEmail, type);
};

/**
* Hides or unhides a shoutout based on the user's permissions.
* @throws {PermissionError} If the user does not have permission to hide shoutouts.
* @throws {NotFoundError} If no shoutout with the provided uuid exists.
*/
export const hideShoutout = async (
uuid: string,
hide: boolean,
Expand All @@ -45,6 +64,11 @@ export const hideShoutout = async (
await shoutoutsDao.updateShoutout({ ...shoutout, hidden: hide });
};

/**
* Deletes a shoutout, ensuring the user has the necessary permissions or ownership.
* @throws {NotFoundError} If no shoutout with the provided uuid is found.
* @throws {PermissionError} If the user is neither the giver of the shoutout nor an admin or lead.
*/
export const deleteShoutout = async (uuid: string, user: IdolMember): Promise<void> => {
const shoutout = await shoutoutsDao.getShoutout(uuid);
if (!shoutout) {
Expand Down
Loading