Feat: Manage a Product

[mukunzidd]

Description

As a vendor, I should be able to perform Create, Read, Update, and Delete (CRUD) operations on products in my collection, so that I can effectively manage my inventory and make products available for sale to buyers.

Acceptance Criteria

Create

• Implement a seller product creation API endpoint
• Validate the requesting user's role as a seller
• Validate the request body (price, name, category, expiry date, bonus, etc.)
• Check if the target item already exists in the seller's collection
• If the item does not exist, add it to the seller's collection
• If the item exists, return a response suggesting an update of stock levels
• Implement error handling and appropriate response messages for validation failures
• Implement input sanitization
• Ensure the product has a reference to the associated seller
• Handle product images as reference URLs in the database (4 - 8 images)

Read

• Implement an API endpoint for retrieving a seller's product collection
• Validate the requesting user's role as a seller
• Retrieve and return the list of products associated with the seller
• Implement pagination and filtering options (if necessary)
• Implement error handling and appropriate response messages

Update

• Implement an API endpoint for updating a seller's product details
• Validate the requesting user's role as a seller
• Validate the request payload (product ID, updated fields)
• Retrieve the product from the database based on the provided product ID
• Ensure the product belongs to the requesting seller
• Update the product details in the database
• Implement error handling and appropriate response messages for validation failures
• Implement input sanitization

Delete

• Implement an API endpoint for deleting a seller's product
• Validate the requesting user's role as a seller
• Validate the request payload (product ID)
• Retrieve the product from the database based on the provided product ID
• Ensure the product belongs to the requesting seller
• Delete the product from the database
• Implement error handling and appropriate response messages for validation failures
• Implement input sanitization

Developer Notes

• Document with Swagger
• All inputs should be validated for sanity
• Only reference URLs may be stored in the database for the case of file uploads
• The product should have a reference to the seller

Related Issues

• Feat: Role-Based Access Control (RBAC) #45

Definition of Done

• CRUD API endpoints for seller product management are implemented and functional
• Appropriate responses are sent to the requesting client based on scenarios
• Validation checks are implemented for request body and user role
• Product images are handled as reference URLs in the database
• Products have a reference to the associated seller
• Unit tests are written and passing
• Code adheres to coding standards and best practices
• API documentation with Swagger is completed

[aimedivin]

1. Deliverables at the end of the project.

By the end, vendors can easily manage products. They'll create, view, update, and delete products. We'll ensure only the right vendor (product owner) can make changes. Swagger helps us document everything neatly.

DEV NOTE (REQUIRED)

Document code using Swagger

2. Data flow / Flowchart / pseudocode / ERD diagrams

ER Diagram

Determine the Environments (tools)

• Use Nodejs(expressJs)
• Use Typescript
• Use Multer
• TypeORM (Postgres)

4. Schedule of implementation of the various parts

Below Tasks will be delivered by specified dates

• Implementation plan by Thursday (9th/5/2024)
• API Implementation by Thursday (9th/5/2024)
• API Documentation and Unit Testing by Friday (10th/ 5/2024) 

5. Dependencies/Foreseen blockers from team members

None

6. External services or libraries to be used.

    

[faid-terence]

@aimedivin and @MC-Knight !
Your implementation plan looks good , just one question
Are you implementing the task in same branch or separate branch ??

[MC-Knight]

@faid-terence on same branch

[faid-terence]

Alright !! You can start working