@zyacreatives/shared 2.2.19 → 2.2.21

package/src/schemas/project.ts

@@ -12,116 +12,62 @@ import { ViewEntitySchema } from "./view";
 import { MinimalUserSchema } from "./user";
 import { ActivitySchema } from "./activity";
 
+/**
+ * BASE ENTITY SCHEMAS
+ */
+
 export const ProjectEntitySchema = z
   .object({
-    id: z.string().openapi({
-      description: "CUID2 of the project.",
-      example: "ckl1y9xyz0000qv7a0h1efgh4",
-    }),
-    userId: z.string().openapi({
-      description: "CUID2 of the user who created the project.",
-      example: "ckl1y9xyz0000qv7a0h1efgh4",
-    }),
-    title: z.string().openapi({
-      description: "Title of the project.",
-      example: "E-commerce Mobile App",
-    }),
-    description: z.string().optional().openapi({
-      description: "Detailed description of the project, max 1000 characters.",
-      example:
-        "A modern e-commerce mobile application built with React Native.",
-    }),
-    overview: z.string().optional().openapi({
-      description: "Brief overview of the project.",
-      example: "A comprehensive e-commerce solution for mobile devices.",
-    }),
-    url: z.string().optional().openapi({
-      description: "URL to the project or live demo.",
-      example: "https://example.com/project",
-    }),
-    imagePlaceholderUrl: z.url().openapi({
-      description: "URL for the placeholder image of the project.",
-      example: "https://img.com",
-    }),
-    tags: z
-      .array(z.string())
-      .optional()
-      .openapi({
-        description: "Array of tags associated with the project.",
-        example: ["react-native", "e-commerce", "mobile"],
-      }),
-    projectCreatorType: z.enum(ROLES).openapi({
-      description: "Type of creator who made this project.",
-      example: "CREATIVE",
-    }),
-    clientId: z.string().optional().openapi({
-      description: "CUID2 of the client if this is a client project.",
-      example: "ckl1y9xyz0000qv7a0h1efgh4",
-    }),
+    id: z.cuid2(),
+    userId: z.cuid2(),
+    title: z.string(),
+    description: z.string().optional(),
+    overview: z.string().optional(),
+    url: z.url().optional(),
+    imagePlaceholderUrl: z.url(),
+    tags: z.array(z.string()).optional(),
+    projectCreatorType: z.enum(ROLES),
+    clientId: z.cuid2().optional(),
     status: z.enum(PROJECT_STATUS),
-    clientType: z.enum(CLIENT_TYPES).optional().openapi({
-      description: "Type of client for this project.",
-      example: "BRAND",
-    }),
-    clientName: z.string().optional().openapi({
-      description: "Name of the client.",
-      example: "Acme Corp",
-    }),
-    isFeatured: z.boolean().optional().openapi({
-      description: "Whether the project is featured.",
-      example: true,
-    }),
+    clientType: z.enum(CLIENT_TYPES).optional(),
+    clientName: z.string().optional(),
+    isFeatured: z.boolean().optional(),
     problemBeingSolved: z.string().max(600).optional(),
     whoItsFor: z.string().max(600).optional(),
     ventureStage: z.enum(VENTURE_STAGES).optional(),
     capitalLookingToRaise: z.string(),
     capitalLookingToRaiseCurrency: z.enum(WAGES_CURRENCY).optional(),
     currentTraction: z.string().max(600),
-    startDate: z.coerce
-      .date()
-      .optional()
-      .openapi({
-        description: "Start date of the project.",
-        example: new Date("2024-01-01"),
-      }),
-    endDate: z.coerce
-      .date()
-      .optional()
-      .openapi({
-        description: "End date of the project.",
-        example: new Date("2024-06-30"),
-      }),
-    createdAt: z.coerce.date().openapi({
-      description: "Timestamp when the project was created.",
-      example: new Date("2024-01-01T00:00:00.000Z"),
-    }),
-    updatedAt: z.coerce.date().openapi({
-      description: "Timestamp when the project was last updated.",
-      example: new Date("2024-06-30T00:00:00.000Z"),
-    }),
-    version: z.int(),
+    startDate: z.coerce.date().optional(),
+    endDate: z.coerce.date().optional(),
+    createdAt: z.coerce.date(),
+    updatedAt: z.coerce.date(),
+    version: z.number().int(),
   })
-  .openapi({
-    title: "Project DB Entity",
-    description: "Schema representing a project stored in the database.",
-  });
+  .openapi("ProjectEntity");
+
+export const MinimalProjectSchema = ProjectEntitySchema.pick({
+  id: true,
+  title: true,
+  description: true,
+  tags: true,
+  startDate: true,
+  endDate: true,
+  imagePlaceholderUrl: true,
+}).openapi("MinimalProject");
 
 export const ProjectSocialGraphEntitySchema = z
   .object({
-    noOfLikes: z.number().int().optional().openapi({ example: 150 }),
-    noOfComments: z.number().int().optional().openapi({ example: 45 }),
-    noOfBookmarks: z.number().int().optional().openapi({ example: 22 }),
-    noOfViews: z.number().int().optional().openapi({ example: 1200 }),
+    noOfLikes: z.number().int().optional(),
+    noOfComments: z.number().int().optional(),
+    noOfBookmarks: z.number().int().optional(),
+    noOfViews: z.number().int().optional(),
   })
   .openapi("ProjectSocialGraphEntity");
 
-export const ProjectDetailsEntitySchema = ProjectEntitySchema.extend({
-  user: MinimalUserSchema,
-}).openapi({ title: "ProjectDetailsEntity" });
-
-export const ProjectUpdateOutputEntitySchema = z
-  .object({ id: z.cuid2() })
-  .openapi("ProjectUpdateOutputEntity");
+/**
+ * INPUT SCHEMAS
+ */
 
 export const CreateProjectInputSchema = z
   .object({
@@ -130,10 +76,8 @@ export const CreateProjectInputSchema = z
     description: z.string().max(1000).optional(),
     overview: z.string().optional(),
     status: z.enum(PROJECT_STATUS).default(PROJECT_STATUS.DRAFT),
-
   })
-
-  .openapi({ title: "Create Project" });
+  .openapi("CreateProjectInput");
 
 export const UpdateProjectInputSchema = z
   .object({
@@ -158,91 +102,91 @@ export const UpdateProjectInputSchema = z
     currentTraction: z.string().max(600).optional(),
     startDate: z.coerce.date().optional(),
     endDate: z.coerce.date().optional(),
-    version: z.int(),
+    version: z.number().int(),
   })
   .superRefine(({ startDate, endDate }, ctx) => {
     const today = new Date();
     today.setHours(0, 0, 0, 0);
-    if (!startDate) return;
-    if (startDate > today)
+    if (startDate && startDate > today) {
       ctx.addIssue({
         path: ["startDate"],
         code: "custom",
         message: "Start date cannot be in the future",
       });
-    if (endDate) {
-      if (startDate > endDate)
-        ctx.addIssue({
-          path: ["startDate"],
-          code: "custom",
-          message: "Start date cannot be after end date",
-        });
+    }
+    if (startDate && endDate && startDate > endDate) {
+      ctx.addIssue({
+        path: ["startDate"],
+        code: "custom",
+        message: "Start date cannot be after end date",
+      });
     }
   })
-  .openapi({ title: "Update Project" });
+  .openapi("UpdateProjectInput");
 
-export const CreateProjectOutputSchema = ProjectEntitySchema;
-export const UpdateProjectOutputSchema = ProjectEntitySchema;
-export const DeleteProjectOutputSchema = ProjectEntitySchema;
+export const SearchProjectsInputSchema = z
+  .object({
+    query: z.string().optional(),
+    tags: z.array(z.string()).optional(),
+    limit: z.coerce.number().min(1).max(100).default(20),
+    cursor: z.string().optional(),
+  })
+  .openapi("SearchProjectsInput");
+
+export const CommentOnProjectInputSchema = CommentEntitySchema;
+
+/**
+ * OUTPUT / VIEW SCHEMAS
+ */
+
+export const ProjectDetailsEntitySchema = ProjectEntitySchema.extend({
+  user: MinimalUserSchema,
+}).openapi("ProjectDetailsEntity");
 
 export const GetProjectOutputSchema = ProjectDetailsEntitySchema.extend({
   isLiked: z.boolean().optional(),
   isBookmarked: z.boolean().optional(),
-});
-
-export const ProjectIdSchema = z.object({ projectId: z.cuid2() });
-export const MinimalProjectSchema = ProjectEntitySchema.pick({
-  id: true,
-  title: true,
-  description: true,
-  tags: true,
-  startDate: true,
-  endDate: true,
-  imagePlaceholderUrl: true,
-}).openapi({
-  title: "MinimalProject",
-});
+}).openapi("GetProjectOutput");
 
-export const SearchProjectsInputSchema = z
+export const ProjectSearchDocumentSchema = z
   .object({
-    query: z.string().optional(),
+    id: z.string(),
+    userId: z.string(),
+    title: z.string(),
+    imagePlaceholderUrl: z.url(),
+    projectCreatorType: z.enum(ROLES),
+    createdAt: z.number(),
+    updatedAt: z.number(),
+    description: z.string().optional(),
+    capitalLookingToRaise: z.string().optional(),
+    capitalLookingToRaiseCurrency: z.enum(WAGES_CURRENCY).optional(),
+    url: z.url().optional(),
     tags: z.array(z.string()).optional(),
-    limit: z.coerce
-      .number()
-      .min(1)
-      .max(100)
-      .default(20)
-      .openapi({ example: 20 }),
-    cursor: z
-      .string()
-      .optional()
-      .openapi({ example: "ckl1y9xyz0000qv7a0h1efgh4" }),
+    clientId: z.string().optional(),
+    clientType: z.enum(CLIENT_TYPES).optional(),
+    clientName: z.string().optional(),
+    isFeatured: z.boolean().optional(),
+    startDate: z.number().optional(),
+    endDate: z.number().optional(),
   })
-  .openapi({
-    title: "ListProjectsInput",
-  });
+  .openapi("ProjectSearchDocument");
 
 export const SearchProjectsOutputSchema = z
   .object({
-    projects: z.array(MinimalProjectSchema),
+    projects: z.array(ProjectSearchDocumentSchema),
     nextCursor: z.string().optional().nullable(),
   })
-  .openapi({
-    title: "SearchProjectsOutput",
-  });
-
-export const ProjectWithProjectViewsEntitySchema = MinimalProjectSchema.extend({
-  views: z.array(ViewEntitySchema),
-}).openapi({
-  title: "ProjectWithProjectViewsEntity",
-});
+  .openapi("SearchProjectsOutput");
 
 export const ProjectWithProjectCommentsEntitySchema =
   MinimalProjectSchema.extend({
     comments: z.array(CommentEntitySchema),
-  }).openapi({
-    title: "ProjectWithProjectCommentsEntity",
-  });
+  }).openapi("ProjectWithProjectCommentsEntity");
+
+export const GetProjectWithCommentsOutputSchema =
+  ProjectWithProjectCommentsEntitySchema.extend({
+    nextCursor: z.string().optional().nullable(),
+  }).openapi("GetProjectWithCommentsOutput");
 
 export const ProjectWithLikesEntitySchema = MinimalProjectSchema.extend({
   likes: z.array(
@@ -251,23 +195,44 @@ export const ProjectWithLikesEntitySchema = MinimalProjectSchema.extend({
       isFollowing: z.boolean().optional(),
     }),
   ),
-}).openapi({
-  title: "ProjectWithProjectLikesEntity",
-});
+}).openapi("ProjectWithLikesEntity");
+
+export const GetProjectWithLikesOutputSchema =
+  ProjectWithLikesEntitySchema.extend({
+    nextCursor: z.string().optional().nullable(),
+  }).openapi("GetProjectWithLikesOutput");
+
+export const ProjectWithProjectViewsEntitySchema = MinimalProjectSchema.extend({
+  views: z.array(ViewEntitySchema),
+}).openapi("ProjectWithProjectViewsEntity");
 
 export const ProjectWithProjectBookmarksEntitySchema =
   MinimalProjectSchema.extend({
     bookmarks: z.array(BookmarkEntitySchema),
-  }).openapi({
-    title: "ProjectWithProjectBookmarksEntity",
-  });
+  }).openapi("ProjectWithProjectBookmarksEntity");
 
-export const GetProjectWithCommentsOutputSchema =
-  ProjectWithProjectCommentsEntitySchema.extend({
-    nextCursor: z.string().optional().nullable(),
-  });
+export const ProjectUpdateOutputEntitySchema = z.object({
+  id: z.cuid2(),
+});
+export const CreateProjectOutputSchema = ProjectEntitySchema;
+export const UpdateProjectOutputSchema = ProjectEntitySchema;
+export const DeleteProjectOutputSchema = ProjectEntitySchema;
+export const CommentOnProjectOutputSchema = CommentEntitySchema.omit({
+  likesCount: true,
+  isLiked: true,
+});
 
-export const GetProjectWithLikesOutputSchema =
-  ProjectWithLikesEntitySchema.extend({
-    nextCursor: z.string().optional().nullable(),
-  });
+/**
+ * SEARCH & UTILITY SCHEMAS
+ */
+
+export const ProjectIdSchema = z.object({ projectId: z.cuid2() });
+
+export const CreateProjectFileInputSchema = z.object({
+  key: z.string().max(500),
+  projectId: z.cuid2(),
+});
+
+export const DeleteProjectFileInputSchema = z.object({
+  keys: z.array(z.string()),
+});

package/src/types/project.ts

@@ -18,6 +18,11 @@ import type {
   SearchProjectsOutputSchema,
   GetProjectWithLikesOutputSchema,
   GetProjectWithCommentsOutputSchema,
+  CommentOnProjectInputSchema,
+  CommentOnProjectOutputSchema,
+  ProjectSearchDocumentSchema,
+  CreateProjectFileInputSchema,
+  DeleteProjectFileInputSchema,
 } from "../schemas/project";
 import { ViewEntitySchema } from "../schemas/view";
 import { LikeEntitySchema } from "../schemas/like";
@@ -61,3 +66,16 @@ export type GetProjectWithCommentsOutput = z.infer<
 export type GetProjectWithLikesOutput = z.infer<
   typeof GetProjectWithLikesOutputSchema
 >;
+
+export type CommentOnProjectInput = z.infer<typeof CommentOnProjectInputSchema>;
+
+export type CommentOnProjectOutput = z.infer<
+  typeof CommentOnProjectOutputSchema
+>;
+
+export type ProjectSearchDocument = z.infer<typeof ProjectSearchDocumentSchema>;
+
+export type ProjectFileInput = z.infer<typeof CreateProjectFileInputSchema>;
+export type DeleteProjectFileInput = z.infer<
+  typeof DeleteProjectFileInputSchema
+>;