feat: v1/campaign public api endpoint #335
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| --- | ||
| openapi: get /v1/campaigns | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,126 @@ | ||||||||
| import { createRoute, z } from "@hono/zod-openapi"; | ||||||||
| import { CampaignStatus, Prisma } from "@prisma/client"; | ||||||||
| import { PublicAPIApp } from "~/server/public-api/hono"; | ||||||||
| import { db } from "~/server/db"; | ||||||||
|
|
||||||||
| const statuses = Object.values(CampaignStatus) as [CampaignStatus]; | ||||||||
|
|
||||||||
| const route = createRoute({ | ||||||||
| method: "get", | ||||||||
| path: "/v1/campaigns", | ||||||||
| request: { | ||||||||
| query: z.object({ | ||||||||
| page: z.string().optional().openapi({ | ||||||||
| description: "Page number for pagination (default: 1)", | ||||||||
| example: "1", | ||||||||
| }), | ||||||||
| status: z.enum(statuses).optional().openapi({ | ||||||||
| description: "Filter campaigns by status", | ||||||||
| example: "DRAFT", | ||||||||
| }), | ||||||||
| search: z.string().optional().openapi({ | ||||||||
| description: "Search campaigns by name or subject", | ||||||||
| example: "newsletter", | ||||||||
| }), | ||||||||
| }), | ||||||||
| }, | ||||||||
| responses: { | ||||||||
| 200: { | ||||||||
| description: "Get list of campaigns", | ||||||||
| content: { | ||||||||
| "application/json": { | ||||||||
| schema: z.object({ | ||||||||
| campaigns: z.array( | ||||||||
| z.object({ | ||||||||
| id: z.string(), | ||||||||
| name: z.string(), | ||||||||
| from: z.string(), | ||||||||
| subject: z.string(), | ||||||||
| createdAt: z.string().datetime(), | ||||||||
| updatedAt: z.string().datetime(), | ||||||||
| status: z.string(), | ||||||||
| scheduledAt: z.string().datetime().nullable(), | ||||||||
| total: z.number().int(), | ||||||||
| sent: z.number().int(), | ||||||||
| delivered: z.number().int(), | ||||||||
| unsubscribed: z.number().int(), | ||||||||
| }) | ||||||||
| ), | ||||||||
| totalPage: z.number().int(), | ||||||||
| }), | ||||||||
| }, | ||||||||
| }, | ||||||||
| }, | ||||||||
| }, | ||||||||
| }); | ||||||||
|
|
||||||||
| function getCampaigns(app: PublicAPIApp) { | ||||||||
| app.openapi(route, async (c) => { | ||||||||
| const team = c.var.team; | ||||||||
| const pageParam = c.req.query("page"); | ||||||||
| const statusParam = c.req.query("status") as | ||||||||
| | Prisma.EnumCampaignStatusFilter<"Campaign"> | ||||||||
| | undefined; | ||||||||
| const searchParam = c.req.query("search"); | ||||||||
|
|
||||||||
| const page = pageParam ? Number(pageParam) : 1; | ||||||||
|
Contributor
There was a problem hiding this comment. P1: Missing validation for the Prompt for AI agents
Suggested change
|
||||||||
| const limit = 30; | ||||||||
| const offset = (page - 1) * limit; | ||||||||
|
|
||||||||
| const whereConditions: Prisma.CampaignWhereInput = { | ||||||||
| teamId: team.id, | ||||||||
| }; | ||||||||
|
|
||||||||
| if (statusParam) { | ||||||||
| whereConditions.status = statusParam; | ||||||||
| } | ||||||||
|
|
||||||||
| if (searchParam) { | ||||||||
| whereConditions.OR = [ | ||||||||
| { | ||||||||
| name: { | ||||||||
| contains: searchParam, | ||||||||
| mode: "insensitive", | ||||||||
| }, | ||||||||
| }, | ||||||||
| { | ||||||||
| subject: { | ||||||||
| contains: searchParam, | ||||||||
| mode: "insensitive", | ||||||||
| }, | ||||||||
| }, | ||||||||
| ]; | ||||||||
| } | ||||||||
|
|
||||||||
| const countP = db.campaign.count({ where: whereConditions }); | ||||||||
|
|
||||||||
| const campaignsP = db.campaign.findMany({ | ||||||||
| where: whereConditions, | ||||||||
| select: { | ||||||||
| id: true, | ||||||||
| name: true, | ||||||||
| from: true, | ||||||||
| subject: true, | ||||||||
| createdAt: true, | ||||||||
| updatedAt: true, | ||||||||
| status: true, | ||||||||
| scheduledAt: true, | ||||||||
| total: true, | ||||||||
| sent: true, | ||||||||
| delivered: true, | ||||||||
| unsubscribed: true, | ||||||||
| }, | ||||||||
| orderBy: { | ||||||||
| createdAt: "desc", | ||||||||
| }, | ||||||||
| skip: offset, | ||||||||
| take: limit, | ||||||||
| }); | ||||||||
|
|
||||||||
| const [campaigns, count] = await Promise.all([campaignsP, countP]); | ||||||||
|
|
||||||||
| return c.json({ campaigns, totalPage: Math.ceil(count / limit) }); | ||||||||
| }); | ||||||||
| } | ||||||||
|
|
||||||||
| export default getCampaigns; | ||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix the type assertion for enum values.
The type assertion
as [CampaignStatus]creates a tuple with a single element, butz.enum()requires a tuple type of[string, ...string[]](at least one element with rest). This could cause TypeScript errors.🔎 Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents