Creating Inventory APIs by davdwan21 · Pull Request #8 · CSES-Dev/lims-lab-inventory

davdwan21 · 2026-02-15T19:20:53Z

Describe your changes

Created given folder structure, unsure about use case - implemented dir structure similar to demo
Created items.ts in services for generic services similar to the demo
route.ts is broken up between [id] and general for cleaner API management
Multiple schemas to enforce typing in items - currently implements highly strict typing
Created general routes for GET, POST
Created id specific routes for GET, PUT, DELETE by id

Issue ticket number and link

[ Insert Link & Ticket #]

Checklist before requesting a review

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
This change requires a documentation update

+ Created given folder structure, unsure about use case + Created items.ts in services for generic services similar to the demo + route.ts mimics demo routing for cleaner API management + multiple schemas to enforce typing in items Next steps: - Create id specific routes for GET, PUT, DELETE by id

+ Added GET, PUT, DELETE by id

arnavjk007

Lots of error handling cases + GET filtering & pagination changes

app/api/inventory/[id]/route.ts

arnavjk007 · 2026-02-17T00:32:35Z

app/api/inventory/[id]/route.ts

+        return NextResponse.json({ message: "Invalid id" }, { status: 400 });
+    }
+
+    const updateData = await request.json();


Let's use zod schema to validate that the item to be updated is being updated with a valid schema so something like this:

const updateSchema = z.object({
name: z.string().optional(),
quantity: z.number().min(0).optional(),
threshold: z
.object({
minQuantity: z.number().min(0),
enabled: z.boolean(),
})
.optional(),
});

How strict should the schema validation be? For example should we include all items like category and event as well?

app/api/inventory/[id]/route.ts

services/items.ts

app/api/inventory/route.ts

+ Added exception handling to services and APIs + Adjusted typing to handle ItemInput (DB) vs Item (query) Next steps: - Implement pagination and search queries

arnavjk007

FilteredGet needs to be implemented so users can query by item name. Moved DB connection from services to route files. Some other nit comments

app/api/inventory/route.ts

arnavjk007 · 2026-02-24T03:30:05Z

app/api/inventory/[id]/route.ts


 // GET: fetch single item by id
+// TODO ** try catch
 export async function GET(_: Request, { params }: { params: { id: string } }) {


We should connectToDB here instead of in services for consistency across all our services. We used a cached conn from:

import { connectToDatabase } from "@/lib/mongoose";

Put this before calling the services functions
try {
await connectToDatabase();
} catch {
return NextResponse.json(
{ success: false, message: "Error connecting to database." },
{ status: 500 }
);
}

arnavjk007 · 2026-02-24T03:34:19Z

app/api/inventory/route.ts


 // GET: fetch all items
+// implement page, limit, labid search params
 export async function GET() {


Same thing, lets do the try catch with connectToDB before thsi try catch in all functs

This should also be filtered like they should be able to get by item name as well

app/api/inventory/route.ts

arnavjk007 · 2026-02-24T03:39:25Z

models/Item.ts

@@ -1 +1 @@
 import {


Will also have to add indexes on item name so we can query using that for th filtered get

arnavjk007 · 2026-02-24T03:39:57Z

services/items.ts

+// TODO ** Paginate and limit to 10 per page
+// Build query with filters
 export async function getItems(): Promise<Item[]> {
    await connectToDatabase();


remove this since it will be in the route files

arnavjk007 · 2026-02-24T03:40:06Z

services/items.ts

+// Build query with filters
 export async function getItems(): Promise<Item[]> {
    await connectToDatabase();
    const items = await ItemModel.find().exec();


also have .lean()

arnavjk007 · 2026-02-24T03:41:19Z

services/items.ts

+
+    return toItem(item);
 }



Add get filteredItems for querying by item id + pagination

services/items.ts

+ General route.ts no longer uses a cached connection. Also returns NextResponse upon failed connection attempt. + GET and POST now use new connection attempt + POST utilizes safeParse instead of parse to validate body with schema. + Model exports cleaned up and condensed. + Services no longer attempt to connect to database + Comment descriptor for each method + Methods no longer throw errors, now simply return null upon nonexistent item Next steps: - implement getFiltered service and API - fix id specific routing

arnavjk007

Comments about usage of connect. We only have to do await connect() and dont need to return anything. Also some comments aren't addressed likek using .lean when using .exec

arnavjk007 · 2026-02-26T05:54:38Z

app/api/inventory/route.ts

+    const connectionResponse = await connect();
+    if (connectionResponse) {
+        return connectionResponse;
+    }


Not really sure what this is doing, we only have to await connect() here...

+ Created filteredGet in services + Implemented .lean() so services return plain objects rather than documents + Proper item update is enforced with Zod schema

arnavjk007

connectToDatabase() should be moved to route files. I put a comment on what it shoudl look like. Also, please add unit testing that mocks DB calls to make sure our functions work. You can create a tests folder in each directory with your files like api/inventory/tests/ and in there you will have tests that test all route files.

Also you should change the name of the route.ts pathway since it is app/api/demo/rout.ts, it shouldn't be demo.

arnavjk007 · 2026-03-02T07:26:12Z

services/items.ts

+ * @returns filtered items in the form of a JS object
+ */
+export async function filteredGet(options: getItemOptions) {
+    await connectToDatabase();


All DB connections should be done in route files through a try catch like this

try {
await connectToDatabase();
} catch {
return NextResponse.json(
{ success: false, message: "Error connecting to database." },
{ status: 500 }
);
}

davdwan21 added 3 commits February 14, 2026 11:32

Implemented APIs for id specific requests

4174824

+ Added GET, PUT, DELETE by id

DELETE may be unsafe

546df81

davdwan21 self-assigned this Feb 15, 2026

davdwan21 requested a review from arnavjk007 as a code owner February 15, 2026 19:20

arnavjk007 requested changes Feb 17, 2026

View reviewed changes

Exception handling and DB - item linkage

bf5de36

+ Added exception handling to services and APIs + Adjusted typing to handle ItemInput (DB) vs Item (query) Next steps: - Implement pagination and search queries

arnavjk007 requested changes Feb 24, 2026

View reviewed changes

arnavjk007 requested changes Feb 26, 2026

View reviewed changes

filteredGet, lean, and schema enforcement

f471bb9

+ Created filteredGet in services + Implemented .lean() so services return plain objects rather than documents + Proper item update is enforced with Zod schema

arnavjk007 requested changes Mar 2, 2026

View reviewed changes

Conversation

davdwan21 commented Feb 15, 2026

Describe your changes

Issue ticket number and link

Checklist before requesting a review

Uh oh!

arnavjk007 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

arnavjk007 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

arnavjk007 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arnavjk007 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants