@zyacreatives/shared 1.0.0 → 1.1.0

package/src/constants.ts

@@ -0,0 +1,300 @@
+export const ROLES = {
+  CREATIVE: "CREATIVE",
+  BRAND: "BRAND",
+  INVESTOR: "INVESTOR",
+  ADMIN: "ADMIN",
+} as const;
+
+export const USER_STATUSES = {
+  ACTIVE: "ACTIVE",
+  SUSPENDED: "SUSPENDED",
+  DELETED: "DELETED",
+} as const;
+
+export const CLIENT_TYPES = {
+  CREATIVE: "CREATIVE",
+  BRAND: "BRAND",
+  NONE: "NONE",
+} as const;
+
+export const EXPERIENCE_LEVELS = {
+  YEAR_0_1: "0-1 year",
+  YEAR_1_3: "1-3 years",
+  YEAR_3_5: "3-5 years",
+  YEAR_5_PLUS: "5+ years",
+} as const;
+
+export const ONBOARDING_PAGES = {
+  EMAIL_VERIFICATION: "EMAIL_VERIFICATION",
+  USERNAME_SELECTION: "USERNAME_SELECTION",
+  ACCOUNT_TYPE_SELECTION: "ACCOUNT_TYPE_SELECTION",
+  CREATIVE_PROFILE_DETAILS: "CREATIVE_PROFILE_DETAILS",
+  CREATIVE_PROFILE_CUSTOMIZE_FEED: "CREATIVE_PROFILE_CUSTOMIZE_FEED",
+  CREATIVE_PROFILE_PORTFOLIO: "CREATIVE_PROFILE_PORTFOLIO",
+  BRAND_PROFILE_DETAILS: "BRAND_PROFILE_DETAILS",
+  BRAND_PROFILE_CUSTOMIZE_FEED: "BRAND_PROFILE_CUSTOMIZE_FEED",
+  BRAND_PROFILE_PORTFOLIO: "BRAND_PROFILE_PORTFOLIO",
+  INVESTOR_PROFILE_DETAILS: "INVESTOR_PROFILE_DETAILS",
+  INVESTOR_INVESTMENT_FOCUS: "INVESTOR_INVESTMENT_FOCUS",
+  INVESTOR_VERIFICATION: "INVESTOR_VERIFICATION",
+  DONE: "DONE",
+} as const;
+
+export const INVESTOR_TYPES = {
+  ANGEL_INVESTOR: "Angel Investor",
+  VENTURE_CAPITALIST: "Venture Capitalist",
+  PRIVATE_EQUITY_FIRM: "Private Equity Firm",
+  VENTURE_DEBT_PROVIDER: "Venture Debt Provider",
+  BANK: "Bank",
+  CONVERTIBLE_NOTE_INVESTOR: "Convertible Note Investor",
+  REVENUE_BASED_FINANCING_INVESTOR: "Revenue Based Financing Investor",
+  CORPORATE_VENTURE_CAPITALIST: "Corporate Venture Capitalist",
+  GOVERNMENT: "Government",
+  SOCIAL_IMPACT_INVESTOR: "Social Impact Investor",
+} as const;
+
+export const INVESTMENT_SIZES = {
+  UNDER_5K: "Under 5k USD",
+  BETWEEN_5K_25K: "5k - 25k USD",
+  BETWEEN_25K_100K: "25k - 100k USD",
+  BETWEEN_100K_500K: "100k - 500k USD",
+  BETWEEN_500K_1M: "500k - 1M USD",
+  OVER_1M: "1M+ USD",
+} as const;
+
+export const GEOGRAPHIC_FOCUS = {
+  AFRICA: "Africa",
+  ASIA: "Asia",
+  EUROPE: "Europe",
+  NORTH_AMERICA: "North America",
+  SOUTH_AMERICA: "South America",
+  MIDDLE_EAST: "Middle East",
+  OCEANIA: "Oceania",
+  UK: "United Kingdom (UK)",
+  US: "United States (US)",
+  GLOBAL: "Global",
+  OTHER: "Other",
+} as const;
+
+export const INVESTOR_VERIFICATION_DOCUMENT_STATUSES = {
+  PENDING: "PENDING",
+  APPROVED: "APPROVED",
+  REJECTED: "REJECTED",
+} as const;
+
+export const INVESTOR_VERIFICATION_DOCUMENT_TYPES = {
+  ID_PROOF: "ID_PROOF",
+  BANK_STATEMENT: "BANK_STATEMENT",
+  TAX_DOCUMENT: "TAX_DOCUMENT",
+  BUSINESS_REGISTRATION: "BUSINESS_REGISTRATION",
+  OTHER_CERTIFICATE: "OTHER_CERTIFICATE",
+} as const;
+
+export const COMMENT_STATUSES = {
+  ACTIVE: "ACTIVE",
+  HIDDEN: "HIDDEN",
+  DELETED: "DELETED",
+} as const;
+
+export const FILE_VISIBILITIES = {
+  PUBLIC: "PUBLIC",
+  PRIVATE: "PRIVATE",
+} as const;
+
+export type Role = (typeof ROLES)[keyof typeof ROLES];
+export type UserStatus = (typeof USER_STATUSES)[keyof typeof USER_STATUSES];
+export type ClientType = (typeof CLIENT_TYPES)[keyof typeof CLIENT_TYPES];
+export type ExperienceLevel =
+  (typeof EXPERIENCE_LEVELS)[keyof typeof EXPERIENCE_LEVELS];
+export type OnboardingPage =
+  (typeof ONBOARDING_PAGES)[keyof typeof ONBOARDING_PAGES];
+export type InvestorType = (typeof INVESTOR_TYPES)[keyof typeof INVESTOR_TYPES];
+export type InvestmentSize =
+  (typeof INVESTMENT_SIZES)[keyof typeof INVESTMENT_SIZES];
+export type GeographicFocus =
+  (typeof GEOGRAPHIC_FOCUS)[keyof typeof GEOGRAPHIC_FOCUS];
+export type InvestorVerificationDocumentStatus =
+  (typeof INVESTOR_VERIFICATION_DOCUMENT_STATUSES)[keyof typeof INVESTOR_VERIFICATION_DOCUMENT_STATUSES];
+export type InvestorVerificationDocumentType =
+  (typeof INVESTOR_VERIFICATION_DOCUMENT_TYPES)[keyof typeof INVESTOR_VERIFICATION_DOCUMENT_TYPES];
+export type CommentStatus =
+  (typeof COMMENT_STATUSES)[keyof typeof COMMENT_STATUSES];
+export type FileVisibility =
+  (typeof FILE_VISIBILITIES)[keyof typeof FILE_VISIBILITIES];
+
+export const API_ROUTES = {
+  healthCheck: "/health",
+  username: {
+    base: "/usernames",
+    checkAvailability: "/:username/availability",
+  },
+  personal: {
+    base: "/me",
+    getUser: "",
+    getProfile: "/profile",
+    getProjects: "/projects",
+    getProjectBookmarks: "/project-bookmarks",
+    getFollowers: "/followers",
+    getFollowing: "/following",
+  },
+  user: {
+    base: "/users",
+    getUser: "/:value",
+    getProfile: "/:value/profile",
+    getProjects: "/:value/projects",
+    getFollowers: "/:userId/followers",
+    getFollowing: "/:userId/following",
+    followUser: "/:userId/follow",
+    unfollowUser: "/:userId/unfollow",
+    reserveUsername: "/reserve-username",
+  },
+  redirect: {
+    base: "/redirect",
+    passwordReset: "/password-reset",
+    verifiedUser: "/verified-user",
+    googleProfile: "/google-profile",
+    newGoogleProfile: "/new-google-profile",
+  },
+  file: {
+    base: "/files",
+    getPresignedUploadUrl: "/get-upload-url",
+    getPresignedDownloadUrl: "/:fileId/download-url",
+    getPublicUrl: "/:fileId/public-url",
+    createFile: "",
+    deleteFile: "/:fileId",
+  },
+  disciplines: {
+    base: "/disciplines",
+    getDisciplines: "",
+    getSingleDiscipline: "/:slug",
+    addDisciplines: "",
+    deleteDiscipline: "/:slug",
+  },
+  creatives: {
+    base: "/creatives",
+    createCreative: "",
+    getCreative: "/:value",
+    updateCreative: "",
+  },
+  brands: {
+    base: "/brands",
+    createBrand: "",
+    getBrand: "/:value",
+    updateBrand: "",
+  },
+  investors: {
+    base: "/investors",
+    createInvestor: "",
+    getInvestor: "/:value",
+    updateInvestor: "",
+  },
+  projects: {
+    base: "/projects",
+    createProject: "",
+    updateProject: "",
+    listProjects: "",
+    getProject: "/:projectId",
+    deleteProject: "/:projectId",
+    commentOnProject: "/:projectId/comment",
+    deleteCommentOnProject: "/:projectId/comments/:commentId",
+    bookmarkProject: "/:projectId/bookmark",
+    unbookmarkProject: "/:projectId/unbookmark",
+    likeProject: "/:projectId/like",
+    unlikeProject: "/:projectId/unlike",
+    viewProject: "/:projectId/view",
+    getProjectComments: "/:projectId/comments",
+    getProjectLikes: "/:projectId/likes",
+    getProjectBookmarks: "/:projectId/bookmarks",
+    getProjectViews: "/:projectId/views",
+    getProjectUser: "/:projectId/user",
+  },
+} as const;
+
+export const FRONTEND_API_ROUTES = {
+  healthCheck: "health",
+  username: {
+    base: "usernames",
+    checkAvailability: (username: string) => `${username}/availability`,
+  },
+  personal: {
+    base: "me",
+    getUser: "",
+    getProfile: "profile",
+    getProjects: "projects",
+    getProjectBookmarks: "project-bookmarks",
+    getFollowers: "followers",
+    getFollowing: "following",
+  },
+  user: {
+    base: "users",
+    getUser: (value: string) => `${value}`,
+    getProfile: (value: string) => `${value}/profile`,
+    getProjects: (value: string) => `${value}/projects`,
+    getFollowers: (userId: string) => `${userId}/followers`,
+    getFollowing: (userId: string) => `${userId}/following`,
+    followUser: (userId: string) => `${userId}/follow`,
+    unfollowUser: (userId: string) => `${userId}/unfollow`,
+    reserveUsername: "reserve-username",
+  },
+  redirect: {
+    base: "redirect",
+    passwordReset: "password-reset",
+    verifiedUser: "verified-user",
+    googleProfile: "google-profile",
+    newGoogleProfile: "new-google-profile",
+  },
+  file: {
+    base: "files",
+    getPresignedUploadUrl: "get-upload-url",
+    getPresignedDownloadUrl: (fileId: string) => `${fileId}/download-url`,
+    getPublicUrl: (fileId: string) => `${fileId}/public-url`,
+    createFile: "",
+    deleteFile: (fileId: string) => `${fileId}`,
+  },
+  disciplines: {
+    base: "disciplines",
+    getDisciplines: "",
+    getSingleDiscipline: (slug: string) => `${slug}`,
+    addDisciplines: "",
+    deleteDiscipline: (slug: string) => `${slug}`,
+  },
+  creatives: {
+    base: "creatives",
+    createCreative: "",
+    getCreative: (value: string) => `${value}`,
+    updateCreative: "",
+  },
+  brands: {
+    base: "brands",
+    createBrand: "",
+    getBrand: (value: string) => `${value}`,
+    updateBrand: "",
+  },
+  investors: {
+    base: "investors",
+    createInvestor: "",
+    getInvestor: (value: string) => `${value}`,
+    updateInvestor: "",
+  },
+  projects: {
+    base: "projects",
+    createProject: "",
+    updateProject: "",
+    listProjects: "",
+    getProject: (projectId: string) => `${projectId}`,
+    deleteProject: (projectId: string) => `${projectId}`,
+    commentOnProject: (projectId: string) => `${projectId}/comment`,
+    deleteCommentOnProject: (projectId: string, commentId: string) =>
+      `${projectId}/comments/${commentId}`,
+    bookmarkProject: (projectId: string) => `${projectId}/bookmark`,
+    unbookmarkProject: (projectId: string) => `${projectId}/unbookmark`,
+    likeProject: (projectId: string) => `${projectId}/like`,
+    unlikeProject: (projectId: string) => `${projectId}/unlike`,
+    viewProject: (projectId: string) => `${projectId}/view`,
+    getProjectComments: (projectId: string) => `${projectId}/comments`,
+    getProjectLikes: (projectId: string) => `${projectId}/likes`,
+    getProjectBookmarks: (projectId: string) => `${projectId}/bookmarks`,
+    getProjectViews: (projectId: string) => `${projectId}/views`,
+    getProjectUser: (projectId: string) => `${projectId}/user`,
+  },
+} as const;

package/src/index.ts

@@ -1 +1 @@
-export const sum = (a: number, b: number) => a + b;
+export * from "./types/index";

package/src/schemas/brand.ts

@@ -0,0 +1,91 @@
+import { z } from "@hono/zod-openapi";
+import { CuidSchema, ProfileIdentifierSchema } from "./common";
+import { MinimalUserSchema } from "./user";
+
+export const BrandEntitySchema = z
+  .object({
+    id: z.cuid2().openapi({ example: "cksd0v6q0000s9a5y8z7p3x9" }),
+    userId: z.cuid2().openapi({ example: "cksd0v6q0000s9a5y8z7p3x9" }),
+    brandName: z.string().min(1).openapi({ example: "Acme Creative Studio" }),
+    searchVector: z.string().optional(),
+    bio: z.string().optional().openapi({
+      example: "A creative studio specializing in product design.",
+    }),
+    tags: z
+      .array(z.string())
+      .optional()
+      .openapi({ example: ["branding", "design", "marketing"] }),
+    createdAt: z.iso
+      .datetime()
+      .openapi({ example: "2025-10-13T09:00:00.000Z" }),
+    updatedAt: z.iso
+      .datetime()
+      .openapi({ example: "2025-10-13T09:00:00.000Z" }),
+  })
+  .openapi("BrandEntity");
+
+export const CreateBrandProfileSchema = z
+  .object({
+    brandName: z
+      .string()
+      .min(1, "Brand name is required")
+      .openapi({ example: "Acme Creative Studio" }),
+    bio: z.string().max(210).optional().default("").openapi({
+      example: "We help brands tell their stories through design.",
+    }),
+    tags: z
+      .array(z.string())
+      .optional()
+      .default([])
+      .openapi({ example: ["branding", "ux", "campaigns"] }),
+  })
+  .openapi({
+    title: "create brand profile",
+  });
+
+export const UpdateBrandProfileSchema = z
+  .object({
+    brandName: z.string().min(1).optional().openapi({ example: "Acme Studio" }),
+    bio: z.string().max(210).optional().openapi({
+      example: "Updated bio for our creative agency.",
+    }),
+    tags: z
+      .array(z.string())
+      .optional()
+      .openapi({ example: ["branding", "product", "illustration"] }),
+  })
+  .openapi({
+    title: "update brand profile",
+  });
+
+export const GetBrandParamsSchema = z.object({
+  value: CuidSchema,
+});
+
+export const GetBrandQuerySchema = ProfileIdentifierSchema;
+
+export const CreateBrandEndpointResponseSchema = BrandEntitySchema;
+export const GetBrandEndpointResponseSchema = BrandEntitySchema.extend({
+  user: MinimalUserSchema,
+});
+export const UpdateBrandEndpointResponseSchema = BrandEntitySchema;
+
+export type CreateBrandDto = z.infer<typeof CreateBrandProfileSchema> & {
+  userId: string;
+};
+export type UpdateBrandDto = z.infer<typeof UpdateBrandProfileSchema> & {
+  userId: string;
+};
+
+export type GetBrandParams = z.infer<typeof GetBrandParamsSchema>;
+export type GetBrandQuery = z.infer<typeof GetBrandQuerySchema>;
+
+export type CreateBrandEndpointResponse = z.infer<
+  typeof CreateBrandEndpointResponseSchema
+>;
+export type GetBrandEndpointResponse = z.infer<
+  typeof GetBrandEndpointResponseSchema
+>;
+export type UpdateBrandEndpointResponse = z.infer<
+  typeof UpdateBrandEndpointResponseSchema
+>;

package/src/schemas/common.ts

@@ -0,0 +1,67 @@
+import { z } from "@hono/zod-openapi";
+
+export const CuidSchema = z.cuid2({ error: "Invalid CUID2 is written." });
+
+export const UserIdentifierSchema = z.object({
+  by: z.enum(["id", "username"]).optional().default("id"),
+});
+
+export type UserIdentifier = z.infer<typeof UserIdentifierSchema>;
+
+export const ProfileIdentifierSchema = z.object({
+  by: z.enum(["id", "userId"]).optional().default("id"),
+});
+
+export type ProfileIdentifier = z.infer<typeof ProfileIdentifierSchema>;
+
+export const ProjectIdentifierSchema = z.object({
+  by: z.enum(["id", "userId"]).optional().default("id"),
+});
+
+export type ProjectIdentifier = z.infer<typeof ProjectIdentifierSchema>;
+
+export const ProjectSocialGraphEntitySchema = z
+  .object({
+    noOfLikes: z
+      .number()
+      .int()
+      .nonnegative()
+      .optional()
+      .openapi({ example: 350 }),
+    noOfComments: z
+      .number()
+      .int()
+      .nonnegative()
+      .optional()
+      .openapi({ example: 78 }),
+    noOfBookmarks: z
+      .number()
+      .int()
+      .nonnegative()
+      .optional()
+      .openapi({ example: 25 }),
+    noOfViews: z
+      .number()
+      .int()
+      .nonnegative()
+      .optional()
+      .openapi({ example: 1024 }),
+  })
+  .openapi("ProjectSocialGraphEntity");
+
+export const UserSocialGraphEntitySchema = z
+  .object({
+    followerCount: z
+      .number()
+      .int()
+      .nonnegative()
+      .optional()
+      .openapi({ example: 120 }),
+    followingCount: z
+      .number()
+      .int()
+      .nonnegative()
+      .optional()
+      .openapi({ example: 45 }),
+  })
+  .openapi("UserSocialGraphEntity");

package/src/schemas/creative.ts

@@ -0,0 +1,125 @@
+import { z } from "@hono/zod-openapi";
+import { EXPERIENCE_LEVELS } from "../constants";
+import { CuidSchema, ProfileIdentifierSchema } from "./common";
+import { MinimalUserSchema } from "./user";
+
+export const CreativeEntitySchema = z
+  .object({
+    id: z.cuid2().openapi({ example: "cksd0v6q0000s9a5y8z7p3x9" }),
+    userId: z.cuid2().openapi({ example: "cksd0v6q0000s9a5y8z7p3x9" }),
+    bio: z
+      .string()
+      .optional()
+      .openapi({ example: "Passionate visual artist." }),
+    location: z.string().optional().openapi({ example: "Lagos, Nigeria" }),
+    searchVector: z.string().optional(),
+    experienceLevel: z
+      .enum(Object.values(EXPERIENCE_LEVELS) as [string, ...string[]])
+      .optional()
+      .openapi({ example: "1-3 years" }),
+    tags: z
+      .array(z.string())
+      .optional()
+      .openapi({ example: ["digital-art", "illustration"] }),
+    disciplines: z
+      .array(z.string())
+      .optional()
+      .openapi({ example: ["painting", "animation"] }),
+    createdAt: z.iso
+      .datetime()
+      .openapi({ example: "2025-10-13T09:00:00.000Z" }),
+    updatedAt: z.iso
+      .datetime()
+      .openapi({ example: "2025-10-13T09:00:00.000Z" }),
+  })
+  .openapi("CreativeEntity");
+
+export const CreateCreativeProfileSchema = z
+  .object({
+    experienceLevel: z
+      .enum(EXPERIENCE_LEVELS)
+      .default(EXPERIENCE_LEVELS.YEAR_0_1)
+      .openapi({ example: EXPERIENCE_LEVELS.YEAR_1_3 }),
+    bio: z
+      .string()
+      .max(210)
+      .optional()
+      .default("")
+      .openapi({ example: "I am a freelance UI/UX designer." }),
+    location: z
+      .string()
+      .max(100)
+      .optional()
+      .default("")
+      .openapi({ example: "Lagos, Nigeria" }),
+    disciplineSlugs: z
+      .array(z.string())
+      .min(1, "At least one discipline is required")
+      .default([])
+      .openapi({ example: ["ui-ux", "frontend"] }),
+  })
+  .openapi({
+    title: "create creative profile",
+  });
+
+export const UpdateCreativeProfileSchema = z
+  .object({
+    experienceLevel: z
+      .enum(EXPERIENCE_LEVELS)
+      .optional()
+      .openapi({ example: EXPERIENCE_LEVELS.YEAR_3_5 }),
+    tags: z
+      .array(z.string())
+      .optional()
+      .openapi({ example: ["react", "design", "product"] }),
+    bio: z
+      .string()
+      .max(210)
+      .optional()
+      .openapi({ example: "I am a freelance UI/UX designer." }),
+    location: z
+      .string()
+      .max(100)
+      .optional()
+      .openapi({ example: "Lagos, Nigeria" }),
+    disciplineSlugs: z
+      .array(z.string())
+      .min(1, "At least one discipline is required")
+      .optional()
+      .openapi({ example: ["frontend", "ui-ux"] }),
+  })
+  .openapi({
+    title: "update creative profile",
+  });
+
+export const GetCreativeParamsSchema = z.object({
+  value: CuidSchema,
+});
+
+export const GetCreativeQuerySchema = ProfileIdentifierSchema;
+
+export const CreateCreativeEndpointResponseSchema = CreativeEntitySchema;
+export const GetCreativeEndpointResponseSchema = CreativeEntitySchema.extend({
+  user: MinimalUserSchema,
+})
+export const UpdateCreativeEndpointResponseSchema = CreativeEntitySchema;
+
+export type CreateCreativeDto = z.infer<typeof CreateCreativeProfileSchema> & {
+  userId: string;
+};
+export type UpdateCreativeDto = z.infer<typeof UpdateCreativeProfileSchema> & {
+  userId: string;
+};
+
+export type GetCreativeParams = z.infer<typeof GetCreativeParamsSchema>;
+export type GetCreativeQuery = z.infer<typeof GetCreativeQuerySchema>;
+
+export type CreateCreativeEndpointResponse = z.infer<
+  typeof CreateCreativeEndpointResponseSchema
+>;
+export type GetCreativeEndpointResponse = z.infer<
+  typeof GetCreativeEndpointResponseSchema
+>;
+export type UpdateCreativeEndpointResponse = z.infer<
+  typeof UpdateCreativeEndpointResponseSchema
+>;