diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index f27a6ec..40c5bb9 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -47,9 +47,6 @@ RUN mkdir -p /etc/apt/keyrings \ && npm install -g npm@latest \ && rm -rf /var/lib/apt/lists/* -# Install Angular CLI Globally -RUN npm install -g @angular/cli - # Use a non-root user per https://code.visualstudio.com/remote/advancedcontainers/add-nonroot-user ARG USERNAME=vscode ARG USER_UID=1000 diff --git a/backend/services/resource.py b/backend/services/resource.py index 3522003..c06af66 100644 --- a/backend/services/resource.py +++ b/backend/services/resource.py @@ -1,123 +1,138 @@ -from fastapi import Depends -from ..database import db_session -from sqlalchemy.orm import Session -from sqlalchemy import and_, select -from ..models.resource_model import Resource -from ..entities.resource_entity import ResourceEntity -from ..models.user_model import User, UserTypeEnum - -from .exceptions import ProgramNotAssignedException, ResourceNotFoundException - - -class ResourceService: - - def __init__(self, session: Session = Depends(db_session)): - self._session = session - - def get_resource_by_user(self, subject: User) -> list[Resource]: - """Resource method getting all of the resources that a user has access to based on role""" - if subject.role != UserTypeEnum.VOLUNTEER: - query = select(ResourceEntity) - entities = self._session.scalars(query).all() - return [resource.to_model() for resource in entities] - else: - programs = subject.program - resources = [] - for program in programs: - entities = ( - self._session.query(ResourceEntity) - .where(ResourceEntity.program == program) - .all() - ) - for entity in entities: - resources.append(entity.to_model()) - return [resource for resource in resources] - - def get_resource_by_name(self, name: str, subject: User) -> Resource: - """Get a resource by name.""" - query = select(ResourceEntity).where( - and_( - ResourceEntity.name == name, ResourceEntity.program.in_(subject.program) - ) - ) - entity = self._session.scalars(query).one_or_none() - if entity is None: - raise ResourceNotFoundException( - f"Resource with name: {name} does not exist or program has not been assigned." - ) - return entity.to_model() - - def create(self, subject: User, resource: Resource) -> Resource: - """ - Creates a resource based on the input object and adds it to the table if the user has the right permissions. - - Parameters: - user: a valid User model representing the currently logged in User - resource: Resource object to add to table - - Returns: - Resource: Object added to table - """ - if subject.role != UserTypeEnum.ADMIN: - raise ProgramNotAssignedException( - f"User is not {UserTypeEnum.ADMIN}, cannot update service" - ) - resource_entity = ResourceEntity.from_model(resource) - self._session.add(resource_entity) - self._session.commit() - return resource_entity.to_model() - - def update(self, subject: User, resource: Resource) -> Resource: - """ - Update the resource if the user has access - - Parameters: - user: a valid User model representing the currently logged in User - resource (ResourceEntity): Resource to update - - Returns: - Resource: Updated resource object - - Raises: - ResourceNotFoundException: If no resource is found with the corresponding ID - """ - if subject.role != UserTypeEnum.ADMIN: - raise ProgramNotAssignedException( - f"User is not {UserTypeEnum.ADMIN}, cannot update service" - ) - query = select(ResourceEntity).where(ResourceEntity.id == resource.id) - entity = self._session.scalars(query).one_or_none() - if entity is None: - raise ResourceNotFoundException( - f"No resource found with matching id: {resource.id}" - ) - entity.name = resource.name - entity.summary = resource.summary - entity.link = resource.link - entity.program = resource.program - self._session.commit() - return entity.to_model() - - def delete(self, subject: User, resource: Resource) -> None: - """ - Delete resource based on id that the user has access to - - Parameters: - user: a valid User model representing the currently logged in User - id: int, a unique resource id - - Raises: - ResourceNotFoundException: If no resource is found with the corresponding id - """ - if subject.role != UserTypeEnum.ADMIN: - raise ProgramNotAssignedException( - f"User is not {UserTypeEnum.ADMIN}, cannot update service" - ) - query = select(ResourceEntity).where(ResourceEntity.id == resource.id) - entity = self._session.scalars(query).one_or_none() - if entity is None: - raise ResourceNotFoundException( - f"No resource found with matching id: {resource.id}" - ) - self._session.delete(entity) - self._session.commit() +from fastapi import Depends +from ..database import db_session +from sqlalchemy.orm import Session +from sqlalchemy import and_, select +from ..models.resource_model import Resource +from ..entities.resource_entity import ResourceEntity +from ..models.user_model import User, UserTypeEnum + +from .exceptions import ProgramNotAssignedException, ResourceNotFoundException + + +class ResourceService: + + def __init__(self, session: Session = Depends(db_session)): + self._session = session + + def get_resource_by_user(self, subject: User) -> list[Resource]: + """Resource method getting all of the resources that a user has access to based on role""" + if subject.role != UserTypeEnum.VOLUNTEER: + query = select(ResourceEntity) + entities = self._session.scalars(query).all() + return [resource.to_model() for resource in entities] + else: + programs = subject.program + resources = [] + for program in programs: + entities = ( + self._session.query(ResourceEntity) + .where(ResourceEntity.program == program) + .all() + ) + for entity in entities: + resources.append(entity.to_model()) + return [resource for resource in resources] + + def get_resource_by_name(self, name: str, subject: User) -> Resource: + """Get a resource by name.""" + query = select(ResourceEntity).where( + and_( + ResourceEntity.name == name, ResourceEntity.program.in_(subject.program) + ) + ) + entity = self._session.scalars(query).one_or_none() + if entity is None: + raise ResourceNotFoundException( + f"Resource with name: {name} does not exist or program has not been assigned." + ) + return entity.to_model() + + def create(self, subject: User, resource: Resource) -> Resource: + """ + Creates a resource based on the input object and adds it to the table if the user has the right permissions. + Parameters: + user: a valid User model representing the currently logged in User + resource: Resource object to add to table + Returns: + Resource: Object added to table + """ + if subject.role != UserTypeEnum.ADMIN: + raise ProgramNotAssignedException( + f"User is not {UserTypeEnum.ADMIN}, cannot update service" + ) + resource_entity = ResourceEntity.from_model(resource) + self._session.add(resource_entity) + self._session.commit() + return resource_entity.to_model() + + def update(self, subject: User, resource: Resource) -> Resource: + """ + Update the resource if the user has access + Parameters: + user: a valid User model representing the currently logged in User + resource (ResourceEntity): Resource to update + Returns: + Resource: Updated resource object + Raises: + ResourceNotFoundException: If no resource is found with the corresponding ID + """ + if subject.role != UserTypeEnum.ADMIN: + raise ProgramNotAssignedException( + f"User is not {UserTypeEnum.ADMIN}, cannot update service" + ) + query = select(ResourceEntity).where(ResourceEntity.id == resource.id) + entity = self._session.scalars(query).one_or_none() + if entity is None: + raise ResourceNotFoundException( + f"No resource found with matching id: {resource.id}" + ) + entity.name = resource.name + entity.summary = resource.summary + entity.link = resource.link + entity.program = resource.program + self._session.commit() + return entity.to_model() + + def delete(self, subject: User, resource: Resource) -> None: + """ + Delete resource based on id that the user has access to + Parameters: + user: a valid User model representing the currently logged in User + id: int, a unique resource id + Raises: + ResourceNotFoundException: If no resource is found with the corresponding id + """ + if subject.role != UserTypeEnum.ADMIN: + raise ProgramNotAssignedException( + f"User is not {UserTypeEnum.ADMIN}, cannot update service" + ) + query = select(ResourceEntity).where(ResourceEntity.id == resource.id) + entity = self._session.scalars(query).one_or_none() + if entity is None: + raise ResourceNotFoundException( + f"No resource found with matching id: {resource.id}" + ) + self._session.delete(entity) + self._session.commit() + + def get_by_slug(self, user: User, search_string: str) -> list[Resource]: + """ + Get a list of resources given a search string that the user has access to + Parameters: + user: a valid User model representing the currently logged in User + search_string: a string to search resources by + Returns: + list[Resource]: list of resources relating to the string + Raises: + ResourceNotFoundException if no resource is found with the corresponding slug + """ + query = select(ResourceEntity).where( + ResourceEntity.name.ilike(f"%{search_string}%"), + ResourceEntity.program.in_(user.program), + ) + entities = self._session.scalars(query).all() + + if not entities: + return [] + + return [entity.to_model() for entity in entities] diff --git a/backend/test/conftest.py b/backend/test/conftest.py index b91a2ac..f231859 100644 --- a/backend/test/conftest.py +++ b/backend/test/conftest.py @@ -4,7 +4,7 @@ import pytest from sqlalchemy import Engine, create_engine, text from sqlalchemy.orm import Session from sqlalchemy.exc import OperationalError -from .services import user_test_data, tag_test_data, service_test_data +from .services import user_test_data, tag_test_data, service_test_data, resource_test_data from ..database import _engine_str from ..env import getenv @@ -57,5 +57,6 @@ def setup_insert_data_fixture(session: Session): user_test_data.insert_fake_data(session) tag_test_data.insert_fake_data(session) service_test_data.insert_fake_data(session) + resource_test_data.insert_fake_data(session) session.commit() yield diff --git a/backend/test/services/fixtures.py b/backend/test/services/fixtures.py index 9fb349a..213f1bf 100644 --- a/backend/test/services/fixtures.py +++ b/backend/test/services/fixtures.py @@ -6,6 +6,7 @@ from sqlalchemy.orm import Session from ...services import UserService from ...services import TagService from ...services import ServiceService +from ...services import ResourceService @@ -23,4 +24,9 @@ def tag_svc(session: Session): @pytest.fixture() def service_svc(session: Session): """This fixture is used to test the ServiceService class""" - return ServiceService(session) \ No newline at end of file + return ServiceService(session) + +@pytest.fixture() +def resource_svc(session: Session): + """This fixture is used to test the ResourceService class""" + return ResourceService(session) \ No newline at end of file diff --git a/backend/test/services/resource_test.py b/backend/test/services/resource_test.py new file mode 100644 index 0000000..7d9b007 --- /dev/null +++ b/backend/test/services/resource_test.py @@ -0,0 +1,126 @@ +from backend.models.user_model import User +from backend.entities.resource_entity import ResourceEntity +from ...models.enum_for_models import ProgramTypeEnum +from backend.services.resource import ResourceService +from backend.services.tag import TagService +from backend.services.exceptions import ResourceNotFoundException +from . import resource_test_data +from . import user_test_data +from .fixtures import resource_svc, user_svc, tag_svc +from backend.models.resource_model import Resource +import pytest + + +def test_get_resource_by_user_volunteer(resource_svc: ResourceService): + """ Test getting resources by a volunteer """ + resources = resource_svc.get_resource_by_user(user_test_data.volunteer) + assert len(resources) == 2 + assert isinstance(resources[0], Resource) + +def test_get_resources_admin(resource_svc: ResourceService): + """ Test getting resources by an admin """ + resources = resource_svc.get_resource_by_user(user_test_data.admin) + assert len(resources) == len(resource_test_data.resources) + assert isinstance(resources[0], Resource) + +def test_get_resources_employee(resource_svc: ResourceService): + """ Test getting by an employee """ + resources = resource_svc.get_resource_by_user(user_test_data.employee) + assert len(resources) == 5 + assert isinstance(resources[0], Resource) + +def test_create_resource_admin(resource_svc: ResourceService): + """ Test creating resources as an admin """ + resource = resource_svc.create(user_test_data.admin, resource_test_data.resource6) + assert resource.name == resource_test_data.resource6.name + assert isinstance(resource, Resource) + +def test_create_not_permitted(resource_svc: ResourceService): + """ Test creating resources without permission """ + with pytest.raises(PermissionError): + resource = resource_svc.create(user_test_data.volunteer, resource_test_data.resource1) + pytest.fail() + +def test_get_by_id(resource_svc: ResourceService): + """ Test getting a resource by id as an admin """ + test_resource = resource_test_data.resource1 + resource = resource_svc.get_by_id(user_test_data.admin, test_resource.id) + assert resource is not None + assert resource.id == test_resource.id + assert resource.name == test_resource.name + +def test_get_by_id_no_access(resource_svc: ResourceService): + """ Test getting a resourced with an id no accessible to an employee """ + test_resource = resource_test_data.resource2 + with pytest.raises(ResourceNotFoundException): + resource = resource_svc.get_by_id(user_test_data.employee, test_resource.id) + pytest.fail() + +def test_update(resource_svc: ResourceService): + """ Test updating a resource by an admin """ + updated_resource = resource_test_data.resource5_new + resource = resource_svc.update(user_test_data.admin, updated_resource) + db_resource = resource_svc.get_by_id(user_test_data.admin, resource.id) + assert resource.id == updated_resource.id + assert resource.name == updated_resource.name + assert resource.summary == updated_resource.summary + assert resource.link == updated_resource.link + assert resource.program == updated_resource.program + assert db_resource.id == updated_resource.id + assert db_resource.name == updated_resource.name + assert db_resource.summary == updated_resource.summary + assert db_resource.link == updated_resource.link + assert db_resource.program == updated_resource.program + + +def test_update_no_permission(resource_svc: ResourceService): + """ Test updating a resource without permission """ + with pytest.raises(PermissionError): + resource = resource_svc.update(user_test_data.employee, resource_test_data.resource5_new) + pytest.fail() + +def test_delete(resource_svc: ResourceService): + """ Test deleting a resource as an admin """ + resource_svc.delete(user_test_data.admin, resource_test_data.resource5.id) + resources = resource_svc.get_resource_by_user(user_test_data.admin) + assert len(resources) == len(resource_test_data.resources) - 1 + +def test_delete_no_permission(resource_svc: ResourceService): + """ Test deleting a resource with no permission """ + with pytest.raises(PermissionError): + resource = resource_svc.delete(user_test_data.employee, resource_test_data.resource5.id) + pytest.fail() + +def test_get_1_by_slug(resource_svc: ResourceService): + """ Test getting 1 resource with a specific search """ + resource_to_test = resource_test_data.resource1 + slug = "Resource 1" + resources = resource_svc.get_by_slug(user_test_data.admin, slug) + assert len(resources) == 1 + resource = resources[0] + assert resource.id == resource_to_test.id + assert resource.name == resource_to_test.name + assert resource.summary == resource_to_test.summary + assert resource.link == resource_to_test.link + assert resource.program == resource_to_test.program + +def test_get_by_slug(resource_svc: ResourceService): + """ Test a generic search to get all resources """ + slug = "Resource" + resources = resource_svc.get_by_slug(user_test_data.admin, slug) + assert len(resources) == 5 + +def test_get_by_slug_not_found(resource_svc: ResourceService): + """ Test getting a resource that does not exist """ + slug = "Not Found" + resources = resource_svc.get_by_slug(user_test_data.admin, slug) + assert len(resources) == 0 + assert resources == [] + + +def test_get_by_slug_no_permission(resource_svc: ResourceService): + """ Test getting a resource the user does not have access to """ + slug = "Resource 2" + resources = resource_svc.get_by_slug(user_test_data.employee, slug) + assert len(resources) == 0 + assert resources == [] \ No newline at end of file diff --git a/backend/test/services/resource_test_data.py b/backend/test/services/resource_test_data.py index bb39266..7634df7 100644 --- a/backend/test/services/resource_test_data.py +++ b/backend/test/services/resource_test_data.py @@ -50,6 +50,24 @@ resource5 = Resource( created_at=datetime(2023, 6, 5, 11, 30, 0), ) +resource6 = Resource( + id=6, + name="Resource 6", + summary="New Financial Resource", + link="https://example.com/resource6", + program=ProgramTypeEnum.ECONOMIC, + created_at=datetime(2024, 6, 5, 11, 30, 0), +) + +resource5_new = Resource( + id=5, + name="Resource 5", + summary = "Updated shelter and housing resources", + link="https://example.com/resource5/new", + program=ProgramTypeEnum.DOMESTIC, + created_at=datetime(2023, 6, 5, 11, 30, 0), +) + resources = [resource1, resource2, resource3, resource4, resource5] resource_1 = Resource( @@ -266,13 +284,11 @@ def reset_table_id_seq( next_id: int, ) -> None: """Reset the ID sequence of an entity table. - Args: session (Session) - A SQLAlchemy Session entity (DeclarativeBase) - The SQLAlchemy Entity table to target entity_id_column (MappedColumn) - The ID column (should be an int column) next_id (int) - Where the next inserted, autogenerated ID should begin - Returns: None""" table = entity.__table__ @@ -312,4 +328,4 @@ def insert_fake_data(session: Session): reset_table_id_seq(session, ResourceEntity, ResourceEntity.id, len(resources) + 1) # Commit all changes - session.commit() + session.commit() \ No newline at end of file diff --git a/compass/app/admin/page.tsx b/compass/app/admin/page.tsx index fede31d..abe2a8c 100644 --- a/compass/app/admin/page.tsx +++ b/compass/app/admin/page.tsx @@ -1,7 +1,7 @@ "use client"; import { PageLayout } from "@/components/PageLayout"; -import { Table } from "@/components/Table/Index"; +import UserTable from "@/components/Table/UserTable"; import User from "@/utils/models/User"; import { createClient } from "@/utils/supabase/client"; @@ -38,7 +38,7 @@ export default function Page() {
{/* icon + title */} }> - + ); diff --git a/compass/app/resource/page.tsx b/compass/app/resource/page.tsx index fc4df14..7cbd2c1 100644 --- a/compass/app/resource/page.tsx +++ b/compass/app/resource/page.tsx @@ -1,8 +1,8 @@ "use client"; import { PageLayout } from "@/components/PageLayout"; -import { ResourceTable } from "@/components/Table/ResourceIndex"; import Resource from "@/utils/models/Resource"; +import ResourceTable from "@/components/Table/ResourceTable"; import { createClient } from "@/utils/supabase/client"; import { BookmarkIcon } from "@heroicons/react/24/solid"; @@ -38,7 +38,7 @@ export default function Page() {
{/* icon + title */} }> - +
); diff --git a/compass/app/service/page.tsx b/compass/app/service/page.tsx index 8ebea4f..efe6337 100644 --- a/compass/app/service/page.tsx +++ b/compass/app/service/page.tsx @@ -1,7 +1,7 @@ "use client"; import { PageLayout } from "@/components/PageLayout"; -import { ServiceTable } from "@/components/Table/ServiceIndex"; +import ServiceTable from "@/components/Table/ServiceTable"; import Service from "@/utils/models/Service"; import { createClient } from "@/utils/supabase/client"; @@ -9,7 +9,7 @@ import { ClipboardIcon } from "@heroicons/react/24/solid"; import { useEffect, useState } from "react"; export default function Page() { - const [services, setUsers] = useState([]); + const [services, setServices] = useState([]); useEffect(() => { async function getServices() { @@ -27,7 +27,7 @@ export default function Page() { ); const servicesAPI: Service[] = await serviceListData.json(); - setUsers(servicesAPI); + setServices(servicesAPI); } getServices(); @@ -37,7 +37,7 @@ export default function Page() {
{/* icon + title */} }> - +
); diff --git a/compass/components/Drawer/Drawer.tsx b/compass/components/Drawer/Drawer.tsx index 6879f75..da6fd8c 100644 --- a/compass/components/Drawer/Drawer.tsx +++ b/compass/components/Drawer/Drawer.tsx @@ -1,4 +1,4 @@ -import { FunctionComponent, ReactNode } from "react"; +import { Dispatch, FunctionComponent, ReactNode, SetStateAction } from "react"; import React, { useState } from "react"; import { ChevronDoubleLeftIcon } from "@heroicons/react/24/solid"; import { @@ -23,7 +23,7 @@ type DrawerProps = { editableContent?: any; onSave?: (content: any) => void; rowContent?: any; - onRowUpdate?: (content: any) => void; + setData: Dispatch>; }; interface EditContent { @@ -37,13 +37,21 @@ const Drawer: FunctionComponent = ({ onSave, editableContent, rowContent, - onRowUpdate, + setData, }) => { const [isOpen, setIsOpen] = useState(false); const [isFull, setIsFull] = useState(false); const [isFavorite, setIsFavorite] = useState(false); const [tempRowContent, setTempRowContent] = useState(rowContent); + const onRowUpdate = (updatedRow: any) => { + setData((prevData: any) => + prevData.map((row: any) => + row.id === updatedRow.id ? updatedRow : row + ) + ); + }; + const handleTempRowContentChange = (e) => { const { name, value } = e.target; console.log(name); diff --git a/compass/components/Table/Index.tsx b/compass/components/Table/Index.tsx deleted file mode 100644 index 931b039..0000000 --- a/compass/components/Table/Index.tsx +++ /dev/null @@ -1,306 +0,0 @@ -// for showcasing to compass - -import users from "./users.json"; -import { - Cell, - ColumnDef, - Row, - createColumnHelper, - flexRender, - getCoreRowModel, - getFilteredRowModel, - sortingFns, - useReactTable, -} from "@tanstack/react-table"; -import { - ChangeEvent, - useState, - useEffect, - FunctionComponent, - useRef, - ChangeEventHandler, - Key, -} from "react"; -import { RowOptionMenu } from "./RowOptionMenu"; -import { RowOpenAction } from "./RowOpenAction"; -import { TableAction } from "./TableAction"; -import { - AtSymbolIcon, - Bars2Icon, - ArrowDownCircleIcon, - PlusIcon, -} from "@heroicons/react/24/solid"; -import TagsInput from "../TagsInput/Index"; -import { rankItem } from "@tanstack/match-sorter-utils"; -import User from "@/utils/models/User"; - -// For search -const fuzzyFilter = ( - row: Row, - columnId: string, - value: any, - addMeta: (meta: any) => void -) => { - // Rank the item - const itemRank = rankItem(row.getValue(columnId), value); - - // Store the ranking info - addMeta(itemRank); - - // Return if the item should be filtered in/out - return itemRank.passed; -}; - -export const Table = ({ users }: { users: User[] }) => { - const columnHelper = createColumnHelper(); - - useEffect(() => { - const sortedUsers = [...users].sort((a, b) => - a.visible === b.visible ? 0 : a.visible ? -1 : 1 - ); - setData(sortedUsers); - }, [users]); - - const deleteUser = (userId: number) => { - console.log(data); - setData((currentData) => - currentData.filter((user) => user.id !== userId) - ); - }; - - const hideUser = (userId: number) => { - console.log(`Toggling visibility for user with ID: ${userId}`); - setData((currentData) => { - const newData = currentData - .map((user) => { - if (user.id === userId) { - return { ...user, visible: !user.visible }; - } - return user; - }) - .sort((a, b) => - a.visible === b.visible ? 0 : a.visible ? -1 : 1 - ); - - console.log(newData); - return newData; - }); - }; - const [presetOptions, setPresetOptions] = useState([ - "administrator", - "volunteer", - "employee", - ]); - const [tagColors, setTagColors] = useState(new Map()); - - const getTagColor = (tag: string) => { - if (!tagColors.has(tag)) { - const colors = [ - "bg-cyan-100", - "bg-blue-100", - "bg-green-100", - "bg-yellow-100", - "bg-purple-100", - ]; - const randomColor = - colors[Math.floor(Math.random() * colors.length)]; - setTagColors(new Map(tagColors).set(tag, randomColor)); - } - return tagColors.get(tag); - }; - - const columns = [ - columnHelper.display({ - id: "options", - cell: (props) => ( - deleteUser(props.row.original.id)} - onHide={() => hideUser(props.row.original.id)} - /> - ), - }), - columnHelper.accessor("username", { - header: () => ( - <> - Username - - ), - cell: (info) => ( - - ), - }), - columnHelper.accessor("role", { - header: () => ( - <> - {" "} - Role - - ), - cell: (info) => ( - - ), - }), - columnHelper.accessor("email", { - header: () => ( - <> - Email - - ), - cell: (info) => ( - - {info.getValue()} - - ), - }), - columnHelper.accessor("program", { - header: () => ( - <> - {" "} - Program - - ), - cell: (info) => , - }), - ]; - - const [data, setData] = useState([...users]); - - const addUser = () => { - setData([...data]); - }; - - // Searching - const [query, setQuery] = useState(""); - const handleSearchChange = (e: ChangeEvent) => { - const target = e.target as HTMLInputElement; - setQuery(String(target.value)); - }; - - const handleCellChange = (e: ChangeEvent, key: Key) => { - const target = e.target as HTMLInputElement; - console.log(key); - }; - - // TODO: Filtering - - // TODO: Sorting - - // added this fn for editing rows - const handleRowUpdate = (updatedRow: User) => { - const dataIndex = data.findIndex((row) => row.id === updatedRow.id); - if (dataIndex !== -1) { - const updatedData = [...data]; - updatedData[dataIndex] = updatedRow; - setData(updatedData); - } - }; - - const table = useReactTable({ - columns, - data, - filterFns: { - fuzzy: fuzzyFilter, - }, - state: { - globalFilter: query, - }, - onGlobalFilterChange: setQuery, - globalFilterFn: fuzzyFilter, - getCoreRowModel: getCoreRowModel(), - }); - - const handleRowData = (row: any) => { - const rowData: any = {}; - row.cells.forEach((cell: any) => { - rowData[cell.column.id] = cell.value; - }); - // Use rowData object containing data from all columns for the current row - console.log(rowData); - return rowData; - }; - - return ( -
-
- -
-
- - {table.getHeaderGroups().map((headerGroup) => ( - - {headerGroup.headers.map((header, i) => ( - - ))} - - ))} - - - {table.getRowModel().rows.map((row) => { - // Individual row - const isUserVisible = row.original.visible; - const rowClassNames = `text-gray-800 border-y lowercase hover:bg-gray-50 ${ - !isUserVisible ? "bg-gray-200 text-gray-500" : "" - }`; - return ( - - {row.getVisibleCells().map((cell, i) => ( - - ))} - - ); - })} - - - - - - -
- {header.isPlaceholder - ? null - : flexRender( - header.column.columnDef.header, - header.getContext() - )} -
- {flexRender( - cell.column.columnDef.cell, - cell.getContext() - )} -
- - - New - -
-
- ); -}; diff --git a/compass/components/Table/ResourceTable.tsx b/compass/components/Table/ResourceTable.tsx new file mode 100644 index 0000000..6979498 --- /dev/null +++ b/compass/components/Table/ResourceTable.tsx @@ -0,0 +1,82 @@ +import { Bars2Icon } from "@heroicons/react/24/solid"; +import { Dispatch, SetStateAction, useState } from "react"; +import useTagsHandler from "@/components/TagsInput/TagsHandler"; +import { ColumnDef, createColumnHelper } from "@tanstack/react-table"; +import { RowOpenAction } from "@/components/Table/RowOpenAction"; +import Table from "@/components/Table/Table"; +import TagsInput from "@/components/TagsInput/Index"; +import Resource from "@/utils/models/Resource"; + +type ResourceTableProps = { + data: Resource[]; + setData: Dispatch>; +}; + +/** + * Table componenet used for displaying resources + * @param props.data Stateful list of resources to be displayed by the table + * @param props.setData State setter for the list of resources + */ +export default function ResourceTable({ data, setData }: ResourceTableProps) { + const columnHelper = createColumnHelper(); + + // Set up tag handling + const programProps = useTagsHandler(["community", "domestic", "economic"]); + + // Define Tanstack columns + const columns: ColumnDef[] = [ + columnHelper.accessor("name", { + header: () => ( + <> + Name + + ), + cell: (info) => ( + + ), + }), + columnHelper.accessor("link", { + header: () => ( + <> + Link + + ), + cell: (info) => ( + + {info.getValue()} + + ), + }), + columnHelper.accessor("program", { + header: () => ( + <> + Program + + ), + cell: (info) => ( + + ), + }), + + columnHelper.accessor("summary", { + header: () => ( + <> + Summary + + ), + cell: (info) => ( + {info.getValue()} + ), + }), + ]; + + return ; +} diff --git a/compass/components/Table/RowOpenAction.tsx b/compass/components/Table/RowOpenAction.tsx index 9a7103c..a6aeb52 100644 --- a/compass/components/Table/RowOpenAction.tsx +++ b/compass/components/Table/RowOpenAction.tsx @@ -1,10 +1,21 @@ import Drawer from "@/components/Drawer/Drawer"; -import { ChangeEvent, useState } from "react"; +import DataPoint from "@/utils/models/DataPoint"; +import { Dispatch, SetStateAction, useState } from "react"; -export const RowOpenAction = ({ title, rowData, onRowUpdate }) => { +type RowOpenActionProps = { + title: string; + rowData: T; + setData: Dispatch>; +}; + +export function RowOpenAction({ + title, + rowData, + setData, +}: RowOpenActionProps) { const [pageContent, setPageContent] = useState(""); - const handleDrawerContentChange = (newContent) => { + const handleDrawerContentChange = (newContent: string) => { setPageContent(newContent); }; @@ -12,17 +23,16 @@ export const RowOpenAction = ({ title, rowData, onRowUpdate }) => {
{title} - {/* Added OnRowUpdate to drawer */} {pageContent}
); -}; +} diff --git a/compass/components/Table/ServiceIndex.tsx b/compass/components/Table/ServiceIndex.tsx deleted file mode 100644 index 6895984..0000000 --- a/compass/components/Table/ServiceIndex.tsx +++ /dev/null @@ -1,312 +0,0 @@ -// for showcasing to compass - -import users from "./users.json"; -import { - Cell, - ColumnDef, - Row, - createColumnHelper, - flexRender, - getCoreRowModel, - getFilteredRowModel, - sortingFns, - useReactTable, -} from "@tanstack/react-table"; -import { - ChangeEvent, - useState, - useEffect, - FunctionComponent, - useRef, - ChangeEventHandler, - Key, -} from "react"; -import { RowOptionMenu } from "./RowOptionMenu"; -import { RowOpenAction } from "./RowOpenAction"; -import { TableAction } from "./TableAction"; -import { - AtSymbolIcon, - Bars2Icon, - ArrowDownCircleIcon, - PlusIcon, -} from "@heroicons/react/24/solid"; -import TagsInput from "../TagsInput/Index"; -import { rankItem } from "@tanstack/match-sorter-utils"; -import Service from "@/utils/models/Service"; - -// For search -const fuzzyFilter = ( - row: Row, - columnId: string, - value: any, - addMeta: (meta: any) => void -) => { - // Rank the item - const itemRank = rankItem(row.getValue(columnId), value); - - // Store the ranking info - addMeta(itemRank); - - // Return if the item should be filtered in/out - return itemRank.passed; -}; - -// TODO: Rename everything to service -export const ServiceTable = ({ users }: { users: Service[] }) => { - const columnHelper = createColumnHelper(); - - useEffect(() => { - const sortedUsers = [...users].sort((a, b) => - a.visible === b.visible ? 0 : a.visible ? -1 : 1 - ); - setData(sortedUsers); - }, [users]); - - const deleteUser = (userId: number) => { - console.log(data); - setData((currentData) => - currentData.filter((user) => user.id !== userId) - ); - }; - - const hideUser = (userId: number) => { - console.log(`Toggling visibility for user with ID: ${userId}`); - setData((currentData) => { - const newData = currentData - .map((user) => { - if (user.id === userId) { - return { ...user, visible: !user.visible }; - } - return user; - }) - .sort((a, b) => - a.visible === b.visible ? 0 : a.visible ? -1 : 1 - ); - - console.log(newData); - return newData; - }); - }; - const [presetOptions, setPresetOptions] = useState([ - "administrator", - "volunteer", - "employee", - ]); - const [tagColors, setTagColors] = useState(new Map()); - - const getTagColor = (tag: string) => { - if (!tagColors.has(tag)) { - const colors = [ - "bg-cyan-100", - "bg-blue-100", - "bg-green-100", - "bg-yellow-100", - "bg-purple-100", - ]; - const randomColor = - colors[Math.floor(Math.random() * colors.length)]; - setTagColors(new Map(tagColors).set(tag, randomColor)); - } - return tagColors.get(tag); - }; - - const columns = [ - columnHelper.display({ - id: "options", - cell: (props) => ( - {}} - onHide={() => hideUser(props.row.original.id)} - /> - ), - }), - columnHelper.accessor("name", { - header: () => ( - <> - Name - - ), - cell: (info) => ( - - ), - }), - columnHelper.accessor("status", { - header: () => ( - <> - Status - - ), - cell: (info) => ( - {info.getValue()} - ), - }), - columnHelper.accessor("program", { - header: () => ( - <> - Program - - ), - cell: (info) => , - }), - columnHelper.accessor("requirements", { - header: () => ( - <> - Requirements - - ), - cell: (info) => ( - - ), - }), - - columnHelper.accessor("summary", { - header: () => ( - <> - Summary - - ), - cell: (info) => ( - {info.getValue()} - ), - }), - ]; - - const [data, setData] = useState([...users]); - - const addUser = () => { - setData([...data]); - }; - - // Searching - const [query, setQuery] = useState(""); - const handleSearchChange = (e: ChangeEvent) => { - const target = e.target as HTMLInputElement; - setQuery(String(target.value)); - }; - - const handleCellChange = (e: ChangeEvent, key: Key) => { - const target = e.target as HTMLInputElement; - console.log(key); - }; - - // TODO: Filtering - - // TODO: Sorting - - // added this fn for editing rows - const handleRowUpdate = (updatedRow: Service) => { - const dataIndex = data.findIndex((row) => row.id === updatedRow.id); - if (dataIndex !== -1) { - const updatedData = [...data]; - updatedData[dataIndex] = updatedRow; - setData(updatedData); - } - }; - - const table = useReactTable({ - columns, - data, - filterFns: { - fuzzy: fuzzyFilter, - }, - state: { - globalFilter: query, - }, - onGlobalFilterChange: setQuery, - globalFilterFn: fuzzyFilter, - getCoreRowModel: getCoreRowModel(), - }); - - const handleRowData = (row: any) => { - const rowData: any = {}; - row.cells.forEach((cell: any) => { - rowData[cell.column.id] = cell.value; - }); - // Use rowData object containing data from all columns for the current row - console.log(rowData); - return rowData; - }; - - return ( -
-
- -
-
- - {table.getHeaderGroups().map((headerGroup) => ( - - {headerGroup.headers.map((header, i) => ( - - ))} - - ))} - - - {table.getRowModel().rows.map((row) => { - // Individual row - const isUserVisible = row.original.visible; - const rowClassNames = `text-gray-800 border-y lowercase hover:bg-gray-50 ${ - !isUserVisible ? "bg-gray-200 text-gray-500" : "" - }`; - return ( - - {row.getVisibleCells().map((cell, i) => ( - - ))} - - ); - })} - - - - - - -
- {header.isPlaceholder - ? null - : flexRender( - header.column.columnDef.header, - header.getContext() - )} -
- {flexRender( - cell.column.columnDef.cell, - cell.getContext() - )} -
- - - New - -
- - ); -}; diff --git a/compass/components/Table/ServiceTable.tsx b/compass/components/Table/ServiceTable.tsx new file mode 100644 index 0000000..794452e --- /dev/null +++ b/compass/components/Table/ServiceTable.tsx @@ -0,0 +1,103 @@ +import { Bars2Icon } from "@heroicons/react/24/solid"; +import { Dispatch, SetStateAction } from "react"; +import useTagsHandler from "@/components/TagsInput/TagsHandler"; +import { ColumnDef, createColumnHelper } from "@tanstack/react-table"; +import Table from "@/components/Table/Table"; +import { RowOpenAction } from "@/components/Table/RowOpenAction"; +import TagsInput from "@/components/TagsInput/Index"; +import Service from "@/utils/models/Service"; + +type ServiceTableProps = { + data: Service[]; + setData: Dispatch>; +}; + +/** + * Table componenet used for displaying services + * @param props.data Stateful list of services to be displayed by the table + * @param props.setData State setter for the list of services + */ +export default function ServiceTable({ data, setData }: ServiceTableProps) { + const columnHelper = createColumnHelper(); + + // Set up tag handling + const programProps = useTagsHandler(["community", "domestic", "economic"]); + + // TODO: Dynamically or statically get full list of preset requirement tag options + const requirementProps = useTagsHandler([ + "anonymous", + "confidential", + "referral required", + "safety assessment", + "intake required", + "income eligibility", + "initial assessment", + ]); + + // Define Tanstack columns + const columns: ColumnDef[] = [ + columnHelper.accessor("name", { + header: () => ( + <> + Name + + ), + cell: (info) => ( + + ), + }), + columnHelper.accessor("status", { + header: () => ( + <> + Status + + ), + cell: (info) => ( + {info.getValue()} + ), + }), + columnHelper.accessor("program", { + header: () => ( + <> + Program + + ), + cell: (info) => ( + + ), + }), + columnHelper.accessor("requirements", { + header: () => ( + <> + Requirements + + ), + cell: (info) => ( + // TODO: Setup different tag handler for requirements + + ), + }), + + columnHelper.accessor("summary", { + header: () => ( + <> + Summary + + ), + cell: (info) => ( + {info.getValue()} + ), + }), + ]; + + return ; +} diff --git a/compass/components/Table/ResourceIndex.tsx b/compass/components/Table/Table.tsx similarity index 56% rename from compass/components/Table/ResourceIndex.tsx rename to compass/components/Table/Table.tsx index a714836..b0a3bd1 100644 --- a/compass/components/Table/ResourceIndex.tsx +++ b/compass/components/Table/Table.tsx @@ -1,40 +1,32 @@ -// for showcasing to compass - -import users from "./users.json"; import { - Cell, - ColumnDef, Row, - createColumnHelper, - flexRender, - getCoreRowModel, - getFilteredRowModel, - sortingFns, + ColumnDef, useReactTable, + getCoreRowModel, + flexRender, + createColumnHelper, } from "@tanstack/react-table"; import { ChangeEvent, useState, useEffect, - FunctionComponent, - useRef, - ChangeEventHandler, Key, + Dispatch, + SetStateAction, } from "react"; -import { RowOptionMenu } from "./RowOptionMenu"; -import { RowOpenAction } from "./RowOpenAction"; import { TableAction } from "./TableAction"; -import { - AtSymbolIcon, - Bars2Icon, - ArrowDownCircleIcon, - PlusIcon, -} from "@heroicons/react/24/solid"; -import TagsInput from "../TagsInput/Index"; +import { PlusIcon } from "@heroicons/react/24/solid"; import { rankItem } from "@tanstack/match-sorter-utils"; -import Resource from "@/utils/models/Resource"; +import { RowOptionMenu } from "./RowOptionMenu"; +import DataPoint from "@/utils/models/DataPoint"; -// For search +type TableProps = { + data: T[]; + setData: Dispatch>; + columns: ColumnDef[]; +}; + +/** Fuzzy search function */ const fuzzyFilter = ( row: Row, columnId: string, @@ -51,131 +43,69 @@ const fuzzyFilter = ( return itemRank.passed; }; -// TODO: Rename everything to resources -export const ResourceTable = ({ users }: { users: Resource[] }) => { - const columnHelper = createColumnHelper(); +/** + * General componenet that holds shared functionality for any data table component + * @param props.data Stateful list of data to be held in the table + * @param props.setData State setter for the list of data + * @param props.columns Column definitions made with Tanstack columnHelper + */ +export default function Table({ + data, + setData, + columns, +}: TableProps) { + const columnHelper = createColumnHelper(); + /** Sorting function based on visibility */ + const visibilitySort = (a: T, b: T) => + a.visible === b.visible ? 0 : a.visible ? -1 : 1; + + // Sort data on load useEffect(() => { - const sortedUsers = [...users].sort((a, b) => - a.visible === b.visible ? 0 : a.visible ? -1 : 1 - ); - setData(sortedUsers); - }, [users]); + setData((prevData) => prevData.sort(visibilitySort)); + }, [setData]); - const deleteUser = (userId: number) => { + // Data manipulation methods + // TODO: Connect data manipulation methods to the database (deleteData, hideData, addData) + const deleteData = (dataId: number) => { console.log(data); setData((currentData) => - currentData.filter((user) => user.id !== userId) + currentData.filter((data) => data.id !== dataId) ); }; - const hideUser = (userId: number) => { - console.log(`Toggling visibility for user with ID: ${userId}`); + const hideData = (dataId: number) => { + console.log(`Toggling visibility for data with ID: ${dataId}`); setData((currentData) => { const newData = currentData - .map((user) => { - if (user.id === userId) { - return { ...user, visible: !user.visible }; - } - return user; - }) - .sort((a, b) => - a.visible === b.visible ? 0 : a.visible ? -1 : 1 - ); + .map((data) => + data.id === dataId + ? { ...data, visible: !data.visible } + : data + ) + .sort(visibilitySort); console.log(newData); return newData; }); }; - const [presetOptions, setPresetOptions] = useState([ - "administrator", - "volunteer", - "employee", - ]); - const [tagColors, setTagColors] = useState(new Map()); - const getTagColor = (tag: string) => { - if (!tagColors.has(tag)) { - const colors = [ - "bg-cyan-100", - "bg-blue-100", - "bg-green-100", - "bg-yellow-100", - "bg-purple-100", - ]; - const randomColor = - colors[Math.floor(Math.random() * colors.length)]; - setTagColors(new Map(tagColors).set(tag, randomColor)); - } - return tagColors.get(tag); + const addData = () => { + setData([...data]); }; - const columns = [ + // Add data manipulation options to the first column + columns.unshift( columnHelper.display({ id: "options", cell: (props) => ( {}} - onHide={() => hideUser(props.row.original.id)} + onDelete={() => deleteData(props.row.original.id)} + onHide={() => hideData(props.row.original.id)} /> ), - }), - columnHelper.accessor("name", { - header: () => ( - <> - Name - - ), - cell: (info) => ( - - ), - }), - columnHelper.accessor("link", { - header: () => ( - <> - Link - - ), - cell: (info) => ( - - {info.getValue()} - - ), - }), - columnHelper.accessor("program", { - header: () => ( - <> - Program - - ), - cell: (info) => , - }), - - columnHelper.accessor("summary", { - header: () => ( - <> - Summary - - ), - cell: (info) => ( - {info.getValue()} - ), - }), - ]; - - const [data, setData] = useState([...users]); - - const addUser = () => { - setData([...data]); - }; + }) + ); // Searching const [query, setQuery] = useState(""); @@ -193,16 +123,7 @@ export const ResourceTable = ({ users }: { users: Resource[] }) => { // TODO: Sorting - // added this fn for editing rows - const handleRowUpdate = (updatedRow: Resource) => { - const dataIndex = data.findIndex((row) => row.id === updatedRow.id); - if (dataIndex !== -1) { - const updatedData = [...data]; - updatedData[dataIndex] = updatedRow; - setData(updatedData); - } - }; - + // Define Tanstack table const table = useReactTable({ columns, data, @@ -261,9 +182,9 @@ export const ResourceTable = ({ users }: { users: Resource[] }) => { {table.getRowModel().rows.map((row) => { // Individual row - const isUserVisible = row.original.visible; + const isDataVisible = row.original.visible; const rowClassNames = `text-gray-800 border-y lowercase hover:bg-gray-50 ${ - !isUserVisible ? "bg-gray-200 text-gray-500" : "" + !isDataVisible ? "bg-gray-200 text-gray-500" : "" }`; return ( @@ -289,7 +210,7 @@ export const ResourceTable = ({ users }: { users: Resource[] }) => {
@@ -301,4 +222,4 @@ export const ResourceTable = ({ users }: { users: Resource[] }) => {
); -}; +} diff --git a/compass/components/Table/UserTable.tsx b/compass/components/Table/UserTable.tsx new file mode 100644 index 0000000..a480dc8 --- /dev/null +++ b/compass/components/Table/UserTable.tsx @@ -0,0 +1,89 @@ +import { + ArrowDownCircleIcon, + AtSymbolIcon, + Bars2Icon, +} from "@heroicons/react/24/solid"; +import { Dispatch, SetStateAction } from "react"; +import useTagsHandler from "@/components/TagsInput/TagsHandler"; +import { ColumnDef, createColumnHelper } from "@tanstack/react-table"; +import Table from "@/components/Table/Table"; +import { RowOpenAction } from "@/components/Table/RowOpenAction"; +import TagsInput from "@/components/TagsInput/Index"; +import User from "@/utils/models/User"; + +type UserTableProps = { + data: User[]; + setData: Dispatch>; +}; + +/** + * Table componenet used for displaying users + * @param props.data Stateful list of users to be displayed by the table + * @param props.setData State setter for the list of users + */ +export default function UserTable({ data, setData }: UserTableProps) { + const columnHelper = createColumnHelper(); + + // Set up tag handling + const roleProps = useTagsHandler([ + "administrator", + "volunteer", + "employee", + ]); + + const programProps = useTagsHandler(["community", "domestic", "economic"]); + + // Define Tanstack columns + const columns: ColumnDef[] = [ + columnHelper.accessor("username", { + header: () => ( + <> + Username + + ), + cell: (info) => ( + + ), + }), + columnHelper.accessor("role", { + header: () => ( + <> + {" "} + Role + + ), + cell: (info) => ( + + ), + }), + columnHelper.accessor("email", { + header: () => ( + <> + Email + + ), + cell: (info) => ( + + {info.getValue()} + + ), + }), + columnHelper.accessor("program", { + header: () => ( + <> + {" "} + Program + + ), + cell: (info) => ( + + ), + }), + ]; + + return data={data} setData={setData} columns={columns} />; +} diff --git a/compass/components/TagsInput/Index.tsx b/compass/components/TagsInput/Index.tsx index 19c2a77..f4b021e 100644 --- a/compass/components/TagsInput/Index.tsx +++ b/compass/components/TagsInput/Index.tsx @@ -1,4 +1,4 @@ -import React, { useState, useRef } from "react"; +import React, { useState, useRef, Dispatch, SetStateAction } from "react"; import "tailwindcss/tailwind.css"; import { TagsArray } from "./TagsArray"; import { TagDropdown } from "./TagDropdown"; @@ -7,8 +7,8 @@ import { CreateNewTagAction } from "./CreateNewTagAction"; interface TagsInputProps { presetOptions: string[]; presetValue: string | string[]; - setPresetOptions: () => {}; - getTagColor: () => {}; + setPresetOptions: Dispatch>; + getTagColor(tag: string): string; } const TagsInput: React.FC = ({ diff --git a/compass/components/TagsInput/TagsArray.tsx b/compass/components/TagsInput/TagsArray.tsx index c014e7c..845e739 100644 --- a/compass/components/TagsInput/TagsArray.tsx +++ b/compass/components/TagsInput/TagsArray.tsx @@ -7,7 +7,7 @@ export interface Tags { } export const TagsArray = ({ tags, handleDelete, active = false }: Tags) => { - console.log(tags); + // console.log(tags); return (
diff --git a/compass/components/TagsInput/TagsHandler.tsx b/compass/components/TagsInput/TagsHandler.tsx new file mode 100644 index 0000000..179e367 --- /dev/null +++ b/compass/components/TagsInput/TagsHandler.tsx @@ -0,0 +1,35 @@ +import { useState } from "react"; + +/** + * Custom hook used to handle the state of tag options and colors + * @param initialOptions Initial value for preset options + * @returns An object with three fields intended to be passed into a `TagsInput` component: + * - `presetOptions` - the current state of tag options + * - `setPresetOptions` - the state setter for presetOptions + * - `getTagColor` - function that retrieves the color for the given tag + */ +export default function useTagsHandler(initialOptions: string[]) { + const [presetOptions, setPresetOptions] = useState(initialOptions); + const [tagColors, setTagColors] = useState(new Map()); + + const getTagColor = (tag: string): string => { + if (!tagColors.has(tag)) { + const colors = [ + "bg-cyan-100", + "bg-blue-100", + "bg-green-100", + "bg-yellow-100", + "bg-purple-100", + ]; + const randomColor = + colors[Math.floor(Math.random() * colors.length)]; + setTagColors(new Map(tagColors).set(tag, randomColor)); + return randomColor; + } + // Since we populate any missing keys, .get will never return undefined, + // so we are safe to typecast to prevent a type error + return tagColors.get(tag) as string; + }; + + return { presetOptions, setPresetOptions, getTagColor }; +} diff --git a/compass/utils/models/DataPoint.ts b/compass/utils/models/DataPoint.ts new file mode 100644 index 0000000..4a6a321 --- /dev/null +++ b/compass/utils/models/DataPoint.ts @@ -0,0 +1,9 @@ +/** + * Represents metadata of the Resource, Service, and User models to be used in a table + */ +interface DataPoint { + id: number; + visible: boolean; +} + +export default DataPoint;