Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.
refactor: create common zod schema for faqs
Marc Seitzd7309cb7af8d
diff --git a/ee/features/conversations/api/team-faqs-route.ts b/ee/features/conversations/api/team-faqs-route.tsindex d25ac4d7..3cf8d059 100644--- a/ee/features/conversations/api/team-faqs-route.ts+++ b/ee/features/conversations/api/team-faqs-route.ts@@ -1,83 +1,18 @@import { NextApiRequest, NextApiResponse } from "next";+import {+ PublishFAQInput,+ faqParamSchema,+ publishFAQSchema,+ updateFAQSchema,+} from "@/ee/features/conversations/lib/schemas/faq";import { authOptions } from "@/pages/api/auth/[...nextauth]";import { getServerSession } from "next-auth/next";-import { z } from "zod";import prisma from "@/lib/prisma";import { CustomUser } from "@/lib/types";import { validateContent } from "@/lib/utils/sanitize-html";-// Zod validation schemas-const paramSchema = z.object({- teamId: z.string().cuid("Invalid team ID format"),- id: z.string().cuid("Invalid dataroom ID format"),- faqId: z.string().cuid("Invalid FAQ ID format").optional(),-});--const publishFAQSchema = z.object({- editedQuestion: z- .string()- .min(10, "Question must be at least 10 characters")- .max(1000, "Question too long"),- originalQuestion: z.string().optional(),- answer: z- .string()- .min(10, "Answer must be at least 10 characters")- .max(2000, "Answer too long"),- visibilityMode: z.enum(["PUBLIC_DATAROOM", "PUBLIC_LINK", "PUBLIC_DOCUMENT"]),- linkId: z.string().cuid("Invalid link ID format").optional(),- dataroomDocumentId: z.string().cuid("Invalid document ID format").optional(),- sourceConversationId: z- .string()- .cuid("Invalid conversation ID format")- .optional(),- questionMessageId: z- .string()- .cuid("Invalid question message ID format")- .optional(),- answerMessageId: z- .string()- .cuid("Invalid answer message ID format")- .optional(),- isAnonymized: z.boolean().default(true),- documentPageNumber: z.number().int().min(1).optional(),- documentVersionNumber: z.number().int().min(1).optional(),-});--const updateFAQSchema = z.object({- editedQuestion: z- .string()- .min(10, "Question must be at least 10 characters")- .max(1000, "Question too long")- .optional(),- answer: z- .string()- .min(10, "Answer must be at least 10 characters")- .max(2000, "Answer too long")- .optional(),- visibilityMode: z- .enum(["PUBLIC_DATAROOM", "PUBLIC_LINK", "PUBLIC_DOCUMENT"])- .optional(),- status: z.enum(["DRAFT", "PUBLISHED", "ARCHIVED"]).optional(),-});--export interface PublishFAQInput {- editedQuestion: string;- originalQuestion?: string;- answer: string;- linkId?: string;- dataroomDocumentId?: string;- sourceConversationId?: string;- questionMessageId?: string;- answerMessageId?: string;- visibilityMode: "PUBLIC_DATAROOM" | "PUBLIC_LINK" | "PUBLIC_DOCUMENT";- status?: "DRAFT" | "PUBLISHED" | "ARCHIVED";- isAnonymized?: boolean;- documentPageNumber?: number;- documentVersionNumber?: number;-}-// Route mapping object to handle different pathsconst routeHandlers = {// POST /api/teams/[teamId]/datarooms/[dataroomId]/faqs@@ -89,7 +24,7 @@ const routeHandlers = {try {// Validate URL parameters- const paramValidation = paramSchema.safeParse({+ const paramValidation = faqParamSchema.safeParse({teamId: req.query.teamId,id: req.query.id,});@@ -272,7 +207,7 @@ const routeHandlers = {try {// Validate URL parameters- const paramValidation = paramSchema.safeParse({+ const paramValidation = faqParamSchema.safeParse({teamId: req.query.teamId,id: req.query.id,});@@ -357,7 +292,7 @@ const routeHandlers = {try {// Validate URL parameters- const paramValidation = paramSchema.safeParse({+ const paramValidation = faqParamSchema.safeParse({teamId: req.query.teamId,id: req.query.id,faqId: req.query.faqId,@@ -453,7 +388,7 @@ const routeHandlers = {try {// Validate URL parameters- const paramValidation = paramSchema.safeParse({+ const paramValidation = faqParamSchema.safeParse({teamId: req.query.teamId,id: req.query.id,faqId: req.query.faqId,diff --git a/ee/features/conversations/components/dashboard/edit-faq-modal.tsx b/ee/features/conversations/components/dashboard/edit-faq-modal.tsxindex 71503a0b..da061cf0 100644--- a/ee/features/conversations/components/dashboard/edit-faq-modal.tsx+++ b/ee/features/conversations/components/dashboard/edit-faq-modal.tsx@@ -1,8 +1,11 @@import React, { useEffect, useState } from "react";+import {+ editFAQFormSchema,+ faqParamSchema,+} from "@/ee/features/conversations/lib/schemas/faq";import { BookOpen, Check, FileText, Link2 } from "lucide-react";import { toast } from "sonner";-import { z } from "zod";import { Button } from "@/components/ui/button";import {@@ -25,25 +28,6 @@ import { Textarea } from "@/components/ui/textarea";import { PublishedFAQ } from "../../pages/faq-overview";-// Frontend validation schemas-const editFAQFormSchema = z.object({- editedQuestion: z- .string()- .min(10, "Question must be at least 10 characters")- .max(1000, "Question too long"),- answer: z- .string()- .min(10, "Answer must be at least 10 characters")- .max(2000, "Answer too long"),- visibilityMode: z.enum(["PUBLIC_DATAROOM", "PUBLIC_LINK", "PUBLIC_DOCUMENT"]),-});--const apiParamSchema = z.object({- teamId: z.string().cuid("Invalid team ID"),- dataroomId: z.string().cuid("Invalid dataroom ID"),- faqId: z.string().cuid("Invalid FAQ ID"),-});-interface EditFAQModalProps {faq: PublishedFAQ;dataroomId: string;@@ -118,9 +102,9 @@ export function EditFAQModal({try {// Validate API parameters- const paramValidation = apiParamSchema.safeParse({+ const paramValidation = faqParamSchema.safeParse({teamId,- dataroomId,+ id: dataroomId,faqId: faq.id,});@@ -142,7 +126,7 @@ export function EditFAQModal({const validatedData = formValidation.data;const response = await fetch(- `/api/teams/${paramValidation.data.teamId}/datarooms/${paramValidation.data.dataroomId}/faqs/${paramValidation.data.faqId}`,+ `/api/teams/${paramValidation.data.teamId}/datarooms/${paramValidation.data.id}/faqs/${paramValidation.data.faqId}`,{method: "PUT",headers: {diff --git a/ee/features/conversations/components/dashboard/publish-faq-modal.tsx b/ee/features/conversations/components/dashboard/publish-faq-modal.tsxindex 08b00f21..8dbd6dc0 100644--- a/ee/features/conversations/components/dashboard/publish-faq-modal.tsx+++ b/ee/features/conversations/components/dashboard/publish-faq-modal.tsx@@ -1,8 +1,11 @@import React, { useState } from "react";+import {+ faqParamSchema,+ publishFAQFormSchema,+} from "@/ee/features/conversations/lib/schemas/faq";import { BookOpen, Check, FileText, Link2 } from "lucide-react";import { toast } from "sonner";-import { z } from "zod";import { Button } from "@/components/ui/button";import {@@ -23,26 +26,6 @@ import {} from "@/components/ui/select";import { Textarea } from "@/components/ui/textarea";-// Frontend validation schemas-const publishFAQFormSchema = z.object({- editedQuestion: z- .string()- .min(10, "Question must be at least 10 characters")- .max(1000, "Question too long"),- answer: z- .string()- .min(10, "Answer must be at least 10 characters")- .max(2000, "Answer too long"),- visibilityMode: z.enum(["PUBLIC_DATAROOM", "PUBLIC_LINK", "PUBLIC_DOCUMENT"]),- questionMessageId: z.string().cuid("Invalid question message ID"),- answerMessageId: z.string().cuid("Invalid answer message ID"),-});--const apiParamSchema = z.object({- teamId: z.string().cuid("Invalid team ID"),- dataroomId: z.string().cuid("Invalid dataroom ID"),-});-interface Message {id: string;content: string;@@ -161,9 +144,9 @@ export function PublishFAQModal({try {// Validate API parameters- const paramValidation = apiParamSchema.safeParse({+ const paramValidation = faqParamSchema.safeParse({teamId,- dataroomId,+ id: dataroomId,});if (!paramValidation.success) {@@ -194,13 +177,16 @@ export function PublishFAQModal({sourceConversationId: conversation.id,linkId: conversation.linkId,dataroomDocumentId: conversation.dataroomDocument?.id || null,+ ...(conversation.dataroomDocument?.id+ ? { dataroomDocumentId: conversation.dataroomDocument.id }+ : {}),isAnonymized: true, // Always anonymize published FAQsquestionMessageId: validatedData.questionMessageId,answerMessageId: validatedData.answerMessageId,};const response = await fetch(- `/api/teams/${paramValidation.data.teamId}/datarooms/${paramValidation.data.dataroomId}/faqs`,+ `/api/teams/${paramValidation.data.teamId}/datarooms/${paramValidation.data.id}/faqs`,{method: "POST",headers: {diff --git a/ee/features/conversations/lib/schemas/faq.ts b/ee/features/conversations/lib/schemas/faq.tsnew file mode 100644index 00000000..9db3edcd--- /dev/null+++ b/ee/features/conversations/lib/schemas/faq.ts@@ -0,0 +1,76 @@+import { z } from "zod";++// Base FAQ schema with core validation rules+const baseFAQSchema = z.object({+ editedQuestion: z+ .string()+ .min(10, "Question must be at least 10 characters")+ .max(1000, "Question too long"),+ answer: z+ .string()+ .min(10, "Answer must be at least 10 characters")+ .max(2000, "Answer too long"),+ visibilityMode: z.enum(["PUBLIC_DATAROOM", "PUBLIC_LINK", "PUBLIC_DOCUMENT"]),+});++// Schema for publishing a new FAQ+export const publishFAQSchema = baseFAQSchema.extend({+ originalQuestion: z.string().optional(),+ linkId: z.string().cuid("Invalid link ID format").optional(),+ dataroomDocumentId: z.string().cuid("Invalid document ID format").optional(),+ sourceConversationId: z+ .string()+ .cuid("Invalid conversation ID format")+ .optional(),+ questionMessageId: z+ .string()+ .cuid("Invalid question message ID format")+ .optional(),+ answerMessageId: z+ .string()+ .cuid("Invalid answer message ID format")+ .optional(),+ isAnonymized: z.boolean().default(true),+ documentPageNumber: z.number().int().min(1).optional(),+ documentVersionNumber: z.number().int().min(1).optional(),+});++// Schema for updating an existing FAQ (all fields optional except where business logic requires)+export const updateFAQSchema = z.object({+ editedQuestion: z+ .string()+ .min(10, "Question must be at least 10 characters")+ .max(1000, "Question too long")+ .optional(),+ answer: z+ .string()+ .min(10, "Answer must be at least 10 characters")+ .max(2000, "Answer too long")+ .optional(),+ visibilityMode: z+ .enum(["PUBLIC_DATAROOM", "PUBLIC_LINK", "PUBLIC_DOCUMENT"])+ .optional(),+ status: z.enum(["DRAFT", "PUBLISHED", "ARCHIVED"]).optional(),+});++// Frontend form validation schemas+export const publishFAQFormSchema = baseFAQSchema.extend({+ questionMessageId: z.string().cuid("Invalid question message ID"),+ answerMessageId: z.string().cuid("Invalid answer message ID"),+});++export const editFAQFormSchema = baseFAQSchema;++// Parameter validation schemas+export const faqParamSchema = z.object({+ teamId: z.string().cuid("Invalid team ID format"),+ id: z.string().cuid("Invalid dataroom ID format"),+ faqId: z.string().cuid("Invalid FAQ ID format").optional(),+});++// Type exports+export type PublishFAQInput = z.infer<typeof publishFAQSchema>;+export type UpdateFAQInput = z.infer<typeof updateFAQSchema>;+export type PublishFAQFormInput = z.infer<typeof publishFAQFormSchema>;+export type EditFAQFormInput = z.infer<typeof editFAQFormSchema>;+export type FAQParamInput = z.infer<typeof faqParamSchema>;diff --git a/ee/features/conversations/pages/conversation-overview.tsx b/ee/features/conversations/pages/conversation-overview.tsxindex e2e00dce..63650dc4 100644--- a/ee/features/conversations/pages/conversation-overview.tsx+++ b/ee/features/conversations/pages/conversation-overview.tsx@@ -19,6 +19,7 @@ import z from "zod";import { useDataroom } from "@/lib/swr/use-dataroom";import useLimits from "@/lib/swr/use-limits";import { fetcher } from "@/lib/utils";+import { localStorage as safeLocalStorage } from "@/lib/webstorage";import { DataroomHeader } from "@/components/datarooms/dataroom-header";import { DataroomNavigation } from "@/components/datarooms/dataroom-navigation";@@ -37,6 +38,8 @@ import { Input } from "@/components/ui/input";import { ScrollArea } from "@/components/ui/scroll-area";import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs";+import { PublishedFAQ } from "./faq-overview";+export interface ConversationSummary {id: string;title: string | null;@@ -78,7 +81,7 @@ export default function DataroomConversationsPage() {const isBannerDismissed = useMemo(() => {if (!dataroom?.id) return false;return (- localStorage.getItem(+ safeLocalStorage.getItem(`dataroom-${dataroom.id}-conversations-banner-dismissed`,) === "true");