add campaign api

apps/web/prisma/migrations/20251013114734_add_api_to_campaign/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Campaign" ADD COLUMN     "isApi" BOOLEAN NOT NULL DEFAULT false;

apps/web/prisma/schema.prisma

@@ -365,6 +365,7 @@ model Campaign {
   bounced            Int            @default(0)
   hardBounced        Int            @default(0)
   complained         Int            @default(0)
+  isApi              Boolean        @default(false)
   status             CampaignStatus @default(DRAFT)
   batchSize          Int            @default(500)
   batchWindowMinutes Int            @default(0)

apps/web/src/app/(dashboard)/campaigns/[campaignId]/edit/page.tsx

@@ -97,6 +97,7 @@ function CampaignEditor({
   campaign: Campaign & { imageUploadSupported: boolean };
 }) {
   const router = useRouter();
+  const isApiCampaign = campaign.isApi;
   const contactBooksQuery = api.contacts.getContactBooks.useQuery({});
   const utils = api.useUtils();
 
@@ -124,6 +125,9 @@ function CampaignEditor({
   const getUploadUrl = api.campaign.generateImagePresignedUrl.useMutation();
 
   function updateEditorContent() {
+    if (isApiCampaign) {
+      return;
+    }
     updateCampaignMutation.mutate({
       campaignId: campaign.id,
       content: JSON.stringify(json),
@@ -175,7 +179,12 @@ function CampaignEditor({
             value={name}
             onChange={(e) => setName(e.target.value)}
             className=" border-0 focus:ring-0 focus:outline-none px-0.5 w-[300px]"
+            disabled={isApiCampaign}
+            readOnly={isApiCampaign}
             onBlur={() => {
+              if (isApiCampaign) {
+                return;
+              }
               if (name === campaign.name || !name) {
                 return;
               }
@@ -228,6 +237,9 @@ function CampaignEditor({
                     setSubject(e.target.value);
                   }}
                   onBlur={() => {
+                    if (isApiCampaign) {
+                      return;
+                    }
                     if (subject === campaign.subject || !subject) {
                       return;
                     }
@@ -245,6 +257,8 @@ function CampaignEditor({
                     );
                   }}
                   className="mt-1 py-1 text-sm block w-full outline-none border-b border-transparent  focus:border-border bg-transparent"
+                  disabled={isApiCampaign}
+                  readOnly={isApiCampaign}
                 />
                 <AccordionTrigger className="py-0"></AccordionTrigger>
               </div>
@@ -263,6 +277,9 @@ function CampaignEditor({
                     className="mt-1 py-1 w-full text-sm outline-none border-b border-transparent  focus:border-border bg-transparent"
                     placeholder="Friendly name<hello@example.com>"
                     onBlur={() => {
+                      if (isApiCampaign) {
+                        return;
+                      }
                       if (from === campaign.from || !from) {
                         return;
                       }
@@ -279,6 +296,8 @@ function CampaignEditor({
                         }
                       );
                     }}
+                    disabled={isApiCampaign}
+                    readOnly={isApiCampaign}
                   />
                 </div>
                 <div className="flex items-center gap-4">
@@ -294,6 +313,9 @@ function CampaignEditor({
                     className="mt-1 py-1 text-sm block w-full outline-none border-b border-transparent bg-transparent focus:border-border"
                     placeholder="hello@example.com"
                     onBlur={() => {
+                      if (isApiCampaign) {
+                        return;
+                      }
                       if (replyTo === campaign.replyTo[0]) {
                         return;
                       }
@@ -310,6 +332,8 @@ function CampaignEditor({
                         }
                       );
                     }}
+                    disabled={isApiCampaign}
+                    readOnly={isApiCampaign}
                   />
                 </div>
 
@@ -324,6 +348,9 @@ function CampaignEditor({
                       setPreviewText(e.target.value);
                     }}
                     onBlur={() => {
+                      if (isApiCampaign) {
+                        return;
+                      }
                       if (
                         previewText === campaign.previewText ||
                         !previewText
@@ -344,6 +371,8 @@ function CampaignEditor({
                       );
                     }}
                     className="mt-1 py-1 text-sm block w-full outline-none border-b border-transparent bg-transparent  focus:border-border"
+                    disabled={isApiCampaign}
+                    readOnly={isApiCampaign}
                   />
                 </div>
                 <div className=" flex items-center gap-2">
@@ -355,7 +384,11 @@ function CampaignEditor({
                   ) : (
                     <Select
                       value={contactBookId ?? ""}
+                      disabled={isApiCampaign}
                       onValueChange={(val) => {
+                        if (isApiCampaign) {
+                          return;
+                        }
                         // Update the campaign's contactBookId
                         updateCampaignMutation.mutate(
                           {
@@ -395,22 +428,29 @@ function CampaignEditor({
           </AccordionItem>
         </Accordion>
 
-        <div className=" rounded-lg bg-gray-50 w-[700px] mx-auto p-10">
-          <div className="w-[600px] mx-auto">
-            <Editor
-              initialContent={json}
-              onUpdate={(content) => {
-                setJson(content.getJSON());
-                setIsSaving(true);
-                deboucedUpdateCampaign();
-              }}
-              variables={["email", "firstName", "lastName"]}
-              uploadImage={
-                campaign.imageUploadSupported ? handleFileChange : undefined
-              }
-            />
+        {isApiCampaign ? (
+          <p className="text-sm text-center text-muted-foreground">
+            Email created from API. Campaign content can only be updated via
+            API.
+          </p>
+        ) : (
+          <div className=" rounded-lg bg-gray-50 w-[700px] mx-auto p-10">
+            <div className="w-[600px] mx-auto">
+              <Editor
+                initialContent={json}
+                onUpdate={(content) => {
+                  setJson(content.getJSON());
+                  setIsSaving(true);
+                  deboucedUpdateCampaign();
+                }}
+                variables={["email", "firstName", "lastName"]}
+                uploadImage={
+                  campaign.imageUploadSupported ? handleFileChange : undefined
+                }
+              />
+            </div>
           </div>
-        </div>
+        )}
       </div>
     </div>
   );

apps/web/src/server/api/routers/campaign.ts

@@ -119,12 +119,13 @@ export const campaignRouter = createTRPCRouter({
         subject: z.string().optional(),
         previewText: z.string().optional(),
         content: z.string().optional(),
+        html: z.string().optional(),
         contactBookId: z.string().optional(),
         replyTo: z.string().array().optional(),
       })
     )
     .mutation(async ({ ctx: { db, team, campaign: campaignOld }, input }) => {
-      const { campaignId, ...data } = input;
+      const { campaignId, html: htmlInput, ...data } = input;
       if (data.contactBookId) {
         const contactBook = await db.contactBook.findUnique({
           where: { id: data.contactBookId },
@@ -143,22 +144,29 @@ export const campaignRouter = createTRPCRouter({
         domainId = domain.id;
       }
 
-      let html: string | null = null;
+      let htmlToSave: string | undefined;
 
       if (data.content) {
         const jsonContent = data.content ? JSON.parse(data.content) : null;
 
         const renderer = new EmailRenderer(jsonContent);
-        html = await renderer.render();
+        htmlToSave = await renderer.render();
+      } else if (typeof htmlInput === "string") {
+        htmlToSave = htmlInput;
+      }
+
+      const campaignUpdateData: Prisma.CampaignUpdateInput = {
+        ...data,
+        domainId,
+      };
+
+      if (htmlToSave !== undefined) {
+        campaignUpdateData.html = htmlToSave;
       }
 
       const campaign = await db.campaign.update({
         where: { id: campaignId },
-        data: {
-          ...data,
-          html,
-          domainId,
-        },
+        data: campaignUpdateData,
       });
       return campaign;
     }),
@@ -240,6 +248,7 @@ export const campaignRouter = createTRPCRouter({
           from: campaign.from,
           subject: campaign.subject,
           content: campaign.content,
+          html: campaign.html,
           teamId: team.id,
           domainId: campaign.domainId,
           contactBookId: campaign.contactBookId,

apps/web/src/server/public-api/api/campaigns/create-campaign.ts

@@ -0,0 +1,82 @@
+import { createRoute, z } from "@hono/zod-openapi";
+import { PublicAPIApp } from "~/server/public-api/hono";
+import {
+  campaignCreateSchema,
+  CampaignCreateInput,
+  campaignResponseSchema,
+  parseScheduledAt,
+} from "~/server/public-api/schemas/campaign-schema";
+import {
+  createCampaignFromApi,
+  getCampaignForTeam,
+  scheduleCampaign,
+} from "~/server/service/campaign-service";
+const route = createRoute({
+  method: "post",
+  path: "/v1/campaigns",
+  request: {
+    body: {
+      required: true,
+      content: {
+        "application/json": {
+          schema: campaignCreateSchema,
+        },
+      },
+    },
+  },
+  responses: {
+    200: {
+      description: "Create a campaign",
+      content: {
+        "application/json": {
+          schema: campaignResponseSchema,
+        },
+      },
+    },
+  },
+});
+
+function createCampaign(app: PublicAPIApp) {
+  app.openapi(route, async (c) => {
+    const team = c.var.team;
+    const body: CampaignCreateInput = c.req.valid("json");
+
+    const campaign = await createCampaignFromApi({
+      teamId: team.id,
+      apiKeyId: team.apiKeyId,
+      name: body.name,
+      from: body.from,
+      subject: body.subject,
+      previewText: body.previewText,
+      content: body.content,
+      html: body.html,
+      contactBookId: body.contactBookId,
+      replyTo: body.replyTo,
+      cc: body.cc,
+      bcc: body.bcc,
+      batchSize: body.batchSize,
+    });
+
+    if (body.sendNow || body.scheduledAt) {
+      const scheduledAtInput = body.sendNow
+        ? new Date()
+        : parseScheduledAt(body.scheduledAt);
+
+      await scheduleCampaign({
+        campaignId: campaign.id,
+        teamId: team.id,
+        scheduledAt: scheduledAtInput,
+        batchSize: body.batchSize,
+      });
+    }
+
+    const latestCampaign = await getCampaignForTeam({
+      campaignId: campaign.id,
+      teamId: team.id,
+    });
+
+    return c.json(latestCampaign);
+  });
+}
+
+export default createCampaign;

apps/web/src/server/public-api/api/campaigns/get-campaign.ts

@@ -0,0 +1,49 @@
+import { createRoute, z } from "@hono/zod-openapi";
+import { PublicAPIApp } from "~/server/public-api/hono";
+import { getCampaignForTeam } from "~/server/service/campaign-service";
+import { campaignResponseSchema } from "~/server/public-api/schemas/campaign-schema";
+
+const route = createRoute({
+  method: "get",
+  path: "/v1/campaigns/{campaignId}",
+  request: {
+    params: z.object({
+      campaignId: z
+        .string()
+        .min(1)
+        .openapi({
+          param: {
+            name: "campaignId",
+            in: "path",
+          },
+          example: "cmp_123",
+        }),
+    }),
+  },
+  responses: {
+    200: {
+      description: "Get campaign details",
+      content: {
+        "application/json": {
+          schema: campaignResponseSchema,
+        },
+      },
+    },
+  },
+});
+
+function getCampaign(app: PublicAPIApp) {
+  app.openapi(route, async (c) => {
+    const team = c.var.team;
+    const campaignId = c.req.param("campaignId");
+
+    const campaign = await getCampaignForTeam({
+      campaignId,
+      teamId: team.id,
+    });
+
+    return c.json(campaign);
+  });
+}
+
+export default getCampaign;