dto.ts · Source

dto.tsapps/api/src/modules/files/dto.tsraw ← files3,916 B← Back to the app
1import { z } from "zod";
2 
3/**
4 * TASK-0101/0103 — file module DTOs (zod, validated by ZodValidate).
5 *
6 * The upload-session body carries NO workspaceId: the workspace comes from
7 * the `x-factory-workspace` header (the global guard's context), the same
8 * way pages/blocks do. `replaceFileId` (TASK-0104) makes the session a new
9 * version of an existing file instead of a fresh one.
10 */
11 
12export const CreateUploadDto = z.object({
13  name: z.string().min(1).max(512),
14  /** No upper bound here: the PLAN limit (free 50 MB / paid 500 MB, min
15   *  with the 500 MB hard ceiling) is enforced server-side with 413
16   *  FILE_TOO_LARGE — a 400 would misreport a plan boundary as a format
17   *  error (spec TASK-0101: the limit is in the 413 body). */
18  size: z.number().int().positive(),
19  mimeType: z.string().min(1).max(200),
20  // `null` === "not attached to a page/block" — the web client always sends
21  // these fields (defaulting to null, see lib/files/upload.ts), so the schema
22  // must accept the explicit null, not just omit the key. `string | undefined`
23  // input is unchanged (backward compatible: existing callers omit or send a
24  // real id).
25  pageId: z.string().min(1).nullable().optional(),
26  blockId: z.string().min(1).nullable().optional(),
27  /** TASK-0104: re-upload → new version of this existing file (accepted
28   *  here; the versioning semantics land with TASK-0104). */
29  replaceFileId: z.string().min(1).nullable().optional(),
30});
31export type CreateUploadInput = z.infer<typeof CreateUploadDto>;
32 
33/** `PUT /files/uploads/:id/complete` — the server re-checks from S3; the
34 *  body is advisory only (kept for future checksums). */
35export const CompleteUploadDto = z
36  .object({
37    sha256: z.string().regex(/^[0-9a-f]{64}$/).optional(),
38  })
39  .optional()
40  .default({});
41export type CompleteUploadInput = z.infer<typeof CompleteUploadDto>;
42 
43export const CancelUploadDto = z.object({}).optional().default({});
44export type CancelUploadInput = z.infer<typeof CancelUploadDto>;
45 
46/** `GET /files?scope=page|workspace&pageId=&kind=&status=&cursor=` (TASK-0103). */
47export const ListFilesQuery = z.object({
48  scope: z.enum(["page", "workspace"]).default("workspace"),
49  pageId: z.string().min(1).optional(),
50  kind: z.enum(["image", "video", "audio", "pdf", "doc", "other"]).optional(),
51  status: z
52    .enum(["UPLOADING", "SCANNING", "READY", "VIRUS_DETECTED", "FAILED"])
53    .optional(),
54  search: z.string().max(200).optional(),
55  sort: z.enum(["name", "size", "date", "updated"]).default("updated"),
56  cursor: z.string().optional(),
57  limit: z.coerce.number().int().min(1).max(100).default(50),
58});
59export type ListFilesInput = z.infer<typeof ListFilesQuery>;
60 
61export const RenameFileDto = z.object({ name: z.string().min(1).max(512) });
62export type RenameFileInput = z.infer<typeof RenameFileDto>;
63 
64// ── TASK-0104: versions / permissions ────────────────────────────────────────
65 
66/** `POST /files/:id/rollback` — make version n current (key swap). */
67export const RollbackFileDto = z.object({
68  version: z.number().int().positive().max(10_000),
69});
70export type RollbackFileInput = z.infer<typeof RollbackFileDto>;
71 
72/** One file-level permission grant (explicit; NONE = explicit deny). */
73export const FilePermissionGrantDto = z.object({
74  granteeType: z.enum(["user", "team", "role"]),
75  /** userId | teamId | role name ("OWNER"|"ADMIN"|"MEMBER"|"GUEST"). */
76  granteeId: z.string().min(1).max(128),
77  /** NONE is an EXPLICIT DENY (overrides inheritance/role) — TASK-0104 §2. */
78  level: z.enum(["NONE", "VIEW", "COMMENT", "EDIT", "FULL_ACCESS"]),
79});
80 
81/** `PUT /files/:id/permissions` — REPLACE the file's explicit grants. */
82export const SetPermissionsDto = z.object({
83  grants: z.array(FilePermissionGrantDto).max(200),
84});
85export type SetPermissionsInput = z.infer<typeof SetPermissionsDto>;
86