dto.ts · Source

dto.tsapps/api/src/modules/tasks/dto.tsraw ← tasks3,496 B← Back to the app
1/**
2 * T-159…T-161 — Task DTOs (Zod, validated by the global ZodValidate pipe).
3 *
4 * A Task is a 1:1 sidecar of a `pages.kind='task'` page (A-006): the page
5 * carries the blocks/comments/permissions tree; the sidecar carries the
6 * queryable task fields (status/due/assignees). `assigneeIds` uses Prisma's
7 * `String[]` — the API exposes it as a JSON array (additive-only, no new
8 * column types).
9 */
10import { z } from "zod";
11 
12/** Task status machine (T-159): todo | in_progress | done | cancelled. */
13export const TASK_STATUSES = ["todo", "in_progress", "done", "cancelled"] as const;
14export type TaskStatus = (typeof TASK_STATUSES)[number];
15 
16/**
17 * Legal transitions (T-160's "inbox" semantics lean on this; enforced in the
18 * service — an illegal transition is 400, not a silent overwrite).
19 *   todo        → in_progress | done | cancelled
20 *   in_progress → done | cancelled | todo
21 *   done        → in_progress            (re-open)
22 *   cancelled   → todo                   (re-open)
23 */
24export const TASK_TRANSITIONS: Record<TaskStatus, TaskStatus[]> = {
25  todo: ["in_progress", "done", "cancelled"],
26  in_progress: ["done", "cancelled", "todo"],
27  done: ["in_progress"],
28  cancelled: ["todo"]
29};
30 
31/** `GET /workspaces/:workspaceId/tasks` — inbox + filters. */
32export const ListTasksQuery = z.object({
33  /** `inbox` = tasks where the CALLER is an assignee (the default); `all` = every task in the workspace. */
34  scope: z.enum(["inbox", "all"]).default("inbox"),
35  status: z.enum(TASK_STATUSES).optional(),
36  /** due before this ISO date (overdue tab). */
37  dueBefore: z.string().datetime({ offset: true }).optional(),
38  /** due after this ISO date. */
39  dueAfter: z.string().datetime({ offset: true }).optional(),
40  /** calendar tab: tasks whose dueAt falls in [monthStart, monthEnd) UTC. */
41  month: z
42    .string()
43    .regex(/^\d{4}-(0[1-9]|1[0-2])$/, "month must be YYYY-MM")
44    .optional(),
45  /** overdue = dueAt < now && status not in (done, cancelled). Shorthand for the client. */
46  overdue: z.coerce.boolean().optional(),
47  cursor: z.string().optional(),
48  limit: z.coerce.number().int().min(1).max(100).default(50)
49});
50export type ListTasksQueryInput = z.infer<typeof ListTasksQuery>;
51 
52/** `POST /workspaces/:workspaceId/tasks` — create a task page + sidecar. */
53export const CreateTaskDto = z.object({
54  title: z.string().min(1).max(500),
55  parentId: z.string().min(1).optional(),
56  status: z.enum(TASK_STATUSES).default("todo"),
57  dueAt: z.string().datetime({ offset: true }).nullable().optional(),
58  assigneeIds: z.array(z.string().min(1)).max(50).default([])
59});
60export type CreateTaskInput = z.infer<typeof CreateTaskDto>;
61 
62/** `PATCH /tasks/:id` — partial update of the sidecar fields. */
63export const UpdateTaskDto = z
64  .object({
65    title: z.string().min(1).max(500).optional(),
66    status: z.enum(TASK_STATUSES).optional(),
67    dueAt: z.string().datetime({ offset: true }).nullable().optional(),
68    /**
69     * Assignees: an ARRAY replaces the whole list (the client sends the full
70     * set); `null` clears it. Individual user add/remove is a convenience
71     * `addAssignee`/`removeAssignee` pair of single-element patches — but the
72     * canonical wire shape is the full list (matches Prisma `String[]`).
73     */
74    assigneeIds: z.array(z.string().min(1)).max(50).nullable().optional()
75  })
76  .refine((v) => Object.keys(v).length > 0, { message: "No fields to update" });
77export type UpdateTaskInput = z.infer<typeof UpdateTaskDto>;
78