feat: export contact

Author: viethungpv91

apps/builder/messages/en.json

@@ -1883,7 +1883,16 @@
     "description": "Generate a token to allow your workspace to access ChatbotX APIs. Keep this token secret and do not share it with anyone."
   },
   "contacts": {
-    "title": "Contacts"
+    "title": "Contacts",
+    "exportPreparing": "Preparing your export…",
+    "exportPreparingDescription": "We're generating your CSV file. This may take a moment.",
+    "exportReadyTitle": "Your export is ready",
+    "exportReadyDescription": "Copy the link below or download the file directly.",
+    "exportDownloadCount": "Download ({count})",
+    "exportFailed": "Export failed. Please try again.",
+    "copyLink": "Copy link",
+    "linkCopied": "Link copied to clipboard",
+    "exportAllNotice": "All contacts matching the current filter will be exported."
   },
   "auditLogs": {
     "title": "Audit Logs"

apps/builder/src/app/space/[workspaceId]/contacts/page.tsx

@@ -40,7 +40,14 @@ export default async function ContactsPage(props: {
           <TagStoreProvider workspaceId={workspaceId}>
             <CustomFieldStoreProvider workspaceId={workspaceId}>
               <InboxStoreProvider workspaceId={workspaceId}>
-                <ContactsTable promises={promises} workspaceId={workspaceId} />
+                <ContactsTable
+                  filter={{
+                    keyword: search?.keyword,
+                    contactFilter: search?.contactFilter,
+                  }}
+                  promises={promises}
+                  workspaceId={workspaceId}
+                />
               </InboxStoreProvider>
             </CustomFieldStoreProvider>
           </TagStoreProvider>

apps/builder/src/features/contacts/actions/export-contacts.action.ts

@@ -1,20 +1,24 @@
 "use server"
 
-import { and, db, eq, inArray } from "@chatbotx.io/database/client"
-import { contactModel } from "@chatbotx.io/database/schema"
+import { db } from "@chatbotx.io/database/client"
+import { fileContextTypes, fileStatuses } from "@chatbotx.io/database/partials"
+import { fileModel } from "@chatbotx.io/database/schema"
 import type { UserModel } from "@chatbotx.io/database/types"
+import { createId } from "@chatbotx.io/utils"
 import { DefaultJobAction, defaultQueue } from "@chatbotx.io/worker-config"
-import { returnValidationErrors } from "next-safe-action"
 import {
   type WorkspaceIdRequestParams,
   workspaceIdrequestParams,
 } from "@/features/common/schemas"
 import { workspaceActionClient } from "@/lib/safe-action"
 import {
   type ExportContactsRequest,
+  type ExportContactsResponse,
   exportContactsRequest,
 } from "../schemas/action"
 
+const exportFileSubType = "export-contacts"
+
 export const exportContactsAction = workspaceActionClient
   .bindArgsSchemas(workspaceIdrequestParams)
   .inputSchema(exportContactsRequest)
@@ -27,36 +31,48 @@ export const exportContactsAction = workspaceActionClient
       ctx: { user: UserModel }
       bindArgsParsedInputs: WorkspaceIdRequestParams
       parsedInput: ExportContactsRequest
-    }) => {
-      const { contactIds, fields } = parsedInput
+    }): Promise<ExportContactsResponse> => {
+      const { fields } = parsedInput
 
-      // Make sure the contacts exist
-      const contactsCount = await db.$count(
-        contactModel,
-        and(
-          eq(contactModel.workspaceId, workspaceId),
-          inArray(contactModel.id, contactIds),
-        ),
-      )
-      if (contactsCount === 0) {
-        return returnValidationErrors(exportContactsRequest, {
-          _errors: ["Validation Exception"],
-          fields: {
-            _errors: ["No contacts found"],
-          },
-        })
-      }
+      // The worker resolves the filter and counts records. The action only
+      // records the export request and enqueues the job.
+      const filter = parsedInput.exportAll
+        ? {
+            keyword: parsedInput.filter?.keyword,
+            contactFilter: parsedInput.filter?.contactFilter,
+          }
+        : undefined
+      const contactIds = parsedInput.exportAll
+        ? undefined
+        : (parsedInput.contactIds ?? [])
+
+      const fileId = createId()
+      const fileName = `contacts-${new Date().toISOString().slice(0, 10)}.csv`
+      const outputPath = `workspaces/${workspaceId}/exports/contacts/${fileId}.csv`
+
+      await db.insert(fileModel).values({
+        id: fileId,
+        workspaceId,
+        userId: user.id,
+        contextType: fileContextTypes.enum.generic,
+        subType: exportFileSubType,
+        path: outputPath,
+        fileName,
+        mimeType: "text/csv",
+        status: fileStatuses.enum.pending,
+      })
 
       await Promise.all([
         defaultQueue.add(DefaultJobAction.exportContacts, {
           type: DefaultJobAction.exportContacts,
           data: {
             workspaceId,
             requestedUserId: user.id,
-            contactIds,
+            fileId,
             fields,
-            outputPath: `/tmp/contacts-list-${Date.now()}.csv`,
+            outputPath,
             outputFormat: "csv",
+            ...(filter ? { filter } : { contactIds: contactIds ?? [] }),
           },
         }),
         defaultQueue.add(DefaultJobAction.sendAuditLog, {
@@ -69,5 +85,7 @@ export const exportContactsAction = workspaceActionClient
           },
         }),
       ])
+
+      return { fileId }
     },
   )

apps/builder/src/features/contacts/api/authenticated.ts

@@ -8,11 +8,17 @@ import { createContact } from "../actions/create-contact.action"
 import { deleteContactCustomFields } from "../actions/delete-contact-custom-field.action"
 import { removeContactTags } from "../actions/remove-contact-tag.action"
 import { getContact } from "../queries/get-contact.query"
+import { getExportFile } from "../queries/get-export-file.query"
 import { listContactCustomFields } from "../queries/list-contact-fields.query"
 import { countContactInboxes } from "../queries/list-contact-inboxes.queries"
 import { listContactTags } from "../queries/list-contact-tags.query"
 import { countContacts, listContacts } from "../queries/list-contacts.queries"
-import { createContactRequest, createContactResponse } from "../schemas/action"
+import {
+  createContactRequest,
+  createContactResponse,
+  getExportFileRequest,
+  getExportFileResponse,
+} from "../schemas/action"
 import {
   deleteContactCustomFieldRequest,
   listContactCustomFieldsRequest,
@@ -102,6 +108,18 @@ export const contactsAuthenticatedAPI = {
       return await createContact({ workspaceId, parsedInput })
     }),
 
+  getExportFileAuthenticatedAPI: authorizedAPI
+    .route({
+      method: "GET",
+      path: "/workspaces/{workspaceId}/contacts/export-files/{fileId}",
+      summary: "Get contact export file status",
+      tags: ["Contacts"],
+    })
+    .input(getExportFileRequest)
+    .output(getExportFileResponse)
+    .use(workspaceAuthorizedMidddleware, (input) => input.workspaceId)
+    .handler(async ({ input }) => await getExportFile(input)),
+
   listContactTagsAuthenticatedAPI: authorizedAPI
     .route({
       method: "GET",

apps/builder/src/features/contacts/contacts-list-action.tsx

@@ -42,21 +42,25 @@ import DeleteContactDialog from "./components/remove-contact-dialog"
 import RemoveContactSequenceDialog from "./components/remove-contact-sequence-dialog"
 import RemoveContactTagDialog from "./components/remove-contact-tag-dialog"
 import { ExportContactDialog } from "./export-contact-dialog"
+import type { ExportContactsFilter } from "./schemas/action"
 import type { ListContactsItem } from "./schemas/query"
 
 type ContactListActionProps = {
   workspaceId: string
   table: Table<ListContactsItem>
+  filter?: ExportContactsFilter
 }
 
 export function ContactListAction({
   workspaceId,
   table,
+  filter,
 }: ContactListActionProps) {
   const t = useTranslations()
   const router = useRouter()
 
   const rows = table.getFilteredSelectedRowModel().rows
+  const exportAll = table.getIsAllPageRowsSelected()
 
   return (
     <DropdownMenu>
@@ -139,6 +143,8 @@ export function ContactListAction({
 
         <ExportContactDialog
           contactIds={rows.map((r) => r.original.id)}
+          exportAll={exportAll}
+          filter={filter}
           trigger={
             <DropdownMenuItem
               disabled={rows.length === 0}

apps/builder/src/features/contacts/contacts-table.tsx

@@ -21,15 +21,21 @@ import { getUserName } from "../users/schemas/resource"
 import { ContactListAction } from "./contacts-list-action"
 import { CreateContactDialog } from "./create-contact-dialog"
 import type { listContacts } from "./queries/list-contacts.queries"
+import type { ExportContactsFilter } from "./schemas/action"
 import type { ListContactsItem } from "./schemas/query"
 import type { ContactResource } from "./schemas/resource"
 
 type ContactsTableProps = {
   workspaceId: string
   promises: Promise<[Awaited<ReturnType<typeof listContacts>>]>
+  filter?: ExportContactsFilter
 }
 
-export function ContactsTable({ workspaceId, promises }: ContactsTableProps) {
+export function ContactsTable({
+  workspaceId,
+  promises,
+  filter,
+}: ContactsTableProps) {
   const t = useTranslations()
   const [{ data, pageCount }] = use(promises)
 
@@ -216,7 +222,11 @@ export function ContactsTable({ workspaceId, promises }: ContactsTableProps) {
     <DataTable table={table}>
       <DataTableToolbar table={table}>
         <CreateContactDialog workspaceId={workspaceId} />
-        <ContactListAction table={table} workspaceId={workspaceId} />
+        <ContactListAction
+          filter={filter}
+          table={table}
+          workspaceId={workspaceId}
+        />
       </DataTableToolbar>
     </DataTable>
   )