@zyacreatives/shared 1.6.3 → 1.6.5

package/dist/constants.d.ts

@@ -80,17 +80,12 @@ export declare const INVESTOR_VERIFICATION_DOCUMENT_TYPES: {
     readonly BUSINESS_REGISTRATION: "BUSINESS_REGISTRATION";
     readonly OTHER_CERTIFICATE: "OTHER_CERTIFICATE";
 };
-export declare const LIKE_PARENT_TYPES: {
-    readonly PROJECT: "PROJECT";
-    readonly POST: "POST";
-};
-export declare const COMMENT_PARENT_TYPES: {
+export declare const ACTIVITY_PARENT_TYPES: {
     readonly PROJECT: "PROJECT";
     readonly POST: "POST";
 };
 export type Role = (typeof ROLES)[keyof typeof ROLES];
-export type LikeParentType = (typeof LIKE_PARENT_TYPES)[keyof typeof LIKE_PARENT_TYPES];
-export type CommentParentType = (typeof COMMENT_PARENT_TYPES)[keyof typeof COMMENT_PARENT_TYPES];
+export type ActivityParentType = (typeof ACTIVITY_PARENT_TYPES)[keyof typeof ACTIVITY_PARENT_TYPES];
 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];

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_DISCIPLINES = exports.API_ROUTES = exports.COMMENT_PARENT_TYPES = exports.LIKE_PARENT_TYPES = exports.INVESTOR_VERIFICATION_DOCUMENT_TYPES = exports.INVESTOR_VERIFICATION_DOCUMENT_STATUSES = exports.GEOGRAPHIC_FOCUS = exports.INVESTMENT_SIZES = exports.INVESTOR_TYPES = exports.ONBOARDING_PAGES = exports.EXPERIENCE_LEVELS = exports.CLIENT_TYPES = exports.USER_STATUSES = exports.ROLES = void 0;
+exports.DEFAULT_DISCIPLINES = exports.API_ROUTES = exports.ACTIVITY_PARENT_TYPES = exports.INVESTOR_VERIFICATION_DOCUMENT_TYPES = exports.INVESTOR_VERIFICATION_DOCUMENT_STATUSES = exports.GEOGRAPHIC_FOCUS = exports.INVESTMENT_SIZES = exports.INVESTOR_TYPES = exports.ONBOARDING_PAGES = exports.EXPERIENCE_LEVELS = exports.CLIENT_TYPES = exports.USER_STATUSES = exports.ROLES = void 0;
 exports.ROLES = {
     CREATIVE: "CREATIVE",
     BRAND: "BRAND",
@@ -83,11 +83,10 @@ exports.INVESTOR_VERIFICATION_DOCUMENT_TYPES = {
     BUSINESS_REGISTRATION: "BUSINESS_REGISTRATION",
     OTHER_CERTIFICATE: "OTHER_CERTIFICATE",
 };
-exports.LIKE_PARENT_TYPES = {
+exports.ACTIVITY_PARENT_TYPES = {
     PROJECT: "PROJECT",
     POST: "POST",
 };
-exports.COMMENT_PARENT_TYPES = exports.LIKE_PARENT_TYPES;
 exports.API_ROUTES = {
     healthCheck: "/health",
     username: {

package/dist/schemas/comment.d.ts

@@ -0,0 +1,14 @@
+import z from "zod";
+export declare const CommentEntitySchema: z.ZodObject<{
+    id: z.ZodCUID2;
+    userId: z.ZodCUID2;
+    parentId: z.ZodCUID2;
+    parentType: z.ZodEnum<{
+        readonly PROJECT: "PROJECT";
+        readonly POST: "POST";
+    }>;
+    content: z.ZodString;
+    replyToId: z.ZodNullable<z.ZodOptional<z.ZodCUID2>>;
+    createdAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+    updatedAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+}, z.core.$strip>;

package/dist/schemas/comment.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentEntitySchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const constants_1 = require("../constants");
+exports.CommentEntitySchema = zod_1.default.object({
+    id: zod_1.default.cuid2().openapi({
+        description: "The unique CUID2 identifier for the comment.",
+        example: "tr4q2k7k0000c7625z2k8ggy",
+    }),
+    userId: zod_1.default.cuid2().openapi({
+        description: "The CUID2 of the user who created the comment.",
+        example: "clq9p8f2z0000c762s7k4g1b",
+    }),
+    parentId: zod_1.default.cuid2().openapi({
+        description: "The CUID2 of the parent entity (e.g., a post or project) this comment belongs to.",
+        example: "clq9p8f2z0000c762s7k4g1b",
+    }),
+    parentType: zod_1.default.enum(constants_1.ACTIVITY_PARENT_TYPES).openapi({
+        description: "The type of the parent entity this comment is attached to.",
+        example: "POST", // Assuming 'POST' is a value in ACTIVITY_PARENT_TYPES
+    }),
+    content: zod_1.default.string().openapi({
+        description: "The text content of the comment. May contain Markdown.",
+        example: "This is a great point! I hadn't considered that perspective.",
+    }),
+    replyToId: zod_1.default.cuid2().optional().nullable().openapi({
+        description: "The ID of the parent comment if this is a reply. Null for top-level comments.",
+        example: "tr4q2k7k0000c7625z2k8ggy", // Example of a parent comment's ID
+    }),
+    createdAt: zod_1.default.coerce.date().optional().openapi({
+        description: "The date and time the comment was created.",
+        example: "2023-10-27T10:00:00.000Z",
+        format: "date-time",
+    }),
+    updatedAt: zod_1.default.coerce.date().optional().openapi({
+        description: "The date and time the comment was last updated.",
+        example: "2023-10-27T10:05:00.000Z",
+        format: "date-time",
+    })
+});

package/dist/schemas/entity-stats.d.ts

@@ -0,0 +1,14 @@
+import { z } from "@hono/zod-openapi";
+export declare const EntityStatsSchema: z.ZodObject<{
+    updatedAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+    createdAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+    parentId: z.ZodCUID2;
+    parentType: z.ZodEnum<{
+        readonly PROJECT: "PROJECT";
+        readonly POST: "POST";
+    }>;
+    likesCount: z.ZodNumber;
+    bookmarksCount: z.ZodNumber;
+    viewsCount: z.ZodNumber;
+    commentsCount: z.ZodNumber;
+}, z.core.$strip>;

package/dist/schemas/entity-stats.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityStatsSchema = void 0;
+const zod_openapi_1 = require("@hono/zod-openapi");
+const constants_1 = require("../constants");
+exports.EntityStatsSchema = zod_openapi_1.z
+    .object({
+    updatedAt: zod_openapi_1.z.coerce.date().optional().openapi({
+        description: "Timestamp of the last update to the entity statistics.",
+        title: "Updated At",
+    }),
+    createdAt: zod_openapi_1.z.coerce.date().optional().openapi({
+        description: "Timestamp of the creationn to the entity statistics.",
+        title: "Updated At",
+    }),
+    parentId: zod_openapi_1.z.cuid2().openapi({
+        description: "Unique identifier of the parent entity (e.g., project, post, etc.).",
+        title: "Parent ID",
+    }),
+    parentType: zod_openapi_1.z.enum(constants_1.ACTIVITY_PARENT_TYPES).openapi({
+        description: "Type of the parent entity this statistic belongs to.",
+        title: "Parent Type",
+    }),
+    likesCount: zod_openapi_1.z.number().openapi({
+        description: "Total number of likes associated with the entity.",
+        title: "Likes Count",
+    }),
+    bookmarksCount: zod_openapi_1.z.number().openapi({
+        description: "Total number of bookmarks associated with the entity.",
+        title: "Bookmarks Count",
+    }),
+    viewsCount: zod_openapi_1.z.number().openapi({
+        description: "Total number of views recorded for the entity.",
+        title: "Views Count",
+    }),
+    commentsCount: zod_openapi_1.z.number().openapi({
+        description: "Total number of comments linked to the entity.",
+        title: "Comments Count",
+    }),
+})
+    .openapi({
+    description: "Represents engagement statistics for a specific entity.",
+    title: "EntityStats",
+});

package/dist/schemas/like.d.ts

@@ -0,0 +1,7 @@
+import { z } from "@hono/zod-openapi";
+export declare const LikeEntitySchema: z.ZodObject<{
+    createdAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+    userId: z.ZodCUID2;
+    parentId: z.ZodCUID2;
+    parentType: z.ZodString;
+}, z.core.$strip>;

package/dist/schemas/like.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LikeEntitySchema = void 0;
+const zod_openapi_1 = require("@hono/zod-openapi");
+exports.LikeEntitySchema = zod_openapi_1.z
+    .object({
+    createdAt: zod_openapi_1.z.coerce.date().optional().openapi({
+        description: "Timestamp when the like was created.",
+        title: "Created At",
+    }),
+    userId: zod_openapi_1.z.cuid2().openapi({
+        description: "Identifier of the user who performed the like.",
+        title: "User ID",
+    }),
+    parentId: zod_openapi_1.z.cuid2().openapi({
+        description: "Identifier of the parent entity that was liked.",
+        title: "Parent ID",
+    }),
+    parentType: zod_openapi_1.z.string().openapi({
+        description: "Type of the parent entity (e.g., project, post, etc.).",
+        title: "Parent Type",
+    }),
+})
+    .openapi({
+    description: "Represents a single like event on a parent entity.",
+    title: "Like",
+});

package/dist/schemas/view.d.ts

@@ -0,0 +1,15 @@
+import { z } from "@hono/zod-openapi";
+export declare const ViewEntitySchema: z.ZodObject<{
+    id: z.ZodCUID2;
+    userId: z.ZodNullable<z.ZodCUID2>;
+    ipAddress: z.ZodNullable<z.ZodString>;
+    userAgent: z.ZodNullable<z.ZodString>;
+    parentId: z.ZodCUID2;
+    parentType: z.ZodEnum<{
+        readonly PROJECT: "PROJECT";
+        readonly POST: "POST";
+    }>;
+    sessionId: z.ZodNullable<z.ZodString>;
+    viewedAt: z.ZodString;
+    viewDate: z.ZodString;
+}, z.core.$strip>;

package/dist/schemas/view.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewEntitySchema = void 0;
+const zod_openapi_1 = require("@hono/zod-openapi");
+const constants_1 = require("../constants");
+exports.ViewEntitySchema = zod_openapi_1.z
+    .object({
+    id: zod_openapi_1.z.cuid2().openapi({
+        description: "Unique identifier of the view record.",
+        title: "View ID",
+    }),
+    userId: zod_openapi_1.z.cuid2().nullable().openapi({
+        description: "Identifier of the user who viewed the entity, if authenticated.",
+        title: "User ID",
+    }),
+    ipAddress: zod_openapi_1.z.string().nullable().openapi({
+        description: "IP address from which the entity was viewed.",
+        title: "IP Address",
+    }),
+    userAgent: zod_openapi_1.z.string().nullable().openapi({
+        description: "User agent string identifying the client device or browser.",
+        title: "User Agent",
+    }),
+    parentId: zod_openapi_1.z.cuid2().openapi({
+        description: "Identifier of the parent entity being viewed.",
+        title: "Parent ID",
+    }),
+    parentType: zod_openapi_1.z.enum(constants_1.ACTIVITY_PARENT_TYPES).openapi({
+        description: "Type of the parent entity (e.g., project, post, etc.).",
+        title: "Parent Type",
+    }),
+    sessionId: zod_openapi_1.z.string().nullable().openapi({
+        description: "Session identifier associated with the view event, if available.",
+        title: "Session ID",
+    }),
+    viewedAt: zod_openapi_1.z.string().datetime().openapi({
+        description: "Exact timestamp when the view occurred.",
+        title: "Viewed At",
+    }),
+    viewDate: zod_openapi_1.z.string().date().openapi({
+        description: "Calendar date corresponding to the view event, used for aggregation.",
+        title: "View Date",
+    }),
+})
+    .openapi({
+    description: "Represents a record of a single view event for an entity.",
+    title: "View",
+});

package/dist/types/comment.d.ts

@@ -0,0 +1,3 @@
+import { z } from "@hono/zod-openapi";
+import { CommentEntitySchema } from "../schemas/comment";
+export type CommentEntity = z.infer<typeof CommentEntitySchema>;

package/dist/types/comment.js

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

package/dist/types/entity-stats.d.ts

@@ -0,0 +1,3 @@
+import { z } from "@hono/zod-openapi";
+import { EntityStatsSchema } from "../schemas/entity-stats";
+export type EntityStatsEntity = z.infer<typeof EntityStatsSchema>;

package/dist/types/entity-stats.js

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

package/dist/types/like.d.ts

@@ -0,0 +1,3 @@
+import { z } from "@hono/zod-openapi";
+import { LikeEntitySchema } from "../schemas/like";
+export type LikeEntity = z.infer<typeof LikeEntitySchema>;

package/dist/types/like.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.6.3",
+  "version": "1.6.5",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/constants.ts

@@ -90,18 +90,14 @@ export const INVESTOR_VERIFICATION_DOCUMENT_TYPES = {
   OTHER_CERTIFICATE: "OTHER_CERTIFICATE",
 } as const;
 
-export const LIKE_PARENT_TYPES = {
+export const ACTIVITY_PARENT_TYPES = {
   PROJECT: "PROJECT",
   POST: "POST",
 } as const;
 
-export const COMMENT_PARENT_TYPES = LIKE_PARENT_TYPES;
-
 export type Role = (typeof ROLES)[keyof typeof ROLES];
-export type LikeParentType =
-  (typeof LIKE_PARENT_TYPES)[keyof typeof LIKE_PARENT_TYPES];
-export type CommentParentType =
-  (typeof COMMENT_PARENT_TYPES)[keyof typeof COMMENT_PARENT_TYPES];
+export type ActivityParentType =
+  (typeof ACTIVITY_PARENT_TYPES)[keyof typeof ACTIVITY_PARENT_TYPES];
 export type UserStatus = (typeof USER_STATUSES)[keyof typeof USER_STATUSES];
 export type ClientType = (typeof CLIENT_TYPES)[keyof typeof CLIENT_TYPES];
 export type ExperienceLevel =

package/src/schemas/comment.ts

@@ -0,0 +1,40 @@
+import z from "zod";
+import { ACTIVITY_PARENT_TYPES } from "../constants";
+
+export const CommentEntitySchema = z.object({
+  id: z.cuid2().openapi({
+    description: "The unique CUID2 identifier for the comment.",
+    example: "tr4q2k7k0000c7625z2k8ggy",
+  }),
+  userId: z.cuid2().openapi({
+    description: "The CUID2 of the user who created the comment.",
+    example: "clq9p8f2z0000c762s7k4g1b",
+  }),
+  parentId: z.cuid2().openapi({
+    description: "The CUID2 of the parent entity (e.g., a post or project) this comment belongs to.",
+    example: "clq9p8f2z0000c762s7k4g1b",
+  }),
+  parentType: z.enum(ACTIVITY_PARENT_TYPES).openapi({
+    description: "The type of the parent entity this comment is attached to.",
+    example: "POST", // Assuming 'POST' is a value in ACTIVITY_PARENT_TYPES
+  }),
+  content: z.string().openapi({
+    description: "The text content of the comment. May contain Markdown.",
+    example: "This is a great point! I hadn't considered that perspective.",
+  }),
+
+  replyToId: z.cuid2().optional().nullable().openapi({
+    description: "The ID of the parent comment if this is a reply. Null for top-level comments.",
+    example: "tr4q2k7k0000c7625z2k8ggy", // Example of a parent comment's ID
+  }),
+  createdAt: z.coerce.date().optional().openapi({
+    description: "The date and time the comment was created.",
+    example: "2023-10-27T10:00:00.000Z",
+    format: "date-time",
+  }),
+  updatedAt: z.coerce.date().optional().openapi({
+    description: "The date and time the comment was last updated.",
+    example: "2023-10-27T10:05:00.000Z",
+    format: "date-time",
+  })
+});

package/src/schemas/entity-stats.ts

@@ -0,0 +1,43 @@
+import { z } from "@hono/zod-openapi";
+import { ACTIVITY_PARENT_TYPES } from "../constants";
+
+export const EntityStatsSchema = z
+  .object({
+    updatedAt: z.coerce.date().optional().openapi({
+      description: "Timestamp of the last update to the entity statistics.",
+      title: "Updated At",
+    }),
+    createdAt: z.coerce.date().optional().openapi({
+      description: "Timestamp of the creationn to the entity statistics.",
+      title: "Updated At",
+    }),
+    parentId: z.cuid2().openapi({
+      description:
+        "Unique identifier of the parent entity (e.g., project, post, etc.).",
+      title: "Parent ID",
+    }),
+    parentType: z.enum(ACTIVITY_PARENT_TYPES).openapi({
+      description: "Type of the parent entity this statistic belongs to.",
+      title: "Parent Type",
+    }),
+    likesCount: z.number().openapi({
+      description: "Total number of likes associated with the entity.",
+      title: "Likes Count",
+    }),
+    bookmarksCount: z.number().openapi({
+      description: "Total number of bookmarks associated with the entity.",
+      title: "Bookmarks Count",
+    }),
+    viewsCount: z.number().openapi({
+      description: "Total number of views recorded for the entity.",
+      title: "Views Count",
+    }),
+    commentsCount: z.number().openapi({
+      description: "Total number of comments linked to the entity.",
+      title: "Comments Count",
+    }),
+  })
+  .openapi({
+    description: "Represents engagement statistics for a specific entity.",
+    title: "EntityStats",
+  });

package/src/schemas/like.ts

@@ -0,0 +1,25 @@
+import { z } from "@hono/zod-openapi";
+
+export const LikeEntitySchema = z
+  .object({
+    createdAt: z.coerce.date().optional().openapi({
+      description: "Timestamp when the like was created.",
+      title: "Created At",
+    }),
+    userId: z.cuid2().openapi({
+      description: "Identifier of the user who performed the like.",
+      title: "User ID",
+    }),
+    parentId: z.cuid2().openapi({
+      description: "Identifier of the parent entity that was liked.",
+      title: "Parent ID",
+    }),
+    parentType: z.string().openapi({
+      description: "Type of the parent entity (e.g., project, post, etc.).",
+      title: "Parent Type",
+    }),
+  })
+  .openapi({
+    description: "Represents a single like event on a parent entity.",
+    title: "Like",
+  });

package/src/schemas/view.ts

@@ -0,0 +1,50 @@
+import { z } from "@hono/zod-openapi";
+import { ACTIVITY_PARENT_TYPES } from "../constants";
+
+export const ViewEntitySchema = z
+  .object({
+    id: z.cuid2().openapi({
+      description: "Unique identifier of the view record.",
+      title: "View ID",
+    }),
+    userId: z.cuid2().nullable().openapi({
+      description:
+        "Identifier of the user who viewed the entity, if authenticated.",
+      title: "User ID",
+    }),
+    ipAddress: z.string().nullable().openapi({
+      description: "IP address from which the entity was viewed.",
+      title: "IP Address",
+    }),
+    userAgent: z.string().nullable().openapi({
+      description:
+        "User agent string identifying the client device or browser.",
+      title: "User Agent",
+    }),
+    parentId: z.cuid2().openapi({
+      description: "Identifier of the parent entity being viewed.",
+      title: "Parent ID",
+    }),
+    parentType: z.enum(ACTIVITY_PARENT_TYPES).openapi({
+      description: "Type of the parent entity (e.g., project, post, etc.).",
+      title: "Parent Type",
+    }),
+    sessionId: z.string().nullable().openapi({
+      description:
+        "Session identifier associated with the view event, if available.",
+      title: "Session ID",
+    }),
+    viewedAt: z.string().datetime().openapi({
+      description: "Exact timestamp when the view occurred.",
+      title: "Viewed At",
+    }),
+    viewDate: z.string().date().openapi({
+      description:
+        "Calendar date corresponding to the view event, used for aggregation.",
+      title: "View Date",
+    }),
+  })
+  .openapi({
+    description: "Represents a record of a single view event for an entity.",
+    title: "View",
+  });

package/src/types/comment.ts

@@ -0,0 +1,4 @@
+import { z } from "@hono/zod-openapi";
+import { CommentEntitySchema } from "../schemas/comment";
+
+export type CommentEntity = z.infer<typeof CommentEntitySchema>;

package/src/types/entity-stats.ts

@@ -0,0 +1,4 @@
+import { z } from "@hono/zod-openapi";
+import { EntityStatsSchema } from "../schemas/entity-stats";
+
+export type EntityStatsEntity = z.infer<typeof EntityStatsSchema>;

package/src/types/like.ts

@@ -0,0 +1,4 @@
+import { z } from "@hono/zod-openapi";
+import { LikeEntitySchema } from "../schemas/like";
+
+export type LikeEntity = z.infer<typeof LikeEntitySchema>