database-ai.dto.ts

database-ai.dto.tsapps/api/src/modules/ai/database-ai.dto.tsraw ← ai2,226 B← Back to the app
1/**
2 * TASK-0124 — Database AI DTOs (zod; validated by `ZodValidate`).
3 *
4 * Limits (spec §Requirements / §Security): extract text ≤ 50k chars (413),
5 * ≤200 records (422), ≤10 sample records (422), ≤5 sample formula rows (422),
6 * description ≤ 500 chars. The heavy structural validation of the MODEL's tool
7 * call lives in `db-prompts.ts` (shared with the `@factory/ai` zod schemas);
8 * these DTOs gate the CLIENT request only.
9 */
10import { z } from "zod";
11 
12import { DB_EXTRACT_MAX_TEXT_CHARS, DB_GEN_MAX_SAMPLE_RECORDS, DB_FORMULA_MAX_SAMPLE_ROWS } from "@factory/ai";
13 
14/** Generate a database from a prompt (SSE). */
15export const AiGenerateDatabaseDto = z.object({
16  /** The user's free-form description of the database to create. */
17  prompt: z.string().trim().min(1).max(2000),
18  /** The parent page to nest the new database under (optional). */
19  parentId: z.string().min(1).optional(),
20});
21export type AiGenerateDatabaseInput = z.infer<typeof AiGenerateDatabaseDto>;
22 
23/** Extract records from pasted text/markdown into an existing database (SSE). */
24export const AiExtractDto = z.object({
25  databaseId: z.string().min(1),
26  /** Pasted text or a markdown table (≤ 50k chars — the 413 cap). */
27  text: z.string().min(1).max(DB_EXTRACT_MAX_TEXT_CHARS),
28});
29export type AiExtractInput = z.infer<typeof AiExtractDto>;
30 
31/** Extract mapping dry-run (JSON, no write). */
32export const AiExtractPreviewDto = z.object({
33  databaseId: z.string().min(1),
34  text: z.string().min(1).max(DB_EXTRACT_MAX_TEXT_CHARS),
35});
36export type AiExtractPreviewInput = z.infer<typeof AiExtractPreviewDto>;
37 
38/** Generate a formula from a description (JSON, non-streamed). */
39export const AiGenerateFormulaDto = z.object({
40  databaseId: z.string().min(1),
41  description: z.string().trim().min(1).max(500),
42  /** The column name for the formula property (defaults to a derived name). */
43  name: z.string().trim().min(1).max(100).optional(),
44  /** Evaluate (and return) on these specific records (≤ 5; default = first 5). */
45  sampleRowIds: z.array(z.string().min(1)).max(DB_FORMULA_MAX_SAMPLE_ROWS).optional(),
46});
47export type AiGenerateFormulaInput = z.infer<typeof AiGenerateFormulaDto>;
48 
49export { DB_GEN_MAX_SAMPLE_RECORDS };
50