Add create APIs for categories and tasks by gentamura · Pull Request #9 · listee-dev/listee-libs

gentamura · 2025-10-20T05:18:43Z

Summary by CodeRabbit

New Features
- Added endpoints to create categories and to create tasks within categories; both require authentication, enforce ownership, and validate payloads. Task creation verifies the target category exists and returns clear error responses for missing/invalid resources.
Tests
- Expanded fixtures and test coverage to exercise category and task creation flows, including endpoint-level integration scenarios.

coderabbitai · 2025-10-20T05:19:53Z

Walkthrough

Adds create operations for categories and tasks across tests, queries, services, repositories, routes, and types; introduces payload validation helpers and request validation; forwards categoryQueries into task route registration; adds POST endpoints for creating categories and tasks with error mapping and tests exercising creation flows.

Changes

Cohort / File(s)	Summary
Types `packages/types/src/api.ts`	Added `CreateCategoryParams`, `CreateTaskParams`, repository param types; added `create` method signatures to `CategoryQueries`, `TaskQueries`, `CategoryRepository`, `TaskRepository`, `CategoryService`, `TaskService`; extended `RegisterTaskRoutesOptions` and `AppDependencies` with `categoryQueries`.
Repository Layer `packages/api/src/repositories/category-repository.ts`, `packages/api/src/repositories/task-repository.ts`	Added `create` methods that INSERT records and return created rows; introduced `Create*RepositoryParams` imports; error handling when insertion yields no row.
Service Layer `packages/api/src/services/category-service.ts`, `packages/api/src/services/task-service.ts`	Added `create` methods delegating to repositories; task service validates category existence and throws `"Category not found"` when missing.
Query Layer `packages/api/src/queries/category-queries.ts`, `packages/api/src/queries/task-queries.ts`	Exposed `create` methods that delegate to service layer; imported `Create*Params` types.
Routes `packages/api/src/routes/categories.ts`, `packages/api/src/routes/tasks.ts`	Added POST `/users/:userId/categories` and POST `/categories/:categoryId/tasks` routes with auth, user-scope checks, JSON parsing, payload validation, category existence check (via `categoryQueries`), and error mapping (400/401/403/404/500).
Validation Utilities `packages/api/src/utils/validation.ts`	Added `isRecord`, `isNonEmptyString`, and `isBoolean` type-guard utilities used by route payload parsers.
App Boot & Tests `packages/api/src/app.ts`, `packages/api/src/app.test.ts`	Forwarded `categoryQueries` into task route registration; test fixtures extended with `createCategoryQueries`/`createTaskQueries`, `nextCategoryId`/`nextTaskId` counters, and helpers to create categories/tasks; added tests for POST creation endpoints.
DB Index Import `packages/db/src/index.ts`	Added `fileURLToPath` import from `node:url` — no behavior change.

Sequence Diagram(s)

%%{init: {"themeVariables":{"sequenceActorFill":"#E8F7E7","signalColor":"#7AA2F7","actorBorder":"#7A7A7A"}} }%%
sequenceDiagram
    actor Client
    participant Routes as Routes
    participant Q as Queries
    participant S as Services
    participant R as Repositories
    participant DB as Database

    Client->>Routes: POST /users/:userId/categories (name, kind)
    Routes->>Routes: auth & user-scope check
    Routes->>Routes: parse & validate payload
    Routes->>Q: Q.create({ userId, name, kind })
    Q->>S: S.create(params)
    S->>R: R.create(params)
    R->>DB: INSERT category
    DB-->>R: row
    R-->>S: Category
    S-->>Q: Category
    Q-->>Routes: 201 + Category
    Routes-->>Client: 201 + Category

    rect rgba(122,162,247,0.06)
    Client->>Routes: POST /categories/:categoryId/tasks (name, description, isChecked)
    Routes->>Routes: auth check
    Routes->>Q: categoryQueries.findById(categoryId, userId)
    alt category exists
        Routes->>Routes: parse & validate task payload
        Routes->>Q: Q.create({ categoryId, userId, ...payload })
        Q->>S: S.create(params)
        S->>R: R.create(params)
        R->>DB: INSERT task
        DB-->>R: row
        R-->>S: Task
        S-->>Q: Task
        Q-->>Routes: 201 + Task
        Routes-->>Client: 201 + Task
    else category missing
        Q-->>Routes: null
        Routes-->>Client: 404
    end
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Refine auth, database, and CI scaffolding #2: Adds/extends API scaffolding (routes, services, repositories, queries) that this change further implements with create operations and POST routes.
Add turbo build orchestration and dist manifest tooling #6: Modifies repository implementations for categories/tasks; changes overlap with new repository create methods introduced here.

Poem

🐰 I nibble at code and plant a seed,
New categories, tasks — sprout at speed,
Routes with checks, validations true,
From query to DB — fresh things grew! 🌱

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Add create APIs for categories and tasks" directly and accurately reflects the main changes in the changeset. The PR implements comprehensive creation functionality across multiple layers: API routes (POST /users/:userId/categories and POST /categories/:categoryId/tasks), service layers (CategoryService.create and TaskService.create), repository layers (CategoryRepository.create and TaskRepository.create), and query layers (CategoryQueries.create and TaskQueries.create). The title is specific and clear about what is being added and which entities are affected, making it immediately understandable to someone reviewing the commit history.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feature-add-create-apis

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c52727d and 877a15a.

📒 Files selected for processing (1)

packages/db/src/index.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

packages/db/src/index.ts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

packages/api/src/app.test.ts (1)

1-1: Fix formatting issue.

The pipeline indicates that the file content differs from the expected formatting output. Please run the formatter to resolve this.

🧹 Nitpick comments (4)

packages/api/src/utils/validation.ts (2)
1-3: Consider explicitly rejecting arrays.

The current implementation allows arrays to pass since typeof [] === "object". While this is safe (arrays would fail subsequent property validation), being more explicit improves clarity.

Apply this diff for stricter validation:
 export function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null;
+  return typeof value === "object" && value !== null && !Array.isArray(value);
 }
13-15: Prefer typeof for boolean checks.

Using literal comparison works but typeof is more idiomatic for type guards.

Apply this diff:
 export function isBoolean(value: unknown): value is boolean {
-  return value === true || value === false;
+  return typeof value === "boolean";
 }
packages/api/src/routes/tasks.ts (2)
25-58: Consider normalizing empty descriptions to null.

The validation correctly trims the description, but empty strings are preserved rather than converted to null. If an empty string "" is provided, it remains "" after trimming.

Consider whether empty or whitespace-only descriptions should be normalized to null for consistency:
  const description =
-    typeof descriptionValue === "string" ? descriptionValue.trim() : null;
+    typeof descriptionValue === "string" 
+      ? descriptionValue.trim() || null 
+      : null;
This would ensure that empty strings are treated the same as absent descriptions.

139-148: Consider removing optional category validation from the route.

The route performs an optional category existence check only when categoryQueries is provided. However, this validation is duplicated by the service layer (caught at lines 173-175 as "Category not found").

As per coding guidelines, routes should "delegate exclusively to queries and handle HTTP translation/status; avoid business logic in routes." The category existence check could be considered business logic and should be handled consistently in the service/query layer rather than optionally in the route.

Consider either:

Remove this route-level check and rely solely on the service layer validation

Make category validation mandatory by requiring categoryQueries in the route setup

This would simplify the route and maintain clearer separation of concerns.

Based on coding guidelines

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 882fd0b and 1e72009.

📒 Files selected for processing (12)

packages/api/src/app.test.ts (12 hunks)
packages/api/src/app.ts (1 hunks)
packages/api/src/queries/category-queries.ts (2 hunks)
packages/api/src/queries/task-queries.ts (2 hunks)
packages/api/src/repositories/category-repository.ts (2 hunks)
packages/api/src/repositories/task-repository.ts (2 hunks)
packages/api/src/routes/categories.ts (3 hunks)
packages/api/src/routes/tasks.ts (4 hunks)
packages/api/src/services/category-service.ts (2 hunks)
packages/api/src/services/task-service.ts (2 hunks)
packages/api/src/utils/validation.ts (1 hunks)
packages/types/src/api.ts (5 hunks)

🧰 Additional context used

📓 Path-based instructions (7)

packages/*/src/**/*.{ts,tsx}