Merge pull request #55 from pennlabs/james/optional-description

make description optional

Author: jamesdoh0109

frontend/components/listings/detail/ListingInfo.tsx

@@ -8,7 +8,7 @@ import { formatDate } from "@/lib/utils";
 interface Props {
   title: string;
   price: number;
-  description: string;
+  description?: string;
   category?: string;
   condition?: string;
   priceLabel?: string;
@@ -19,6 +19,7 @@ interface Props {
 }
 
 const MAX_DESCRIPTION_LENGTH = 250;
+const NO_DESCRIPTION = "No description";
 
 export const ListingInfo = ({
   title,
@@ -33,11 +34,13 @@ export const ListingInfo = ({
   end_date,
 }: Props) => {
   const [isExpanded, setIsExpanded] = useState(false);
-  const shouldTruncate = description.length > MAX_DESCRIPTION_LENGTH;
+  const hasDescription = description && description.trim().length > 0;
+  const descriptionText = hasDescription ? description : NO_DESCRIPTION;
+  const shouldTruncate = hasDescription && descriptionText.length > MAX_DESCRIPTION_LENGTH;
   const displayDescription =
     !shouldTruncate || isExpanded
-      ? description
-      : `${description.slice(0, MAX_DESCRIPTION_LENGTH)}...`;
+      ? descriptionText
+      : `${descriptionText.slice(0, MAX_DESCRIPTION_LENGTH)}...`;
 
   return (
     <div className="space-y-3">

frontend/components/listings/form/BaseListingForm.tsx

@@ -135,7 +135,7 @@ export const BaseListingForm = <T extends BaseCreatePayload>({
           >
             <Textarea
               {...field}
-              placeholder={`Enter ${displayLabel} Description`}
+              placeholder={`Enter description (optional)`}
               className="min-h-[120px] resize-y"
               aria-invalid={!!errors.description}
               disabled={disabled}

frontend/lib/types.ts

@@ -145,7 +145,7 @@ export type ListingFiltersMap = {
 // ------------------------------------------------------------
 export type BaseCreatePayload = {
   title: string;
-  description: string;
+  description?: string;
   price: string;
 };
 

frontend/lib/validations.ts

@@ -101,8 +101,8 @@ export const createItemSchema = z.object({
   description: z
     .string()
     .trim()
-    .min(1, "Description is required")
-    .max(5000, "Description must be less than 5000 characters"),
+    .max(5000, "Description must be less than 5000 characters")
+    .optional(),
   price: priceSchema,
   tags: z.array(z.string().trim()),
   condition: z.enum(itemConditionValues, "Condition is required"),
@@ -121,8 +121,8 @@ export const createSubletSchema = z
     description: z
       .string()
       .trim()
-      .min(1, "Description is required")
-      .max(5000, "Description must be less than 5000 characters"),
+      .max(5000, "Description must be less than 5000 characters")
+      .optional(),
     price: priceSchema,
     tags: z.array(z.string().trim()),
     street_address: z.string().trim().min(1, "Street address is required"),