@zyacreatives/shared 1.0.1 → 1.1.0

package/dist/types/common.d.ts

@@ -0,0 +1,10 @@
+export type ProjectSocialGraphEntity = {
+    noOfLikes?: number;
+    noOfComments?: number;
+    noOfBookmarks?: number;
+    noOfViews?: number;
+};
+export type UserSocialGraphEntity = {
+    followerCount?: number;
+    followingCount?: number;
+};

package/dist/types/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/creative.d.ts

@@ -0,0 +1,28 @@
+import type { ExperienceLevel } from "../constants";
+import type { MinimalUser } from "./user";
+export type BaseCreativeEntity = {
+    id: string;
+    userId: string;
+    bio?: string;
+    location?: string;
+    experienceLevel?: ExperienceLevel;
+    tags?: string[];
+    disciplines?: string[];
+    user?: any;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type CreativeEntity = BaseCreativeEntity;
+export type CreativeWithUserEntity = CreativeEntity & {
+    user: MinimalUser;
+    disciplines: string[];
+};
+export type ListCreativesInput = {
+    query?: string;
+    disciplines?: string[];
+    experienceLevels?: string[];
+    location?: string;
+    tags?: string[];
+    page?: number;
+    perPage?: number;
+};

package/dist/types/creative.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/discipline.d.ts

@@ -0,0 +1,8 @@
+export type DisciplineEntity = {
+    slug: string;
+    name: string;
+    tags?: string[];
+};
+export type DisciplineUpdateOutputEntity = {
+    slug: string;
+};

package/dist/types/discipline.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/file.d.ts

@@ -0,0 +1,12 @@
+export type FileEntity = {
+    key: string;
+    id: string;
+    url?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string;
+    mimeType: string;
+};
+export type FileUpdateOutputEntity = {
+    id: string;
+};

package/dist/types/file.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -1 +1,8 @@
-export * from "./enums";
+export * from "./brand";
+export * from "./common";
+export * from "./creative";
+export * from "./discipline";
+export * from "./file";
+export * from "./investor";
+export * from "./project";
+export * from "./user";

package/dist/types/index.js

@@ -1 +1,24 @@
-export * from "./enums";
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./brand"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./creative"), exports);
+__exportStar(require("./discipline"), exports);
+__exportStar(require("./file"), exports);
+__exportStar(require("./investor"), exports);
+__exportStar(require("./project"), exports);
+__exportStar(require("./user"), exports);

package/dist/types/investor.d.ts

@@ -0,0 +1,30 @@
+import type { ExperienceLevel, GeographicFocus, InvestmentSize, InvestorType } from "../constants";
+import type { MinimalUser } from "./user";
+export type InvestorEntity = {
+    id: string;
+    userId: string;
+    bio?: string;
+    location?: string;
+    experienceLevel?: ExperienceLevel;
+    geographicFocus?: GeographicFocus;
+    investmentSize?: InvestmentSize;
+    investorType?: InvestorType;
+    websiteURL?: string;
+    disciplines?: string[];
+    user?: any;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type InvestorWithUserEntity = InvestorEntity & {
+    user: MinimalUser;
+    disciplines: string[];
+};
+export type ListInvestorsInput = {
+    query?: string;
+    disciplines?: string[];
+    experienceLevels?: string[];
+    location?: string;
+    tags?: string[];
+    page?: number;
+    perPage?: number;
+};

package/dist/types/investor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/project.d.ts

@@ -0,0 +1,79 @@
+import type { ClientType, CommentStatus, Role } from "../constants";
+import type { ProjectSocialGraphEntity } from "./common";
+import type { BaseUserEntity, MinimalUser } from "./user";
+export type ProjectFileEntity = {
+    id: string;
+    projectId: string;
+    fileId: string;
+    order: number;
+    isPlaceholder: boolean;
+};
+export type ProjectEntity = {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string;
+    title: string;
+    description?: string;
+    overview?: string;
+    url?: string;
+    clientId?: string;
+    clientType?: ClientType;
+    clientName?: string;
+    projectCreatorType: Role;
+    tags?: string[];
+    isFeatured?: boolean;
+    startDate?: Date | null;
+    imagePlaceholderUrl?: string;
+    endDate?: Date | null;
+};
+export type ProjectWithFilesEntity = ProjectEntity & ProjectSocialGraphEntity & {
+    projectFiles?: ProjectFileEntity[];
+};
+export type ProjectViewEntity = {
+    id: string;
+    userId?: string;
+    ipAddress?: string;
+    userAgent?: string;
+    projectId: string;
+    sessionId?: string;
+    viewedAt: Date;
+    viewDate: Date;
+};
+export type ProjectLikeEntity = {
+    createdAt: Date;
+    userId: string;
+    projectId: string;
+};
+export type ProjectCommentEntity = {
+    id: string;
+    status: CommentStatus;
+    createdAt: Date;
+    userId: string;
+    projectId: string;
+    parentCommentId?: string;
+    content: string;
+};
+export type ProjectBookmarkEntity = {
+    createdAt: Date;
+    userId: string;
+    projectId: string;
+};
+export type MinimalProject = Pick<ProjectEntity, "id" | "title" | "description" | "tags" | "startDate" | "endDate" | "imagePlaceholderUrl">;
+export type ProjectWithClientEntity = MinimalProject & {
+    client: MinimalUser;
+};
+export type ProjectWithUserEntity = MinimalProject & {
+    user: Pick<BaseUserEntity, "id" | "name" | "email" | "image" | "username" | "role">;
+    projectFiles: (ProjectFileEntity & {
+        fileUrl: string;
+    })[];
+} & Partial<ProjectSocialGraphEntity>;
+export type ListProjectsDto = {
+    query?: string;
+    tags?: string[];
+    clientName?: string;
+    userId?: string;
+    page?: number;
+    perPage?: number;
+};

package/dist/types/project.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/user.d.ts

@@ -0,0 +1,42 @@
+import type { OnboardingPage, Role, UserStatus } from "../constants";
+import type { UserSocialGraphEntity } from "./common";
+import type { ProjectBookmarkEntity, ProjectEntity } from "./project";
+export type BaseUserEntity = {
+    id: string;
+    email: string;
+    emailVerified: boolean;
+    name?: string;
+    image?: string;
+    username?: string;
+    displayUsername?: string;
+    role: Role;
+    status: UserStatus;
+    onboardingPage: OnboardingPage;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type MinimalUser = Pick<BaseUserEntity, "id" | "name" | "email" | "image" | "username" | "role">;
+export type UserEntity = BaseUserEntity & UserSocialGraphEntity;
+export type UserProfileEntity = UserEntity & {
+    profileType?: "creative" | "brand" | "investor";
+    bio?: string;
+    location?: string;
+    experienceLevel?: string;
+    disciplines?: any[];
+    tags?: any[];
+    brandName?: string;
+    websiteURL?: string;
+    investorType?: string;
+    investmentSize?: string;
+    geographicFocus?: string;
+};
+export type UserWithProjectsEntity = {
+    userId: string;
+    projects: Omit<ProjectEntity, "overview">[];
+};
+export type UserWithProjectBookmarksEntity = {
+    userId: string;
+    projectBookmarks: (ProjectBookmarkEntity & {
+        project: Pick<ProjectEntity, "id" | "title" | "description" | "tags" | "startDate" | "endDate" | "imagePlaceholderUrl">;
+    })[];
+};

package/dist/types/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyacreatives/shared",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,10 +13,14 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "tsup": "^8.5.0",
     "typescript": "^5.9.3"
   },
+  "dependencies": {
+    "@hono/zod-openapi": "^1.1.3",
+    "zod": "^4.1.12"
+  },
   "scripts": {
-    "build": "pnpm tsc"
+    "build": "pnpm tsc",
+    "p": "pnpm publish --no-git-checks"
   }
 }

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;