@zyacreatives/shared 2.5.77 → 2.5.79

package/docs/backend-openapi-shared-contracts-handoff.md

@@ -0,0 +1,193 @@
+# Backend OpenAPI Shared Contracts Handoff
+
+Shared now exports the backend OpenAPI request/response contracts that were previously defined locally in backend route files. After publishing this package, update the backend dependency and replace the local schemas with top-level imports from `@zyacreatives/shared`.
+
+## Publish Target
+
+- Package: `@zyacreatives/shared`
+- Current source version: `2.5.79`
+- Import style: prefer `@zyacreatives/shared` over deep imports such as `@zyacreatives/shared/dist/schemas/comment`.
+
+## Highest Priority Replacements
+
+### User Purchase Library
+
+Backend sources:
+- `src/api/user/user.openapi.ts`
+- `src/api/transaction/transaction.services.ts`
+
+Shared exports:
+- `PurchaseLibraryInputSchema`
+- `PurchaseLibraryItemSchema`
+- `PurchaseLibraryOutputSchema`
+- `type PurchaseLibraryInput`
+- `type PurchaseLibraryItem`
+- `type PurchaseLibraryOutput`
+
+Backend migration notes:
+- Replace the local OpenAPI schemas in `user.openapi.ts`.
+- Remove duplicated `PurchaseLibraryItem` / purchase result service types in `transaction.services.ts` and infer/use the shared types instead.
+
+### Chat Reports And Chat List Query
+
+Backend source:
+- `src/api/chat/chat.openapi.ts`
+
+Shared exports:
+- `ReportChatInputSchema`
+- `ReportChatOutputSchema`
+- `ChatListQuerySchema`
+- `type ReportChatInput`
+- `type ReportChatOutput`
+- `type ChatListQuery`
+
+### Job Dashboard / Application Status Outputs
+
+Backend sources:
+- `src/api/job/job.openapi.ts`
+- `src/entity/job.entity.ts`
+
+Shared exports:
+- `NormalizedJobSchema`
+- `type NormalizedJob`
+- `GetCreatedJobsOutputSchema`
+- `GetApplicationStatusUpdatesCountOutputSchema`
+- `JobApplicationIdInputSchema`
+- `GetApplicationsForJobOutputSchema`
+
+Backend migration notes:
+- Use shared `NormalizedJobSchema` for OpenAPI responses.
+- `NormalizedJobSchema` remains compatible with the existing shared job entity schemas.
+- `JobApplicationIdInputSchema` uses `{ applicationId: string }` for the path param.
+
+### Comment Threads And Replies
+
+Backend sources:
+- `src/api/comment/comment.openapi.ts`
+- `src/api/project/project.openapi.ts`
+
+Shared exports:
+- `CommentThreadResponseSchema`
+- `CommentRepliesOutputSchema`
+- `CommentIdInputSchema`
+- `ProjectCommentParamsSchema`
+
+Backend migration notes:
+- Replace deep `CommentEntitySchema` imports with top-level imports from `@zyacreatives/shared`.
+
+### Payout Method Utility Inputs
+
+Backend source:
+- `src/api/payout-method/payout-method.openapi.ts`
+
+Shared exports:
+- `GetBanksInputSchema`
+- `VerifyAccountInputSchema`
+- `type GetBanksInput`
+- `type VerifyAccountInput`
+
+## Medium Priority Replacements
+
+### User Auth / Mentions / Feed Preferences
+
+Backend source:
+- `src/api/user/user.openapi.ts`
+
+Shared exports:
+- `UserAuthStatusEntitySchema`
+- `DeactivateAccountInputSchema`
+- `MentionableUsersInputSchema`
+- `MentionableUsersOutputSchema`
+- `UserWithJobBookmarksInputSchema`
+- `FeedTagsInputSchema`
+- `FeedTagsSchema`
+
+### Feed Variant Output
+
+Backend source:
+- `src/api/feed/feed.openapi.ts`
+
+Shared export:
+- `GetFeedWithCommentPolicyOutputSchema`
+
+Note:
+- If this is now the canonical feed response, consider replacing or aliasing backend usage of any older local feed output schema.
+
+### Messages Delete And Params
+
+Backend sources:
+- `src/api/message/message.openapi.ts`
+- `src/api/message/message.services.ts`
+
+Shared exports:
+- `ChatIdParamSchema`
+- `MessageParamsSchema`
+- `DeleteMessagesInputSchema`
+- `type DeleteMessagesInput`
+
+### Investor Signal / Shortlist Checks
+
+Backend sources:
+- `src/api/investor-signal/investor-signal.openapi.ts`
+- `src/api/investor-shortlist-item/investor-shortlist-item.openapi.ts`
+
+Shared exports:
+- `CheckInvestorSignalOutputSchema`
+- `CheckInvestorShortlistItemOutputSchema`
+- `InvestorSignalIdInputSchema`
+- `InvestorShortlistItemIdInputSchema`
+- `DefaultApiSuccessOutputSchema`
+
+### File Route Params And JSend URL Response
+
+Backend source:
+- `src/api/file/file.openapi.ts`
+
+Shared exports:
+- `PurchasedDownloadUrlInputSchema`
+- `PublicFileUrlInputSchema`
+- `PresignedUrlJSendOutputSchema`
+
+## Low Priority / Primitive Replacements
+
+### Entity Id Params
+
+Backend sources:
+- `src/api/product/product.openapi.ts`
+- `src/api/transaction/transaction.openapi.ts`
+- `src/api/job/job.openapi.ts`
+- inline investor module params
+
+Shared exports:
+- `ProductIdInputSchema`
+- `TransactionIdInputSchema`
+- `JobIdSchema`
+- `ApplicationIdInputSchema`
+- `IdInputSchema`
+
+### Discipline Tags Query
+
+Backend source:
+- `src/api/discipline/discipline.openapi.ts`
+
+Shared exports:
+- `GetDisciplineTagsInputSchema`
+- `GetDisciplineTagsOutputSchema`
+
+## Suggested Backend Migration Order
+
+1. Update `@zyacreatives/shared` in backend `package.json` after publishing.
+2. Replace local OpenAPI schemas listed above with top-level shared imports.
+3. Remove duplicated service-level types where shared now exports matching types.
+4. Replace deep shared imports with top-level `@zyacreatives/shared` imports.
+5. Regenerate OpenAPI output.
+6. Run backend typecheck and route/OpenAPI tests.
+
+## Verification Completed In Shared
+
+The shared package typechecks successfully with:
+
+```sh
+pnpm.cmd tsc
+```
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyacreatives/shared",
-  "version": "2.5.77",
+  "version": "2.5.79",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/schemas/chat.ts

@@ -72,9 +72,9 @@ export const CreateChatInputSchema = z.object({
 
 export type CreateChatInput = z.infer<typeof CreateChatInputSchema>;
 
-export const ChatIdInputSchema = z.object({
-  chatId: z.cuid2(),
-});
+export const ChatIdInputSchema = z.object({
+  chatId: z.cuid2(),
+});
 
 export type ChatIdInput = z.infer<typeof ChatIdInputSchema>;
 
@@ -118,17 +118,25 @@ export type GetMessageRequestsForUserOutput = z.infer<
   typeof GetMessageRequestsForUserOutputSchema
 >;
 
-export const ReportChatInputSchema = z.object({
-  complaint: z.string().trim().min(10).max(1000),
-  messageId: z.cuid2().optional(),
-});
-
-export type ReportChatInput = z.infer<typeof ReportChatInputSchema>
-
-export const ReportChatOutputSchema = z.object({
-  reported: z.boolean(),
-  chatId: z.string(),
-  messageId: z.string().nullable(),
-});
-
-export type ReportChatOutput = z.infer<typeof ReportChatOutputSchema>
+export const ReportChatInputSchema = z.object({
+  complaint: z.string().trim().min(10).max(1000),
+  messageId: z.cuid2().optional(),
+});
+
+export type ReportChatInput = z.infer<typeof ReportChatInputSchema>;
+
+export const ReportChatOutputSchema = z.object({
+  reported: z.boolean(),
+  chatId: z.string(),
+  messageId: z.string().nullable(),
+});
+
+export type ReportChatOutput = z.infer<typeof ReportChatOutputSchema>;
+
+export const ChatListQuerySchema = z.object({
+  cursor: z.string().optional(),
+  query: z.string().trim().max(100).optional(),
+  limit: z.coerce.number().int().min(1).max(100).default(20),
+});
+
+export type ChatListQuery = z.infer<typeof ChatListQuerySchema>;

package/src/schemas/comment.ts

@@ -59,11 +59,26 @@ export const CreateCommentInputSchema = z.object({
 
 export type CreateCommentInput = z.infer<typeof CreateCommentInputSchema>;
 
-export const DeleteCommentInputSchema = z.object({
-  commentId: z.cuid2(),
-});
-
-export type DeleteCommentInput = z.infer<typeof DeleteCommentInputSchema>;
+export const DeleteCommentInputSchema = z.object({
+  commentId: z.cuid2(),
+});
+
+export type DeleteCommentInput = z.infer<typeof DeleteCommentInputSchema>;
+
+export const CommentIdInputSchema = z.object({
+  commentId: z.cuid2(),
+});
+
+export type CommentIdInput = z.infer<typeof CommentIdInputSchema>;
+
+export const ProjectCommentParamsSchema = z.object({
+  projectId: z.cuid2(),
+  commentId: z.cuid2(),
+});
+
+export type ProjectCommentParams = z.infer<
+  typeof ProjectCommentParamsSchema
+>;
 
 /**
  * --------------------------------
@@ -71,6 +86,23 @@ export type DeleteCommentInput = z.infer<typeof DeleteCommentInputSchema>;
  * --------------------------------
  */
 
-export const CommentOutputSchema = CommentEntitySchema;
-
-export type CommentOutput = z.infer<typeof CommentOutputSchema>;
+export const CommentOutputSchema = CommentEntitySchema;
+
+export type CommentOutput = z.infer<typeof CommentOutputSchema>;
+
+export const CommentThreadResponseSchema = z.object({
+  comments: z.array(CommentEntitySchema),
+});
+
+export type CommentThreadResponse = z.infer<
+  typeof CommentThreadResponseSchema
+>;
+
+export const CommentRepliesOutputSchema = z.object({
+  replies: z.array(CommentEntitySchema),
+  nextCursor: z.string().nullable(),
+});
+
+export type CommentRepliesOutput = z.infer<
+  typeof CommentRepliesOutputSchema
+>;

package/src/schemas/common.ts

@@ -1,9 +1,15 @@
-import { z } from "@hono/zod-openapi";
-import { CommentEntitySchema } from "./comment";
-import { ActivitySchema } from "./activity";
-import { LINK_TYPES } from "../constants";
-
-export const CuidSchema = z.cuid2({ error: "Invalid CUID2 is written." });
+import { z } from "@hono/zod-openapi";
+import { CommentEntitySchema } from "./comment";
+import { ActivitySchema } from "./activity";
+import { LINK_TYPES } from "../constants";
+
+export const CuidSchema = z.cuid2({ error: "Invalid CUID2 is written." });
+
+export const IdInputSchema = z.object({
+  id: z.cuid2(),
+});
+
+export type IdInput = z.infer<typeof IdInputSchema>;
 
 export const UserIdentifierSchema = z.object({
   by: z.enum(["id", "username"]).optional().default("id"),
@@ -23,11 +29,12 @@ export const ProjectIdentifierSchema = z.object({
 
 export type ProjectIdentifier = z.infer<typeof ProjectIdentifierSchema>;
 
-export const DefaultApiSuccessOutputSchema = z.object({
-  status: z.literal("success"),
-});
-
-export type ApiSuccessOutput = z.infer<typeof DefaultApiSuccessOutputSchema>;
+export const DefaultApiSuccessOutputSchema = z.object({
+  status: z.literal("success"),
+});
+
+export type ApiSuccessOutput = z.infer<typeof DefaultApiSuccessOutputSchema>;
+export type DefaultApiSuccessOutput = ApiSuccessOutput;
 
 export const EntityCommentsOutputSchema = z.object({
   comments: z.array(CommentEntitySchema),

package/src/schemas/discipline.ts

@@ -85,11 +85,19 @@ export const GetDisciplinesInputSchema = z.object({
 
 export type GetDisciplinesInput = z.infer<typeof GetDisciplinesInputSchema>;
 
-export const SlugInputSchema = z.object({
-  slug: z.string().max(128),
-});
-
-export type SlugInput = z.infer<typeof SlugInputSchema>;
+export const SlugInputSchema = z.object({
+  slug: z.string().max(128),
+});
+
+export type SlugInput = z.infer<typeof SlugInputSchema>;
+
+export const GetDisciplineTagsInputSchema = z.object({
+  substring: z.string(),
+});
+
+export type GetDisciplineTagsInput = z.infer<
+  typeof GetDisciplineTagsInputSchema
+>;
 
 /**
  * --------------------------------
@@ -113,8 +121,14 @@ export type CreateDisciplinesOutput = z.infer<
   typeof CreateDisciplinesOutputSchema
 >;
 
-export const GetDisciplinesOutputSchema = z.object({
-  disciplines: z.array(DisciplineEntitySchema),
-});
-
-export type GetDisciplinesOutput = z.infer<typeof GetDisciplinesOutputSchema>;
+export const GetDisciplinesOutputSchema = z.object({
+  disciplines: z.array(DisciplineEntitySchema),
+});
+
+export type GetDisciplinesOutput = z.infer<typeof GetDisciplinesOutputSchema>;
+
+export const GetDisciplineTagsOutputSchema = z.array(z.string());
+
+export type GetDisciplineTagsOutput = z.infer<
+  typeof GetDisciplineTagsOutputSchema
+>;

package/src/schemas/feed.ts

@@ -1,4 +1,6 @@
-import { z } from "@hono/zod-openapi";
+import { z } from "@hono/zod-openapi";
+
+import { FeedPostEntitySchema } from "./post";
 
 /**
  * --------------------------------
@@ -64,11 +66,20 @@ export const FeedTagsOutputSchema = FeedTagsEntitySchema;
 
 export type FeedTagsOutput = z.infer<typeof FeedTagsOutputSchema>;
 
-export const TrendingUsersOutputSchema = z.object({
-  creators: z.array(TrendingUserSchema),
-});
-
-export type TrendingUsersOutput = z.infer<typeof TrendingUsersOutputSchema>;
+export const TrendingUsersOutputSchema = z.object({
+  creators: z.array(TrendingUserSchema),
+});
+
+export type TrendingUsersOutput = z.infer<typeof TrendingUsersOutputSchema>;
+
+export const GetFeedWithCommentPolicyOutputSchema = z.object({
+  feed: z.array(FeedPostEntitySchema),
+  nextCursor: z.string().optional(),
+});
+
+export type GetFeedWithCommentPolicyOutput = z.infer<
+  typeof GetFeedWithCommentPolicyOutputSchema
+>;
 
 export const FeedTagsInputSchema = z.object({
   tags: z.array(z.string().min(1)).default([]),
@@ -79,4 +90,4 @@ export const FeedTagsSchema = z.object({
   tags: z.array(z.string()),
 });
 
-export type FeedTagsInput = z.infer<typeof FeedTagsInputSchema>;
+export type FeedTagsInput = z.infer<typeof FeedTagsInputSchema>;

package/src/schemas/file.ts

@@ -86,13 +86,28 @@ export type GetPresignedUploadUrlInput = z.infer<
   typeof GetPresignedUploadUrlInputSchema
 >;
 
-export const GetPresignedDownloadUrlInputSchema = z.object({
-  fileId: z.cuid2(),
-});
-
-export type GetPresignedDownloadUrlInput = z.infer<
-  typeof GetPresignedDownloadUrlInputSchema
->;
+export const GetPresignedDownloadUrlInputSchema = z.object({
+  fileId: z.cuid2(),
+});
+
+export type GetPresignedDownloadUrlInput = z.infer<
+  typeof GetPresignedDownloadUrlInputSchema
+>;
+
+export const PurchasedDownloadUrlInputSchema = z.object({
+  productId: z.cuid2(),
+  fileId: z.cuid2(),
+});
+
+export type PurchasedDownloadUrlInput = z.infer<
+  typeof PurchasedDownloadUrlInputSchema
+>;
+
+export const PublicFileUrlInputSchema = z.object({
+  fileId: z.cuid2().openapi({ example: "ckq7t9yb40001q9l5z6a5c7fg" }),
+});
+
+export type PublicFileUrlInput = z.infer<typeof PublicFileUrlInputSchema>;
 
 /**
  * --------------------------------
@@ -118,9 +133,18 @@ export type GetPresignedUploadUrlOutput = z.infer<
   typeof GetPresignedUploadUrlOutputSchema
 >;
 
-export const GetPresignedDownloadUrlOutputSchema =
-  GetPresignedUploadUrlOutputSchema;
-
-export type GetPresignedDownloadUrlOutput = z.infer<
-  typeof GetPresignedDownloadUrlOutputSchema
->;
+export const GetPresignedDownloadUrlOutputSchema =
+  GetPresignedUploadUrlOutputSchema;
+
+export type GetPresignedDownloadUrlOutput = z.infer<
+  typeof GetPresignedDownloadUrlOutputSchema
+>;
+
+export const PresignedUrlJSendOutputSchema = z.object({
+  status: z.string(),
+  data: GetPresignedDownloadUrlOutputSchema,
+});
+
+export type PresignedUrlJSendOutput = z.infer<
+  typeof PresignedUrlJSendOutputSchema
+>;

package/src/schemas/investor-shortlist.ts

@@ -55,13 +55,19 @@ export type CreateInvestorShortlistInput = z.infer<
   typeof CreateInvestorShortlistInputSchema
 >;
 
-export const GetInvestorShortlistInputSchema = z.object({
-  cursor: z.string().optional(),
-});
-
-export type GetInvestorShortlistInput = z.infer<
-  typeof GetInvestorShortlistInputSchema
->;
+export const GetInvestorShortlistInputSchema = z.object({
+  cursor: z.string().optional(),
+});
+
+export type GetInvestorShortlistInput = z.infer<
+  typeof GetInvestorShortlistInputSchema
+>;
+
+export const InvestorShortlistItemIdInputSchema = z.object({ id: z.cuid2() });
+
+export type InvestorShortlistItemIdInput = z.infer<
+  typeof InvestorShortlistItemIdInputSchema
+>;
 
 /**
  * --------------------------------
@@ -69,11 +75,20 @@ export type GetInvestorShortlistInput = z.infer<
  * --------------------------------
  */
 
-export const GetInvestorShortlistOutputSchema = z.object({
-  nextCursor: z.string().optional(),
-  shortlistItems: z.array(InvestorShortlistEntitySchema),
-});
-
-export type GetInvestorShortlistOutput = z.infer<
-  typeof GetInvestorShortlistOutputSchema
->;
+export const GetInvestorShortlistOutputSchema = z.object({
+  nextCursor: z.string().optional(),
+  shortlistItems: z.array(InvestorShortlistEntitySchema),
+});
+
+export type GetInvestorShortlistOutput = z.infer<
+  typeof GetInvestorShortlistOutputSchema
+>;
+
+export const CheckInvestorShortlistItemOutputSchema = z.object({
+  exists: z.boolean(),
+  shortlistItemId: z.string().nullable(),
+});
+
+export type CheckInvestorShortlistItemOutput = z.infer<
+  typeof CheckInvestorShortlistItemOutputSchema
+>;

package/src/schemas/investor-signal.ts

@@ -67,24 +67,30 @@ export type CreateInvestorSignalInput = z.infer<
   typeof CreateInvestorSignalInputSchema
 >;
 
-export const UpdateInvestorSignalStatusInputSchema = z.object({
-  id: z.cuid2(),
-  signalStatus: z.enum(SIGNAL_STATUS),
-  version: z.int(),
-});
+export const UpdateInvestorSignalStatusInputSchema = z.object({
+  id: z.cuid2(),
+  signalStatus: z.enum(SIGNAL_STATUS),
+  version: z.int(),
+});
 
 export type UpdateInvestorSignalStatusInput = z.infer<
   typeof UpdateInvestorSignalStatusInputSchema
 >;
 
-export const GetInvestorSignalInputSchema = z.object({
-  cursor: z.string().optional(),
-  signalStatus: z.enum(SIGNAL_STATUS).optional(),
-});
-
-export type GetInvestorSignalInput = z.infer<
-  typeof GetInvestorSignalInputSchema
->;
+export const GetInvestorSignalInputSchema = z.object({
+  cursor: z.string().optional(),
+  signalStatus: z.enum(SIGNAL_STATUS).optional(),
+});
+
+export type GetInvestorSignalInput = z.infer<
+  typeof GetInvestorSignalInputSchema
+>;
+
+export const InvestorSignalIdInputSchema = z.object({ id: z.cuid2() });
+
+export type InvestorSignalIdInput = z.infer<
+  typeof InvestorSignalIdInputSchema
+>;
 
 /**
  * --------------------------------
@@ -92,11 +98,20 @@ export type GetInvestorSignalInput = z.infer<
  * --------------------------------
  */
 
-export const GetInvestorSignalOutputSchema = z.object({
-  nextCursor: z.string().optional(),
-  signals: z.array(InvestorSignalEntitySchema),
-});
-
-export type GetInvestorSignalOutput = z.infer<
-  typeof GetInvestorSignalOutputSchema
->;
+export const GetInvestorSignalOutputSchema = z.object({
+  nextCursor: z.string().optional(),
+  signals: z.array(InvestorSignalEntitySchema),
+});
+
+export type GetInvestorSignalOutput = z.infer<
+  typeof GetInvestorSignalOutputSchema
+>;
+
+export const CheckInvestorSignalOutputSchema = z.object({
+  exists: z.boolean(),
+  signalId: z.string().nullable(),
+});
+
+export type CheckInvestorSignalOutput = z.infer<
+  typeof CheckInvestorSignalOutputSchema
+>;

package/src/schemas/job-application.ts

@@ -183,11 +183,21 @@ export type TrackedJobApplicationEntity = z.infer<
  * --------------------------------
  */
 
-export const ApplicationIdInputSchema = z.object({
-  id: z.cuid2(),
-});
-
-export type ApplicationIdInput = z.infer<typeof ApplicationIdInputSchema>;
+export const ApplicationIdInputSchema = z.object({
+  id: z.cuid2(),
+});
+
+export type ApplicationIdInput = z.infer<typeof ApplicationIdInputSchema>;
+
+export const JobApplicationIdInputSchema = z.object({
+  applicationId: z
+    .string()
+    .openapi({ param: { name: "applicationId", in: "path" } }),
+});
+
+export type JobApplicationIdInput = z.infer<
+  typeof JobApplicationIdInputSchema
+>;
 
 export const CreateJobApplicationInputSchema = JobApplicationShape.extend({
   jobSections: z.array(z.enum(JOB_SECTIONS)).optional(),
@@ -248,18 +258,27 @@ export type GetTrackedJobApplicationsOutput = z.infer<
   typeof GetTrackedJobApplicationsOutputSchema
 >;
 
-export const GetApplicationStatusUpdatesCountOutputSchema = z.object({
-  unreadCount: z.number(),
-});
+export const GetApplicationStatusUpdatesCountOutputSchema = z.object({
+  unreadCount: z.number(),
+});
 
 export type GetApplicationStatusUpdatesCountOutput = z.infer<
   typeof GetApplicationStatusUpdatesCountOutputSchema
 >;
 
-export const GetBrandUnansweredApplicationsOutputSchema = z.object({
-  unansweredCount: z.number(),
-});
-
-export type GetBrandUnansweredApplicationsOutput = z.infer<
-  typeof GetBrandUnansweredApplicationsOutputSchema
->;
+export const GetBrandUnansweredApplicationsOutputSchema = z.object({
+  unansweredCount: z.number(),
+});
+
+export type GetBrandUnansweredApplicationsOutput = z.infer<
+  typeof GetBrandUnansweredApplicationsOutputSchema
+>;
+
+export const GetApplicationsForJobOutputSchema = z.object({
+  applications: z.array(MinimalJobApplicationEntitySchema),
+  nextCursor: z.string().optional(),
+});
+
+export type GetApplicationsForJobOutput = z.infer<
+  typeof GetApplicationsForJobOutputSchema
+>;